Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: normalize api documentation #1066

Merged
merged 1 commit into from
Aug 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/components/alert/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### IxAlert

#### Props
#### AlertProps

| 名称 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
Expand Down
678 changes: 678 additions & 0 deletions packages/components/api.extra.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions packages/components/back-top/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### IxBackTop

#### Props
#### BackTopProps

| 参数 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| -- | -- | -- | -- | -- | -- |
Expand All @@ -11,7 +11,7 @@
| `visibilityHeight` | 滚动高度达到此参数值才出现 | `number` | `400` | ✅ | - |
| `onClick` | 点击回调事件 | `(evt: MouseEvent) => void` | - | - | - |

#### Slots
#### BackTopSlots

| 名称 | 说明 | 参数类型 | 备注 |
| -- | -- | -- | -- |
Expand Down
4 changes: 2 additions & 2 deletions packages/components/badge/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### IxBadge

#### Props
#### BadgeProps

| 名称 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
Expand All @@ -12,7 +12,7 @@
| `showZero`| 数值为 0 时是否显示 | `boolean` | `false` | ✅ | - |
| `color` | 徽标的颜色 | `string` | - | - | 数值徽标和圆点徽标为设置背景色,组件徽标为字体颜色 |

### Slots
#### BadgeSlots

| 名称 | 说明 | 参数类型 | 备注 |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion packages/components/checkbox/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

### IxCheckboxGroup

#### GroupProps
#### CheckboxGroupProps

| 名称 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
Expand Down
2 changes: 2 additions & 0 deletions packages/components/collapse/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

### IxCollapsePanel

#### CollapsePanelProps

| 名称 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
| `key` | 唯一标识符 | `string \| number` | `uid` | - | - |
Expand Down
12 changes: 6 additions & 6 deletions packages/components/list/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@

| 名称 | 说明 | 参数类型 | 备注 |
| --- | --- | --- | --- |
| header | 列表头部 | - | - |
| footer | 列表底部 | - | - |
| empty | 空状态 | - | - |
| `header` | 列表头部 | - | - |
| `footer` | 列表底部 | - | - |
| `empty` | 空状态 | - | - |

### IxListItem

Expand All @@ -43,6 +43,6 @@

| 名称 | 说明 | 参数类型 | 备注 |
| --- | --- | --- | --- |
| title | 列表项标题 | - | - |
| content | 列表项内容 | - | - |
| extra | 列表项额外项 | - | - |
| `title` | 列表项标题 | - | - |
| `content` | 列表项内容 | - | - |
| `extra` | 列表项额外项 | - | - |
2 changes: 2 additions & 0 deletions packages/components/rate/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

### IxRate

#### RateProps

| 名称 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
| `v-model:value` | 高亮的数目(分数) | `number` | - | - | 使用 `control` 时,此配置无效 |
Expand Down
2 changes: 2 additions & 0 deletions packages/components/select/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ export type SelectSearchFn = (data: SelectData, searchValue: string) => boolean

### IxSelectPanel

#### SelectPanelProps

| 名称 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
| `activeValue` | 当前处于激活状态的Key | `VKey` | - | 用于配合搜索和键盘操作 |
Expand Down
2 changes: 1 addition & 1 deletion packages/components/skeleton/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@

| 名称 | 说明 | 参数类型 | 备注 |
| --- | --- | --- | --- |
| default | 展示加载结束后的UI | - | - |
| `default` | 展示加载结束后的UI | - | - |
2 changes: 1 addition & 1 deletion packages/components/statistic/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| `title` | 数值的标题 | string \| v-slot | - |||
| `value` | 数值内容 | string \| number | - |||

### StatisticSlots
#### StatisticSlots

| 名称 | 说明 | 参数类型 | 备注 |
| --- | --- | --- | --- |
Expand Down
1 change: 1 addition & 0 deletions packages/components/table/demo/ColSpanRowSpan.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<template>
<IxTable :columns="columns" :dataSource="data" :borderless="false">
<IxTableColumn> </IxTableColumn>
<template #name="{ value }">
<a>{{ value }}</a>
</template>
Expand Down
2 changes: 1 addition & 1 deletion packages/components/time-picker/docs/Api.zh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## API

### ix-time-picker
### IxTimePicker

#### TimePickerProps

Expand Down
2 changes: 1 addition & 1 deletion packages/components/upload/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
| `onRemove` | 点击移除文件时的回调,返回boolean表示是否允许移除,支持Promise | `(file: UploadFile) => boolean \| Promise<boolean>` | `() => true` | - | - |
| `onRetry` | 点击重新上传时的回调 | `(file: UploadFile) => void` | - | - | - |

#### IxUploadSlots
#### UploadSlots

| 名称 | 说明 | 参数类型 | 备注 |
| ---------- | ------------------------ | ---------------------------------------- | ---- |
Expand Down
7 changes: 7 additions & 0 deletions packages/pro/api.extra.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$extends": {
"Form": { "ProForm": ["props"] },
"Menu": { "ProLayout": ["slots"] },
"Table": { "ProTable": ["props", "slots"] }
}
}
2 changes: 1 addition & 1 deletion packages/pro/form/docs/Index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ category: pro
type: 数据录入
order: 0
title: ProForm
subtitle:
subtitle: 高级表单
---

8 changes: 4 additions & 4 deletions packages/pro/layout/docs/Api.en.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
## API

### IxLayoutPro
### IxProLayout

#### LayoutProProps
#### ProLayoutProps

| Name | Description | Type | Default | Global Config | Remark |
| --- | --- | --- | --- | --- | --- |
| - | - | - | - | ✅ | - |

#### LayoutProSlots
#### ProLayoutSlots

| Name | Description | Parameter Type | Remark |
| --- | --- | --- | --- |
| - | - | - | - |

#### LayoutProMethods
#### ProLayoutMethods

| Name | Description | Parameter Type | Remark |
| --- | --- | --- | --- |
Expand Down
4 changes: 2 additions & 2 deletions packages/pro/layout/docs/Api.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### IxProLayout

### ProLayoutProps
#### ProLayoutProps

| 名称 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
Expand All @@ -19,7 +19,7 @@
| `type` | 布局类型 | `'header' \| 'sider' \| 'both' \| 'mixin'` | `mixin` | - | 参见示例:[布局类型](#pro-layout-demo-Type) |
| `onMenuClick` | 点击菜单回调 | `(options: MenuClickOptions) => void`| - | - | - |

### ProLayoutSlots
#### ProLayoutSlots

| 名称 | 说明 | 参数类型 | 备注 |
| --- | --- | --- | --- |
Expand Down