diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 31beea8f3..8e13cb5a2 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -172,7 +172,7 @@ export default { | Attribute | Description | Type | Default | | --- | --- | --- | --- | | v-model:show | Whether to show ActionSheet | _boolean_ | `false` | -| actions | Options | _Action[]_ | `[]` | +| actions | Options | _ActionSheetAction[]_ | `[]` | | title | Title | _string_ | - | | cancel-text | Text of cancel button | _string_ | - | | description | Description above the options | _string_ | - | @@ -192,7 +192,7 @@ export default { | teleport | Specifies a target element where ActionSheet will be mounted | _string \| Element_ | - | | before-close `v3.1.4` | Callback function before close | _(action: string) => boolean \| Promise\_ | - | -### Data Structure of Action +### Data Structure of ActionSheetAction | Key | Description | Type | | --------- | ------------------------------- | --------------------------- | @@ -202,13 +202,13 @@ export default { | className | className for the option | _string \| Array \| object_ | | loading | Whether to be loading status | _boolean_ | | disabled | Whether to be disabled | _boolean_ | -| callback | Callback function after clicked | _action: Action_ | +| callback | Callback function after clicked | _action: ActionSheetAction_ | ### Events | Event | Description | Arguments | | --- | --- | --- | -| select | Emitted when an option is clicked | _action: Action, index: number_ | +| select | Emitted when an option is clicked | _action: ActionSheetAction, index: number_ | | cancel | Emitted when the cancel button is clicked | - | | open | Emitted when opening ActionSheet | - | | close | Emitted when closing ActionSheet | - | @@ -224,6 +224,14 @@ export default { | description | Custom description above the options | | cancel `v3.0.10` | Custom the content of cancel button | +### Types + +The component exports the following type definitions: + +```ts +import type { ActionSheetAction } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index 0c0d6947f..86638c13c 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -182,7 +182,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | v-model:show | 是否显示动作面板 | _boolean_ | `false` | -| actions | 面板选项列表 | _Action[]_ | `[]` | +| actions | 面板选项列表 | _ActionSheetAction[]_ | `[]` | | title | 顶部标题 | _string_ | - | | cancel-text | 取消按钮文字 | _string_ | - | | description | 选项上方的描述信息 | _string_ | - | @@ -214,13 +214,13 @@ export default { | className | 为对应列添加额外的 class | _string \| Array \| object_ | | loading | 是否为加载状态 | _boolean_ | | disabled | 是否为禁用状态 | _boolean_ | -| callback | 点击时触发的回调函数 | _action: Action_ | +| callback | 点击时触发的回调函数 | _action: ActionSheetAction_ | ### Events | 事件名 | 说明 | 回调参数 | | --- | --- | --- | -| select | 点击选项时触发，禁用或加载状态下不会触发 | _action: Action, index: number_ | +| select | 点击选项时触发，禁用或加载状态下不会触发 | _action: ActionSheetAction, index: number_ | | cancel | 点击取消按钮时触发 | - | | open | 打开面板时触发 | - | | close | 关闭面板时触发 | - | @@ -236,6 +236,14 @@ export default { | description | 自定义描述文案 | | cancel `v3.0.10` | 自定义取消按钮内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ActionSheetAction } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/address-list/README.md b/src/address-list/README.md index a9a86f5aa..c0d11e3a6 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -121,6 +121,14 @@ export default { | item-bottom | Custom content after list item | _item: Address_ | | tag `v3.0.9` | Custom tag of list item | _item: Address_ | +### Types + +The component exports the following type definitions: + +```ts +import type { AddressListAddress } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/address-list/README.zh-CN.md b/src/address-list/README.zh-CN.md index c57256214..ddda935be 100644 --- a/src/address-list/README.zh-CN.md +++ b/src/address-list/README.zh-CN.md @@ -81,28 +81,28 @@ export default { ### Props -| 参数 | 说明 | 类型 | 默认值 | -| ---------------- | ----------------- | ----------- | ---------- | -| v-model | 当前选中地址的 id | _string_ | - | -| list | 地址列表 | _Address[]_ | `[]` | -| disabled-list | 不可配送地址列表 | _Address[]_ | `[]` | -| disabled-text | 不可配送提示文案 | _string_ | - | -| switchable | 是否允许切换地址 | _boolean_ | `true` | -| add-button-text | 底部按钮文字 | _string_ | `新增地址` | -| default-tag-text | 默认地址标签文字 | _string_ | - | +| 参数 | 说明 | 类型 | 默认值 | +| ---------------- | ----------------- | ---------------------- | ---------- | +| v-model | 当前选中地址的 id | _string_ | - | +| list | 地址列表 | _AddressListAddress[]_ | `[]` | +| disabled-list | 不可配送地址列表 | _AddressListAddress[]_ | `[]` | +| disabled-text | 不可配送提示文案 | _string_ | - | +| switchable | 是否允许切换地址 | _boolean_ | `true` | +| add-button-text | 底部按钮文字 | _string_ | `新增地址` | +| default-tag-text | 默认地址标签文字 | _string_ | - | ### Events -| 事件名 | 说明 | 回调参数 | -| --------------- | ------------------------ | ------------------------------ | -| add | 点击新增按钮时触发 | - | -| edit | 点击编辑按钮时触发 | _item: Address, index: number_ | -| select | 切换选中的地址时触发 | _item: Address, index: number_ | -| edit-disabled | 编辑不可配送的地址时触发 | _item: Address, index: number_ | -| select-disabled | 选中不可配送的地址时触发 | _item: Address, index: number_ | -| click-item | 点击任意地址时触发 | _item: Address, index: number_ | +| 事件名 | 说明 | 回调参数 | +| --- | --- | --- | +| add | 点击新增按钮时触发 | - | +| edit | 点击编辑按钮时触发 | _item: AddressListAddress, index: number_ | +| select | 切换选中的地址时触发 | _item: AddressListAddress, index: number_ | +| edit-disabled | 编辑不可配送的地址时触发 | _item: AddressListAddress, index: number_ | +| select-disabled | 选中不可配送的地址时触发 | _item: AddressListAddress, index: number_ | +| click-item | 点击任意地址时触发 | _item: AddressListAddress, index: number_ | -### Address 数据结构 +### AddressListAddress 数据结构 | 键名 | 说明 | 类型 | | --------- | ------------------ | ------------------ | @@ -114,12 +114,20 @@ export default { ### Slots -| 名称 | 说明 | 参数 | -| ------------ | -------------------- | --------------- | -| default | 在列表下方插入内容 | - | -| top | 在顶部插入内容 | - | -| item-bottom | 在列表项底部插入内容 | _item: Address_ | -| tag `v3.0.9` | 自定义列表项标签内容 | _item: Address_ | +| 名称 | 说明 | 参数 | +| ------------ | -------------------- | -------------------------- | +| default | 在列表下方插入内容 | - | +| top | 在顶部插入内容 | - | +| item-bottom | 在列表项底部插入内容 | _item: AddressListAddress_ | +| tag `v3.0.9` | 自定义列表项标签内容 | _item: AddressListAddress_ | + +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { AddressListAddress } from 'vant'; +``` ## 主题定制 diff --git a/src/button/README.md b/src/button/README.md index 94a915e6b..e27df77c0 100644 --- a/src/button/README.md +++ b/src/button/README.md @@ -149,6 +149,14 @@ app.use(Button); | icon `v3.0.18` | Custom icon | | loading | Custom loading icon | +### Types + +The component exports the following type definitions: + +```ts +import type { ButtonType, ButtonSize } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/button/README.zh-CN.md b/src/button/README.zh-CN.md index 4292603fa..b15a792aa 100644 --- a/src/button/README.zh-CN.md +++ b/src/button/README.zh-CN.md @@ -172,6 +172,14 @@ app.use(Button); | icon `v3.0.18` | 自定义图标 | | loading | 自定义加载图标 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ButtonType, ButtonSize } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/cascader/README.md b/src/cascader/README.md index 5134ac728..dd45e01e3 100644 --- a/src/cascader/README.md +++ b/src/cascader/README.md @@ -240,6 +240,14 @@ export default { | title | Custom title | - | | option `v3.1.4` | Custom option text | _{ option: Option, selected: boolean }_ | +### Types + +The component exports the following type definitions: + +```ts +import type { CascaderOption, CascaderFieldNames } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/cascader/README.zh-CN.md b/src/cascader/README.zh-CN.md index 92dae7b96..b42f26645 100644 --- a/src/cascader/README.zh-CN.md +++ b/src/cascader/README.zh-CN.md @@ -252,6 +252,14 @@ export default { | title | 自定义顶部标题 | - | | option `v3.1.4` | 自定义选项文字 | _{ option: Option, selected: boolean }_ | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { CascaderOption, CascaderFieldNames } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/cell/README.md b/src/cell/README.md index ec743d2df..dc5efcd0c 100644 --- a/src/cell/README.md +++ b/src/cell/README.md @@ -192,6 +192,14 @@ app.use(CellGroup); | right-icon | Custom right icon | | extra | Custom extra content on the right | +### Types + +The component exports the following type definitions: + +```ts +import type { CellArrowDirection } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/cell/README.zh-CN.md b/src/cell/README.zh-CN.md index a83ffef3c..dadd7509c 100644 --- a/src/cell/README.zh-CN.md +++ b/src/cell/README.zh-CN.md @@ -197,6 +197,14 @@ app.use(CellGroup); | right-icon | 自定义右侧图标 | | extra | 自定义单元格最右侧的额外内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { CellArrowDirection } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/circle/README.md b/src/circle/README.md index 359f2991c..30d56f089 100644 --- a/src/circle/README.md +++ b/src/circle/README.md @@ -167,6 +167,14 @@ export default { | ------- | ------------------- | | default | custom text content | +### Types + +The component exports the following type definitions: + +```ts +import type { CircleStartPosition } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/circle/README.zh-CN.md b/src/circle/README.zh-CN.md index e0761577e..c20d794e6 100644 --- a/src/circle/README.zh-CN.md +++ b/src/circle/README.zh-CN.md @@ -181,6 +181,14 @@ export default { | ------- | -------------- | | default | 自定义文字内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { CircleStartPosition } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/col/README.md b/src/col/README.md index fd96897dc..8f0e68e0f 100644 --- a/src/col/README.md +++ b/src/col/README.md @@ -112,3 +112,11 @@ Set grid spacing using `gutter` attribute. The default value is 0. | Event | Description | Arguments | | ----- | ------------------------------- | ------------------- | | click | Emitted when the col is clicked | _event: MouseEvent_ | + +### Types + +The component exports the following type definitions: + +```ts +import type { RowAlign, RowJustify } from 'vant'; +``` diff --git a/src/col/README.zh-CN.md b/src/col/README.zh-CN.md index 3f9b7292f..e102e5985 100644 --- a/src/col/README.zh-CN.md +++ b/src/col/README.zh-CN.md @@ -117,3 +117,11 @@ Layout 组件提供了 `24列栅格`，通过在 `Col` 上添加 `span` 属性 | 事件名 | 说明 | 回调参数 | | ------ | ---------- | ------------------- | | click | 点击时触发 | _event: MouseEvent_ | + +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { RowAlign, RowJustify } from 'vant'; +``` diff --git a/src/contact-card/README.md b/src/contact-card/README.md index 69bb25cbe..0138194fd 100644 --- a/src/contact-card/README.md +++ b/src/contact-card/README.md @@ -90,6 +90,14 @@ export default { | ----- | --------------------------------- | ------------------- | | click | Emitted when component is clicked | _event: MouseEvent_ | +### Types + +The component exports the following type definitions: + +```ts +import type { ContactCardType } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/contact-card/README.zh-CN.md b/src/contact-card/README.zh-CN.md index 907d2a3c3..1163cbc40 100644 --- a/src/contact-card/README.zh-CN.md +++ b/src/contact-card/README.zh-CN.md @@ -84,6 +84,14 @@ export default { | ------ | ---------- | ------------------- | | click | 点击时触发 | _event: MouseEvent_ | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ContactCardType } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/contact-edit/README.md b/src/contact-edit/README.md index f12847890..f620aafb5 100644 --- a/src/contact-edit/README.md +++ b/src/contact-edit/README.md @@ -77,6 +77,14 @@ export default { | name | Name | _string_ | | tel | Phone | _string_ | +### Types + +The component exports the following type definitions: + +```ts +import type { ContactEditInfo } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/contact-edit/README.zh-CN.md b/src/contact-edit/README.zh-CN.md index f7a4b7067..9a5a1f23c 100644 --- a/src/contact-edit/README.zh-CN.md +++ b/src/contact-edit/README.zh-CN.md @@ -77,6 +77,14 @@ export default { | name | 联系人姓名 | _string_ | | tel | 联系人手机号 | _number \| string_ | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ContactEditInfo } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/contact-list/README.md b/src/contact-list/README.md index cf45752e7..d1f04e03f 100644 --- a/src/contact-list/README.md +++ b/src/contact-list/README.md @@ -95,6 +95,14 @@ export default { | tel | Phone | _string_ | | isDefault | Is default contact | _boolean_ | +### Types + +The component exports the following type definitions: + +```ts +import type { ContactListItem } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/contact-list/README.zh-CN.md b/src/contact-list/README.zh-CN.md index 4d788be96..d2baa18e8 100644 --- a/src/contact-list/README.zh-CN.md +++ b/src/contact-list/README.zh-CN.md @@ -95,6 +95,14 @@ export default { | tel | 联系人手机号 | _number \| string_ | | isDefault | 是否为默认联系人 | _boolean_ | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ContactListItem } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/dialog/README.md b/src/dialog/README.md index 3dc4b1443..ca2932df3 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -214,6 +214,19 @@ export default { | title | Custom title | | footer `v3.0.10` | Custom footer | +### Types + +The component exports the following type definitions: + +```ts +import type { + DialogTheme, + DialogMessage, + DialogOptions, + DialogMessageAlign, +} from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/dialog/README.zh-CN.md b/src/dialog/README.zh-CN.md index c3d6fe368..a45fbc08a 100644 --- a/src/dialog/README.zh-CN.md +++ b/src/dialog/README.zh-CN.md @@ -249,6 +249,19 @@ export default { | title | 自定义标题 | | footer `v3.0.10` | 自定义底部按钮区域 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { + DialogTheme, + DialogMessage, + DialogOptions, + DialogMessageAlign, +} from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/divider/README.md b/src/divider/README.md index ee821ffd2..41f5e99d8 100644 --- a/src/divider/README.md +++ b/src/divider/README.md @@ -69,6 +69,14 @@ app.use(Divider); | ------- | ----------- | | default | content | +### Types + +The component exports the following type definitions: + +```ts +import type { DividerContentPosition } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/divider/README.zh-CN.md b/src/divider/README.zh-CN.md index 6d9f14733..62ebc1288 100644 --- a/src/divider/README.zh-CN.md +++ b/src/divider/README.zh-CN.md @@ -79,6 +79,14 @@ app.use(Divider); | ------- | ---- | | default | 内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { DividerContentPosition } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/grid/README.md b/src/grid/README.md index c369572dd..488c882d4 100644 --- a/src/grid/README.md +++ b/src/grid/README.md @@ -142,6 +142,14 @@ app.use(GridItem); | icon | Custom icon | | text | Custom text | +### Types + +The component exports the following type definitions: + +```ts +import type { GridDirection } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/grid/README.zh-CN.md b/src/grid/README.zh-CN.md index bd3270335..d872d20f5 100644 --- a/src/grid/README.zh-CN.md +++ b/src/grid/README.zh-CN.md @@ -158,6 +158,14 @@ app.use(GridItem); | icon | 自定义图标 | | text | 自定义文字 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { GridDirection } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/image/README.md b/src/image/README.md index 28a712d53..acd2afb9e 100644 --- a/src/image/README.md +++ b/src/image/README.md @@ -114,6 +114,14 @@ app.use(Lazyload); | loading | Custom loading placeholder | | error | Custom error placeholder | +### Types + +The component exports the following type definitions: + +```ts +import type { ImageFit } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/image/README.zh-CN.md b/src/image/README.zh-CN.md index 111915699..aca5dac8e 100644 --- a/src/image/README.zh-CN.md +++ b/src/image/README.zh-CN.md @@ -142,6 +142,14 @@ app.use(Lazyload); | loading | 自定义加载中的提示内容 | | error | 自定义加载失败时的提示内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ImageFit } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/loading/README.md b/src/loading/README.md index 3dbfd244d..083f78ab3 100644 --- a/src/loading/README.md +++ b/src/loading/README.md @@ -85,6 +85,14 @@ use `color` or `text-color` to change text color. | ------- | ------------ | | default | Loading text | +### Types + +The component exports the following type definitions: + +```ts +import type { LoadingType } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/loading/README.zh-CN.md b/src/loading/README.zh-CN.md index d01f3b44b..7d8fb4296 100644 --- a/src/loading/README.zh-CN.md +++ b/src/loading/README.zh-CN.md @@ -95,6 +95,14 @@ app.use(Loading); | ------- | -------- | | default | 加载文案 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { LoadingType } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/notify/README.md b/src/notify/README.md index 3b314f58d..14780a76b 100644 --- a/src/notify/README.md +++ b/src/notify/README.md @@ -118,6 +118,14 @@ export default { | onOpened | Callback function after opened | _() => void_ | - | | onClose | Callback function after close | _() => void_ | - | +### Types + +The component exports the following type definitions: + +```ts +import type { NotifyType, NotifyOptions } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/notify/README.zh-CN.md b/src/notify/README.zh-CN.md index 1d4c3b777..9b1444d7f 100644 --- a/src/notify/README.zh-CN.md +++ b/src/notify/README.zh-CN.md @@ -151,6 +151,14 @@ export default { | onOpened | 完全展示后的回调函数 | _() => void_ | - | | onClose | 关闭时的回调函数 | _() => void_ | - | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { NotifyType, NotifyOptions } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/number-keyboard/README.md b/src/number-keyboard/README.md index f0a8b24db..954da5e6c 100644 --- a/src/number-keyboard/README.md +++ b/src/number-keyboard/README.md @@ -189,7 +189,7 @@ export default { | Event | Description | Arguments | | --- | --- | --- | -| input | Emitted when keydown | key: Content of the key | +| input | Emitted when a key is pressed | key: Content of the key | | delete | Emitted when the delete key is pressed | - | | close | Emitted when the close button is clicked | - | | blur | Emitted when the close button is clicked or the keyboard is blurred | - | @@ -204,6 +204,14 @@ export default { | extra-key | Custom extra key content | | title-left | Custom title left content | +### Types + +The component exports the following type definitions: + +```ts +import type { NumberKeyboardTheme } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/number-keyboard/README.zh-CN.md b/src/number-keyboard/README.zh-CN.md index 930e2958e..6032f95a6 100644 --- a/src/number-keyboard/README.zh-CN.md +++ b/src/number-keyboard/README.zh-CN.md @@ -211,6 +211,14 @@ export default { | extra-key | 自定义左下角按键内容 | | title-left | 自定义标题栏左侧内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { NumberKeyboardTheme } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/pagination/README.md b/src/pagination/README.md index 16c6380da..82c0bc66d 100644 --- a/src/pagination/README.md +++ b/src/pagination/README.md @@ -93,8 +93,16 @@ export default { | Name | Description | SlotProps | | --- | --- | --- | | page | Custom pagination item | _{ number: number, text: string, active: boolean }_ | -| prev-text | Custom prev text | `-` | -| next-text | Custom next text | `-` | +| prev-text | Custom prev text | - | +| next-text | Custom next text | - | + +### Types + +The component exports the following type definitions: + +```ts +import type { PaginationMode } from 'vant'; +``` ## Theming diff --git a/src/pagination/README.zh-CN.md b/src/pagination/README.zh-CN.md index 3218441e1..e3b100538 100644 --- a/src/pagination/README.zh-CN.md +++ b/src/pagination/README.zh-CN.md @@ -101,8 +101,16 @@ export default { | 名称 | 描述 | 参数 | | --- | --- | --- | | page | 自定义页码 | _{ number: number, text: string, active: boolean }_ | -| prev-text | 自定义上一页按钮文字 | `-` | -| next-text | 自定义下一页按钮文字 | `-` | +| prev-text | 自定义上一页按钮文字 | - | +| next-text | 自定义下一页按钮文字 | - | + +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { PaginationMode } from 'vant'; +``` ## 主题定制 diff --git a/src/popover/README.md b/src/popover/README.md index 59a166802..6ebf17f4e 100644 --- a/src/popover/README.md +++ b/src/popover/README.md @@ -211,10 +211,10 @@ export default { | Attribute | Description | Type | Default | | --- | --- | --- | --- | | v-model:show | Whether to show Popover | _boolean_ | `false` | -| actions | Actions | _Action[]_ | `[]` | -| placement | Placement | _string_ | `bottom` | -| theme | Theme，can be set to `dark` | _string_ | `light` | -| trigger | Trigger mode，can be set to `manual` | `click` | +| actions | Actions | _PopoverAction[]_ | `[]` | +| placement | Placement | _PopoverPlacement_ | `bottom` | +| theme | Theme，can be set to `dark` | _PopoverTheme_ | `light` | +| trigger | Trigger mode，can be set to `manual` | _PopoverTrigger_ | `click` | | duration | Transition duration, unit second | _number \| string_ | `0.3` | | offset | Distance to reference | _[number, number]_ | `[0, 8]` | | overlay | Whether to show overlay | _boolean_ | `false` | @@ -226,7 +226,7 @@ export default { | teleport | Specifies a target element where Popover will be mounted | _string \| Element_ | `body` | | icon-prefix `v3.0.17` | Icon className prefix | _string_ | `van-icon` | -### Data Structure of Action +### Data Structure of PopoverAction | Key | Description | Type | | --------- | ----------------------- | --------------------------- | @@ -254,6 +254,19 @@ export default { | default | Custom content | | reference | Reference Element | +### Types + +The component exports the following type definitions: + +```ts +import type { + PopoverTheme, + PopoverAction, + PopoverTrigger, + PopoverPlacement, +} from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/popover/README.zh-CN.md b/src/popover/README.zh-CN.md index 8f3b1287e..31f90a8e5 100644 --- a/src/popover/README.zh-CN.md +++ b/src/popover/README.zh-CN.md @@ -221,10 +221,10 @@ export default { | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | v-model:show | 是否展示气泡弹出层 | _boolean_ | `false` | -| actions | 选项列表 | _Action[]_ | `[]` | -| placement | 弹出位置 | _string_ | `bottom` | -| theme | 主题风格，可选值为 `dark` | _string_ | `light` | -| trigger | 触发方式，可选值为 `manual` | `click` | +| actions | 选项列表 | _PopoverAction[]_ | `[]` | +| placement | 弹出位置 | _PopoverPlacement_ | `bottom` | +| theme | 主题风格，可选值为 `dark` | _PopoverTheme_ | `light` | +| trigger | 触发方式，可选值为 `manual` | _PopoverTrigger_ | `click` | | duration | 动画时长，单位秒，设置为 0 可以禁用动画 | _number \| string_ | `0.3` | | offset | 出现位置的偏移量 | _[number, number]_ | `[0, 8]` | | overlay | 是否显示遮罩层 | _boolean_ | `false` | @@ -236,7 +236,7 @@ export default { | teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` | | icon-prefix `v3.0.17` | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` | -### Action 数据结构 +### PopoverAction 数据结构 `actions` 属性是一个由对象构成的数组，数组中的每个对象配置一列，对象可以包含以下值： @@ -266,6 +266,19 @@ export default { | default | 自定义菜单内容 | | reference | 触发 Popover 显示的元素内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { + PopoverTheme, + PopoverAction, + PopoverTrigger, + PopoverPlacement, +} from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/popup/README.md b/src/popup/README.md index ba53a76cf..137f81d38 100644 --- a/src/popup/README.md +++ b/src/popup/README.md @@ -146,6 +146,14 @@ Use `teleport` prop to specify mount location. | default | Content of Popup | | overlay-content `v3.0.18` | Content of Popup overlay | +### Types + +The component exports the following type definitions: + +```ts +import type { PopupPosition, PopupCloseIconPosition } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/popup/README.zh-CN.md b/src/popup/README.zh-CN.md index 356974863..af4f8c83c 100644 --- a/src/popup/README.zh-CN.md +++ b/src/popup/README.zh-CN.md @@ -152,6 +152,14 @@ export default { | default | 弹窗内容 | | overlay-content `v3.0.18` | 遮罩层的内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { PopupPosition, PopupCloseIconPosition } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/share-sheet/README.md b/src/share-sheet/README.md index c4dc75543..c7558f9a8 100644 --- a/src/share-sheet/README.md +++ b/src/share-sheet/README.md @@ -214,6 +214,14 @@ export default { | description | Custom description | | cancel `v3.0.10` | Custom the content of cancel button | +### Types + +The component exports the following type definitions: + +```ts +import type { ShareSheetOption, ShareSheetOptions } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/share-sheet/README.zh-CN.md b/src/share-sheet/README.zh-CN.md index 20cdddff0..485fcb190 100644 --- a/src/share-sheet/README.zh-CN.md +++ b/src/share-sheet/README.zh-CN.md @@ -228,6 +228,14 @@ export default { | description | 自定义描述文字 | | cancel `v3.0.10` | 自定义取消按钮内容 | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ShareSheetOption, ShareSheetOptions } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/stepper/README.md b/src/stepper/README.md index 3037cf80a..b4fd8b8ae 100644 --- a/src/stepper/README.md +++ b/src/stepper/README.md @@ -157,6 +157,14 @@ export default { | focus | Emitted when the input is focused | _event: Event_ | | blur | Emitted when the input is blurred | _event: Event_ | +### Types + +The component exports the following type definitions: + +```ts +import type { StepperTheme } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/stepper/README.zh-CN.md b/src/stepper/README.zh-CN.md index 446fee9f8..cd252ebb4 100644 --- a/src/stepper/README.zh-CN.md +++ b/src/stepper/README.zh-CN.md @@ -177,6 +177,14 @@ export default { | focus | 输入框聚焦时触发 | _event: Event_ | | blur | 输入框失焦时触发 | _event: Event_ | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { StepperTheme } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/sticky/README.md b/src/sticky/README.md index 47e4df18c..39cbe4fa4 100644 --- a/src/sticky/README.md +++ b/src/sticky/README.md @@ -80,6 +80,14 @@ export default { | change `v3.0.10` | Emitted when sticky status changed | _isFixed: boolean_ | | scroll | Emitted when scrolling | _{ scrollTop: number, isFixed: boolean }_ | +### Types + +The component exports the following type definitions: + +```ts +import type { StickyPosition } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/sticky/README.zh-CN.md b/src/sticky/README.zh-CN.md index d8d4ea545..f3fcf73f9 100644 --- a/src/sticky/README.zh-CN.md +++ b/src/sticky/README.zh-CN.md @@ -88,6 +88,14 @@ export default { | change `v3.0.10` | 当吸顶状态改变时触发 | _isFixed: boolean_ | | scroll | 滚动时触发 | _{ scrollTop: number, isFixed: boolean }_ | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { StickyPosition } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/toast/README.md b/src/toast/README.md index 05d940833..e256aec61 100644 --- a/src/toast/README.md +++ b/src/toast/README.md @@ -155,8 +155,8 @@ Toast.resetDefaultOptions('loading'); | Attribute | Description | Type | Default | | --- | --- | --- | --- | -| type | Can be set to `loading` `success` `fail` `html` | _string_ | `text` | -| position | Can be set to `top` `middle` `bottom` | _string_ | `middle` | +| type | Can be set to `loading` `success` `fail` `html` | _ToastType_ | `text` | +| position | Can be set to `top` `middle` `bottom` | _ToastPosition_ | `middle` | | message | Message | _string_ | `''` | | icon | Custom icon | _string_ | - | | iconSize | Custom icon size | _number \| string_ | `36px` | @@ -175,6 +175,14 @@ Toast.resetDefaultOptions('loading'); | transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` | | teleport | Specifies a target element where Toast will be mounted | _string \| Element_ | `body` | +### Types + +The component exports the following type definitions: + +```ts +import type { ToastType, ToastOptions, ToastPosition } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/toast/README.zh-CN.md b/src/toast/README.zh-CN.md index 0ac8d73dc..2e237c4f9 100644 --- a/src/toast/README.zh-CN.md +++ b/src/toast/README.zh-CN.md @@ -162,12 +162,12 @@ Toast.resetDefaultOptions('loading'); | Toast.setDefaultOptions | 修改默认配置，对所有 Toast 生效。
传入 type 可以修改指定类型的默认配置 | `type \| options` | `void` | | Toast.resetDefaultOptions | 重置默认配置，对所有 Toast 生效。
传入 type 可以重置指定类型的默认配置 | `type` | `void` | -### Options +### ToastOptions 数据结构 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| type | 提示类型，可选值为 `loading` `success`
`fail` `html` | _string_ | `text` | -| position | 位置，可选值为 `top` `bottom` | _string_ | `middle` | +| type | 提示类型，可选值为 `loading` `success`
`fail` `html` | _ToastType_ | `text` | +| position | 位置，可选值为 `top` `bottom` | _ToastPosition_ | `middle` | | message | 文本内容，支持通过`\n`换行 | _string_ | `''` | | icon | 自定义图标，支持传入[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - | | iconSize | 图标大小，如 `20px` `2em`，默认单位为 `px` | _number \| string_ | `36px` | @@ -186,6 +186,14 @@ Toast.resetDefaultOptions('loading'); | transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的`name`属性 | _string_ | `van-fade` | | teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` | +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { ToastType, ToastOptions, ToastPosition } from 'vant'; +``` + ## 主题定制 ### 样式变量 diff --git a/src/tree-select/README.md b/src/tree-select/README.md index 82c5f1f7f..cf1bfdee7 100644 --- a/src/tree-select/README.md +++ b/src/tree-select/README.md @@ -228,6 +228,14 @@ In every tree object, `text` property defines `id` stands for the unique key whi ]; ``` +### Types + +The component exports the following type definitions: + +```ts +import type { TreeSelectItem, TreeSelectChild } from 'vant'; +``` + ## Theming ### CSS Variables diff --git a/src/tree-select/README.zh-CN.md b/src/tree-select/README.zh-CN.md index 7a0f5e6b4..ee1e79319 100644 --- a/src/tree-select/README.zh-CN.md +++ b/src/tree-select/README.zh-CN.md @@ -234,6 +234,14 @@ export default { ]; ``` +### 类型定义 + +组件导出以下类型定义： + +```ts +import type { TreeSelectItem, TreeSelectChild } from 'vant'; +``` + ## 主题定制 ### 样式变量