Skip to content

Commit 6b55c9d

Browse files
authored
docs: update docs for devuihelper VSCode Extension (#43)
* docs: update docs for devuihelper VSCode Extension 修改了一些api文档,使之更加规范。同时,也使得插件能够工作的更好。
1 parent 86b4be4 commit 6b55c9d

File tree

18 files changed

+58
-36
lines changed

18 files changed

+58
-36
lines changed

devui/accordion/doc/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
| loadingTemplate | `TemplateRef<any>` | 内置 | 可选,加载中使用自定义模板,可用变量值见下 |
1919
| innerListTemplate | `TemplateRef<any`> | 内置 | 可选,子列表内容完全自定义,用做折叠面板,可用变量值见下 |
2020
| linkType | `'routerLink'\|'hrefLink'\|'dependOnLinkTypeKey'\|''` | '' | 可选,`'routerLink'`为路由场景;`'hrefLink'`为外部链接场景;`'dependOnLinkTypeKey'`为动态路由或外部链接场景;`''`为默认非链接类型(无法右键打开新标签页)|
21-
| linkTypeKey | `string` | 'linkType' | 可选,链接内容的类型的key值,用于linkType为`'dependOnLinkTypeKey'`时指定对象链接类型属性名,item[linkTypeKey]类型为`'routerLink'|'hrefLink'\| string`,其中`'routerLink'`为路由链接,`'hrefLink'`为外部链接,其他为默认非链接类型|
21+
| linkTypeKey | `string` | 'linkType' | 可选,链接内容的类型的key值,用于linkType为`'dependOnLinkTypeKey'`时指定对象链接类型属性名,item[linkTypeKey]类型为`'routerLink'\|'hrefLink'\| string`,其中`'routerLink'`为路由链接,`'hrefLink'`为外部链接,其他为默认非链接类型|
2222
| linkKey | `string` | 'link' | 可选,链接内容的key,用于linkType为连接类型记非`''`时,链接的取值的属性值,item[linkKey]为路由地址或者超链接地址|
2323
| linkTargetKey | `string` | 'target' | 可选,链接目标窗口的key,用于链接类型,item[linkTargetKey]为单个链接的目标窗口 |
2424
| linkDefaultTarget | `string` | '_self' | 可选,不设置target的时候target默认值,用于链接类型 |
25-
| autoOpenActiveMenu | `boolean` | false | 可选,是否自动展开带有活跃子项的菜单
25+
| autoOpenActiveMenu | `boolean` | false | 可选,是否自动展开带有活跃子项的菜单 |
2626

2727
### d-accordion 事件
2828

devui/alert/doc/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1+
12
### d-alert参数
23

34
| 参数 | 类型 | 默认 | 说明 |
45
| :---------: | :----------: | :---------: | :------------------------------------------|
5-
| type | `'success'\|'danger'\|'warning'\|'info'`| 'info' | 必选,指定警告提示的样式
6+
| type | `'success'\|'danger'\|'warning'\|'info'`| 'info' | 必选,指定警告提示的样式|
67
| cssClass | `string ` | -- | 可选,自定义class名 |
78
| closeable | `boolean` | true | 可选,默认显示关闭按钮 |
89
| dismissTime | `number` | -- | 可选,自动关闭alert的延迟时间(单位:ms) |
9-
| showIcon | `boolean` | true | 可选,是否使用默认的类型图标 |
10+
| showIcon | `boolean` | true | 可选,是否使用默认的类型图标 |
1011

1112
### d-alert 事件
1213

devui/anchor/doc/api.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# Anchor使用说明
23

34
需要三个指令配合使用: 'dAnchor'、'dAnchorLink'、'dAnchorBox'
@@ -33,17 +34,19 @@
3334
| dAnchorLink | `string` | -- | 必选,点击滑动的目标锚点的名字 |
3435
| anchorActive | `string` | -- | 可选,锚点处于激活状态的时候,链接生效对应的css类名 |
3536

36-
## dAnchorBox指令 (必须有一个容器,否则功能无法使用)
37+
## dAnchorBox指令
38+
#### (必须有一个容器,否则功能无法使用)
3739

38-
定义一个扫描锚点的容器,放在dAnchor与dAnchorLink的公共父节点上,用于锚点和链接之间的通信
40+
定义一个扫描锚点的容器,放在dAnchor与dAnchorLink的公共父节点上,用于锚点和链接之间的通信
3941

4042
| 参数 | 类型 | 默认 | 说明 |
4143
| :-------------------: | :--------------------------: | :-------------: | :--------------------------------------------------: |
4244
| view | `{top?:number,bottom?:number}` | {top:0,bottom:0} | 可选,用于可视区域的调整,比如顶部有固定位置的头部等,数值对应被遮挡的顶部或底部的高度 |
4345
| defaultAnchor | `string` | -- | 可选,进入页面后默认被激活的锚点链接,一般设置为第一个锚点,如果不设置,那么第一个锚点需要在滑动到顶部位置的时候才能激活链接 |
4446
| scrollTarget | `HTMLElement` | document.documentElement(document.body) | 可选,设置要发生滚动的容器,一般为滚动条所在容器,为主页面的滚动条时候可以不设置 |
4547

46-
## dAnchorHashSupport指令 (dAnchorBox辅助指令)
48+
## dAnchorHashSupport指令
49+
### (dAnchorBox辅助指令)
4750

4851
| 参数 | 类型 | 默认 | 说明 |
4952
| :--------------------------: | :-----------: | :-------------: | :-------------------------------------------------------------------------: |
@@ -52,6 +55,7 @@
5255

5356
dAnchorHashSupport指令搭配dAnchorBox使用, 可以绑定路由的hash fragment, 举例 xxx.xxx/xxx#foo, foo字段为哈希字段。
5457
跳转哈希字段可以使用anchor组件,路由navigate,routerLink的fragment字段等。
58+
跳转哈希字段可以使用anchor组件,路由navigate,routerLink的fragment字段等。
5559

5660
### 跳转到anchor的方法
5761

devui/auto-complete/doc/api.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11

2+
### d-auto-complete 参数
23
| 参数 | 类型 | 默认 | 说明 |
34
| :---------: | :----------: | :---------: | :------------------------------------------|
45
| allowEmptyValueSearch | `boolean` | false | 可选,在绑定的输入框value为空时,是否进行搜索提示操作 |
@@ -24,9 +25,9 @@
2425

2526
### d-auto-complete 事件
2627

27-
| 参数 | 类型 | 默认 | 说明 |
28-
| :---------: | :----------: | :---------: | :------------------------------------------|
29-
| loadMore | `EventEmitter<any>` | -- | 可选,懒加载触发事件,配合enableLazyLoad使用,使用\`$event.loadFinish()\`关闭loading状态,$event为弹窗组件AutoCompletePopupComponent的实例 |
28+
| 参数 | 类型 | 说明 |
29+
| :---------: | :----------: | :------------------------------------------|
30+
| loadMore | `EventEmitter<any>` | 可选,懒加载触发事件,配合enableLazyLoad使用,使用\`$event.loadFinish()\`关闭loading状态,$event为弹窗组件AutoCompletePopupComponent的实例 |
3031

3132
#### searchFn默认值
3233

devui/button/doc/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
| 参数 | 类型 | 默认 | 说明 |
44
| :---------: | :----------: | :---------: | :------------------------------------------|
55
| id | `string` | -- | 可选,button id |
6-
| type | `IButtonType` | button | 可选,类型 'button'\|'submit'\|'reset' |
7-
| bsStyle | `IButtonStyle` | primary | 可选,风格 'primary' \| 'common' \| 'text' \| 'text-dark'|
8-
| bsSize | `IButtonSize` | 'md' | 可选,大小 'lg' \| 'md' \| 'sm' \| 'xs' |
6+
| type | `button`\|`submit`\|`reset` | button | 可选,按钮类型 |
7+
| bsStyle | `primary` \| `common` \| `text` \| `text-dark` | primary | 可选,按钮风格 |
8+
| bsSize | `lg` \| `md` \| `sm` \| `xs` | md | 可选,按钮大小 |
99
| bordered | `boolean` | false | 可选,是否有边框 |
1010
| icon | `string` | -- | 可选, 自定义按钮图标 |
1111
| showLoading | `boolean` | false | 可选,是否显示加载提示 |

devui/dragdrop/doc/api.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Drag DOM Events 详情: [DragEvent](https://developer.mozilla.org/en-US/docs/Web
9090

9191
``` typescript
9292
type DropEvent = {
93-
nativeEvent: any; // 原生的drop事件
93+
nativeEvent: any; // 原生的drop事件,
9494
dragData: any; // drag元素的dragData数据
9595
dropSubject: Subject<any>; //drop事件的Subject
9696
dropIndex?: number; // drop的位置在列表的index
@@ -115,13 +115,13 @@ type DropEvent = {
115115
116116
| 名字 | 类型 | 默认值 |描述 |
117117
|:-------|:------------|:-----------|:-----------|
118-
| direction| `DropScrollSpeed``'v'|'h'` | 'v' | 滚动方向,垂直滚动`'v'`, 水平滚动 `'h'`|
118+
| direction| `DropScrollSpeed``'v'\|'h'` | 'v' | 滚动方向,垂直滚动`'v'`, 水平滚动 `'h'`|
119119
| responseEdgeWidth | `string \| ((total: number) => string)` | '100px' | 响应自动滚动边缘宽度, 函数的情况传入的为列表容器同个方向相对宽度 |
120120
| speedFn | `DropScrollSpeedFunction` | 内置函数 | 速率函数,见备注 |
121121
| minSpeed | `DropScrollSpeed``number` | 50 | 响应最小速度 ,函数计算小于这个速度的时候,以最小速度为准 |
122122
| maxSpeed | `DropScrollSpeed``number` | 1000 | 响应最大速度 ,函数计算大于这个速度的时候,以最大速度为准 |
123123
| viewOffset | {forward?: `DropScrollAreaOffset`; backward?: `DropScrollAreaOffset`;} | -- | 设置拖拽区域的偏移,用于某些位置修正|
124-
| dropScrollScope| `string| Array<string>`| --| 允许触发滚动scope,不配置为默认接收所有scope,配置情况下,draggable`dragScope``dropScrollScope`匹配得上才能触发滚动|
124+
| dropScrollScope| `string\| Array<string>`| --| 允许触发滚动scope,不配置为默认接收所有scope,配置情况下,draggable`dragScope``dropScrollScope`匹配得上才能触发滚动|
125125
| backSpaceDroppable| `boolean`|true| 是否允许在滚动面板上同时触发放置到滚动面板的下边的具体可以放置元素,默认为true,设置为false则不能边滚动边放置|
126126

127127
备注: speedFn默认函数为`(x: number) => Math.ceil((1 - x) * 18) * 100`,传入数字`x`是 鼠标位置距离边缘的距离占全响应宽度的百分比,
@@ -160,6 +160,17 @@ export type DropScrollTriggerEdge = 'left' | 'right' | 'top' | 'bottom';
160160

161161
如果需要同时两个方向都有滚动条,则需要使用dDropScrollEnhanced的同时使用dDropScrollEnhancedSide,参数列表同dDropScrollEnhanced指令,唯一不同是direction,如果为`'v'`side附属指令的实际方向为`'h'`
162162

163+
| 名字 | 类型 | 默认值 |描述 |
164+
|:-------|:------------|:-----------|:-----------|
165+
| direction| `DropScrollSpeed``'v'\|'h'` | 'v' | 滚动方向,垂直滚动`'v'`, 水平滚动 `'h'`|
166+
| responseEdgeWidth | `string \| ((total: number) => string)` | '100px' | 响应自动滚动边缘宽度, 函数的情况传入的为列表容器同个方向相对宽度 |
167+
| speedFn | `DropScrollSpeedFunction` | 内置函数 | 速率函数,见备注 |
168+
| minSpeed | `DropScrollSpeed``number` | 50 | 响应最小速度 ,函数计算小于这个速度的时候,以最小速度为准 |
169+
| maxSpeed | `DropScrollSpeed``number` | 1000 | 响应最大速度 ,函数计算大于这个速度的时候,以最大速度为准 |
170+
| viewOffset | {forward?: `DropScrollAreaOffset`; backward?: `DropScrollAreaOffset`;} | -- | 设置拖拽区域的偏移,用于某些位置修正|
171+
| dropScrollScope| `string\| Array<string>`| --| 允许触发滚动scope,不配置为默认接收所有scope,配置情况下,draggable`dragScope``dropScrollScope`匹配得上才能触发滚动|
172+
| backSpaceDroppable| `boolean`|true| 是否允许在滚动面板上同时触发放置到滚动面板的下边的具体可以放置元素,默认为true,设置为false则不能边滚动边放置|
173+
163174
## 使用 `dDraggable` & `dDroppable` 指令
164175

165176
```html

devui/form/doc/api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,7 @@
1212
| required | `boolean` | false | 可选,表单选项是否必填 |
1313
| hasHelp | `boolean` | false | 可选,表单项是否需要帮助指引 |
1414
| helpTips | `string` | '' | 可选,表单项帮助指引提示内容,需配合 `hasHelp`使用 |
15+
16+
## d-form-control参数
17+
18+
## d-form-item参数

devui/image-preview/doc/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
`import {ImagePreviewModule} from 'ng-devui/image-preview'`;
1010

1111

12-
### 使用dImagePreview指令
12+
### dImagePreview指令
1313

1414
Image容器元素上使用`dImagePreview`指令
1515

16-
### dImagePreview 参数
16+
### dImagePreview 参数
1717

1818
| 参数 | 类型 | 默认 | 说明 |
1919
| :---------------: | :-------------------------: | :---------: | :--------------------------------: |

devui/loading/doc/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### [dLoading] 参数
1+
### dLoading 参数
22

33
| 参数 | 类型 | 默认 | 说明 |
44
| :---------: | :-----------------------------: | :---------: | :------------------------------------------|

devui/panel/doc/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
| 参数 | 类型 | 默认 | 说明 |
44
| :---------: | :----------: | :---------: | :------------------------------------------|
5-
| type | `string` | 'default' | 可选,面板的类型 |
5+
| type | 'default'\|'primary'\| 'success' \| 'danger' \| 'warning' \| 'info' | 'default' | 可选,面板的类型 |
66
| heading | `string` | -- | 可选,面板的头部标题 |
77
| cssClass | `string` | -- | 可选,自定义class名 |
88
| isCollapsed | `boolean` | false | 可选,是否展开 |

0 commit comments

Comments
 (0)