From ff45e2f034b00e4ce38074eb6378b482dcdf7a71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=89=E5=B0=91?= Date: Mon, 23 May 2022 17:17:13 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E8=97=A4=E6=96=B0=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E9=83=A8=E7=BD=B2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/vantui-doc/build.sh | 2 + .../vantui-doc/src/action-sheet/README.md | 60 ++++---- packages/vantui-doc/src/area/README.md | 18 +-- packages/vantui-doc/src/button/README.md | 38 ++--- packages/vantui-doc/src/calendar/README.md | 119 ++++++++-------- packages/vantui-doc/src/card/README.md | 52 +++---- packages/vantui-doc/src/cell/README.md | 70 ++++----- packages/vantui-doc/src/checkbox/README.md | 52 +++---- packages/vantui-doc/src/circle/README.md | 32 ++--- packages/vantui-doc/src/col/README.md | 24 ++-- packages/vantui-doc/src/collapse/README.md | 62 ++++---- .../vantui-doc/src/config-provider/README.md | 10 +- packages/vantui-doc/src/count-down/README.md | 60 ++++---- .../vantui-doc/src/datetime-picker/README.md | 71 +++++----- packages/vantui-doc/src/dialog/README.md | 62 ++++---- packages/vantui-doc/src/divider/README.md | 22 +-- .../vantui-doc/src/dropdown-menu/README.md | 83 +++++------ packages/vantui-doc/src/empty/README.md | 16 +-- packages/vantui-doc/src/field/README.md | 134 +++++++++--------- packages/vantui-doc/src/form/README.md | 75 +++++----- .../vantui-doc/src/goods-action/README.md | 10 +- packages/vantui-doc/src/grid/README.md | 58 ++++---- packages/vantui-doc/src/icon/README.md | 22 +-- packages/vantui-doc/src/image/README.md | 32 ++--- packages/vantui-doc/src/index-bar/README.md | 20 +-- packages/vantui-doc/src/loading/README.md | 18 +-- packages/vantui-doc/src/nav-bar/README.md | 36 ++--- packages/vantui-doc/src/notice-bar/README.md | 42 +++--- packages/vantui-doc/src/notify/README.md | 34 ++--- .../vantui-doc/src/number-keyboard/README.md | 30 ++-- packages/vantui-doc/src/overlay/README.md | 16 +-- packages/vantui-doc/src/pagination/README.md | 34 ++--- packages/vantui-doc/src/picker/README.md | 57 ++++---- packages/vantui-doc/src/popup/README.md | 38 ++--- packages/vantui-doc/src/progress/README.md | 26 ++-- packages/vantui-doc/src/radio/README.md | 50 +++---- packages/vantui-doc/src/rate/README.md | 38 ++--- packages/vantui-doc/src/search/README.md | 70 ++++----- packages/vantui-doc/src/share-sheet/README.md | 74 +++++----- packages/vantui-doc/src/sidebar/README.md | 40 +++--- packages/vantui-doc/src/skeleton/README.md | 28 ++-- packages/vantui-doc/src/slider/README.md | 42 +++--- packages/vantui-doc/src/stepper/README.md | 62 ++++---- packages/vantui-doc/src/steps/README.md | 26 ++-- packages/vantui-doc/src/sticky/README.md | 22 +-- packages/vantui-doc/src/submit-bar/README.md | 40 +++--- packages/vantui-doc/src/swipe-cell/README.md | 48 +++---- packages/vantui-doc/src/switch/README.md | 26 ++-- packages/vantui-doc/src/tab/README.md | 80 +++++------ packages/vantui-doc/src/tabbar/README.md | 56 ++++---- packages/vantui-doc/src/table/README.md | 49 +++---- packages/vantui-doc/src/tag/README.md | 28 ++-- packages/vantui-doc/src/toast/README.md | 39 ++--- packages/vantui-doc/src/transition/README.md | 8 +- packages/vantui-doc/src/tree-select/README.md | 28 ++-- packages/vantui-doc/src/uploader/README.md | 68 ++++----- 56 files changed, 1235 insertions(+), 1222 deletions(-) diff --git a/packages/vantui-doc/build.sh b/packages/vantui-doc/build.sh index df7e55331..197f5b8bb 100755 --- a/packages/vantui-doc/build.sh +++ b/packages/vantui-doc/build.sh @@ -3,6 +3,8 @@ npx antm-vantui-cli mdcode --mode create npx antm-vantui-cli docs --mode production +npx prettier --write '**/*.{js,jsx,ts,tsx,md,html,css,less}' + cd ./../vantui-demo pwd diff --git a/packages/vantui-doc/src/action-sheet/README.md b/packages/vantui-doc/src/action-sheet/README.md index 5ffb5d187..d54c0ce42 100644 --- a/packages/vantui-doc/src/action-sheet/README.md +++ b/packages/vantui-doc/src/action-sheet/README.md @@ -225,34 +225,34 @@ function Demo() { ) } ``` -### ActionSheetItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| name | - | _  string
_ | -| subname | - | _  string
_ | -| color | - | _  string
_ | -| loading | - | _  boolean
_ | -| disabled | - | _  boolean
_ | - -### ActionSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| actions | - | _  ActionSheetItem[]
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| show | - | _  boolean
_ | - | `false` | -| cancelText | - | _  string
_ | - | `false` | -| description | - | _  string
_ | - | `false` | -| overlay | - | _  boolean
_ | - | `false` | -| closeOnClickOverlay | - | _  boolean
_ | - | `false` | -| closeOnClickAction | - | _  boolean
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| round | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onSelect | - | _  (
    event: ITouchEvent & {
      detail: ActionSheetItem
    }
  ) => void
_ | - | `false` | -| onCancel | - | _  () => void
_ | - | `false` | -| onClose | - | _  () => void
_ | - | `false` | -| onClickOverlay | - | _  () => void
_ | - | `false` | +### ActionSheetItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) + +| 参数 | 说明 | 类型 | +| -------- | ---- | -------------------------- | +| name | - | _  string
_ | +| subname | - | _  string
_ | +| color | - | _  string
_ | +| loading | - | _  boolean
_ | +| disabled | - | _  boolean
_ | + +### ActionSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| actions | - | _  ActionSheetItem[]
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| show | - | _  boolean
_ | - | `false` | +| cancelText | - | _  string
_ | - | `false` | +| description | - | _  string
_ | - | `false` | +| overlay | - | _  boolean
_ | - | `false` | +| closeOnClickOverlay | - | _  boolean
_ | - | `false` | +| closeOnClickAction | - | _  boolean
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| round | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onSelect | - | _  (
    event: ITouchEvent & {
      detail: ActionSheetItem
    }
  ) => void
_ | - | `false` | +| onCancel | - | _  () => void
_ | - | `false` | +| onClose | - | _  () => void
_ | - | `false` | +| onClickOverlay | - | _  () => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/area/README.md b/packages/vantui-doc/src/area/README.md index 9bfe75c6f..1c4247424 100644 --- a/packages/vantui-doc/src/area/README.md +++ b/packages/vantui-doc/src/area/README.md @@ -113,14 +113,14 @@ function Demo() { ) } ``` -### AreaProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/area.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| showToolbar | - | _  boolean
_ | - | `false` | -| value | - | _  string
_ | - | `false` | -| areaList | - | _  {
    province_list: {
      [x: number ¦ string]: string
    }
    city_list: {
      [x: number ¦ string]: string
    }
    county_list: {
      [x: number ¦ string]: string
    }
  }
_ | - | `false` | -| columnsNum | - | _  string ¦ number
_ | - | `false` | -| columnsPlaceholder | - | _  string[]
_ | - | `false` | -| onChange | - | _  (event: {
    detail: {
      values: number[] ¦ string[]
      picker: IPickerInstance
      index: number
    }
  }) => void
_ | - | `true` | +### AreaProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/area.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------ | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| showToolbar | - | _  boolean
_ | - | `false` | +| value | - | _  string
_ | - | `false` | +| areaList | - | _  {
    province_list: {
      [x: number ¦ string]: string
    }
    city_list: {
      [x: number ¦ string]: string
    }
    county_list: {
      [x: number ¦ string]: string
    }
  }
_ | - | `false` | +| columnsNum | - | _  string ¦ number
_ | - | `false` | +| columnsPlaceholder | - | _  string[]
_ | - | `false` | +| onChange | - | _  (event: {
    detail: {
      values: number[] ¦ string[]
      picker: IPickerInstance
      index: number
    }
  }) => void
_ | - | `true` | diff --git a/packages/vantui-doc/src/button/README.md b/packages/vantui-doc/src/button/README.md index 7277e8f9f..10f90f46b 100644 --- a/packages/vantui-doc/src/button/README.md +++ b/packages/vantui-doc/src/button/README.md @@ -208,23 +208,23 @@ function Demo() { ) } ``` -### ButtonProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/button.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| icon | - | _  string
_ | - | `false` | -| classPrefix | - | _  string
_ | - | `false` | -| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | -| size | - | _  "small" ¦ "normal" ¦ "large" ¦ "mini"
_ | - | `false` | -| block | - | _  boolean
_ | - | `false` | -| round | - | _  boolean
_ | - | `false` | -| square | - | _  boolean
_ | - | `false` | -| loading | - | _  boolean
_ | - | `false` | -| hairline | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| loadingText | - | _  string
_ | - | `false` | -| loadingSize | - | _  string
_ | - | `false` | -| loadingType | - | _  "spinner" ¦ "circular"
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### ButtonProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/button.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| icon | - | _  string
_ | - | `false` | +| classPrefix | - | _  string
_ | - | `false` | +| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | +| size | - | _  "small" ¦ "normal" ¦ "large" ¦ "mini"
_ | - | `false` | +| block | - | _  boolean
_ | - | `false` | +| round | - | _  boolean
_ | - | `false` | +| square | - | _  boolean
_ | - | `false` | +| loading | - | _  boolean
_ | - | `false` | +| hairline | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| loadingText | - | _  string
_ | - | `false` | +| loadingSize | - | _  string
_ | - | `false` | +| loadingType | - | _  "spinner" ¦ "circular"
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/calendar/README.md b/packages/vantui-doc/src/calendar/README.md index 1bd4c9496..72b5ed3f8 100644 --- a/packages/vantui-doc/src/calendar/README.md +++ b/packages/vantui-doc/src/calendar/README.md @@ -481,74 +481,77 @@ function Demo() { --calendarHeight: 500px; } ``` -### CalendarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| title | 日历标题 | _  string
_ | - | `false` | -| color | 主题色，对底部按钮和选中日期生效 | _  string
_ | #ee0a24 | `false` | -| show | 是否显示日历弹窗 | _  boolean
_ | false | `false` | -| formatter | 日期格式化函数 | _  (day: Day) => Day
_ | - | `false` | -| confirmText | 确认按钮的文字 | _  string
_ | - | `false` | -| rangePrompt | 范围选择超过最多可选天数时的提示文案 | _  string
_ | 选择天数不能超过xx天 | `false` | -| showRangePrompt | 范围选择超过最多可选天数时，是否展示提示文案 | _  boolean
_ | true | `false` | -| defaultDate | 默认选中的日期，type为multiple或range时为数组 | _  string ¦ string[]
_ | 今天 | `false` | -| allowSameDay | 是否允许日期范围的起止时间为同一天 | _  boolean
_ | false | `false` | -| confirmDisabledText | 确认按钮处于禁用状态时的文字 | _  string
_ | 确定 | `false` | -| type | 类型 | _  "single" ¦ "multiple" ¦ "range"
_ | - | `false` | -| minDate | 可选择的最小日期 | _  number
_ | 当前日期 | `false` | -| maxDate | 可选择的最大日期 | _  number
_ | 当前日期六个月后 | `false` | -| position | 弹窗弹出的位置 | _  "left" ¦ "right" ¦ "bottom" ¦ "top"
_ | bottom | `false` | -| rowHeight | 日期行高 | _  number ¦ string
_ | 64 | `false` | -| round | 弹窗是否圆角 | _  boolean
_ | true | `false` | -| poppable | 是否以弹层的形式展示日历 | _  boolean
_ | true | `false` | -| showMark | 是否显示月份背景水印 | _  boolean
_ | true | `false` | -| showTitle | 是否展示日历标题 | _  boolean
_ | true | `false` | -| showConfirm | 是否展示确认按钮 | _  boolean
_ | true | `false` | -| showSubtitle | 是否展示日历副标题（年月） | _  boolean
_ | true | `false` | -| safeAreaInsetBottom | 是否开启底部安全区适配 | _  boolean
_ | true | `false` | -| closeOnClickOverlay | 是否在点击遮罩层后关闭 | _  boolean
_ | true | `false` | -| maxRange | 日期区间最多可选天数，默认无限制 | _  number
_ | - | `false` | -| firstDayOfWeek | 设置周起始日 | _  0 ¦ 1 ¦ 2 ¦ 3 ¦ 4 ¦ 5 ¦ 6
_ | 0 | `false` | -| onOpen | - | _  () => void
_ | - | `false` | -| onClose | - | _  () => void
_ | - | `false` | -| onOpened | - | _  () => void
_ | - | `false` | -| onClosed | - | _  () => void
_ | - | `false` | -| onConfirm | - | _  (e: CalendarEvents) => void
_ | - | `false` | -| overRange | - | _  () => void
_ | - | `false` | -| onUnselect | - | _  (e: CalendarEventsSingle) => void
_ | - | `false` | -| onSelect | - | _  (e: CalendarEvents) => void
_ | - | `false` | -| onClickSubtitle | - | _  (a?: any) => void
_ | - | `false` | -| renderTitle | 自定义标题 | _  React.ReactNode
_ | - | `false` | -| renderFooter | 自定义底部区域内容 | _  React.ReactNode
_ | - | `false` | - -### formatter回调参数Day [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| date | - | _  attr:
    ¦ "selected"
    ¦ "start"
    ¦ "middle"
    ¦ "end"
    ¦ "disabled"
_ | -| type | - | _  string
_ | -| text | - | _  string ¦ number
_ | -| bottomInfo | - | _  string
_ | -| className | - | _  string
_ | -| topInfo | - | _  string
_ | - -### ICalendarInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) -使用ref获取到的组件实例 +### CalendarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ------- | +| title | 日历标题 | _  string
_ | - | `false` | +| color | 主题色，对底部按钮和选中日期生效 | _  string
_ | #ee0a24 | `false` | +| show | 是否显示日历弹窗 | _  boolean
_ | false | `false` | +| formatter | 日期格式化函数 | _  (day: Day) => Day
_ | - | `false` | +| confirmText | 确认按钮的文字 | _  string
_ | - | `false` | +| rangePrompt | 范围选择超过最多可选天数时的提示文案 | _  string
_ | 选择天数不能超过 xx 天 | `false` | +| showRangePrompt | 范围选择超过最多可选天数时，是否展示提示文案 | _  boolean
_ | true | `false` | +| defaultDate | 默认选中的日期，type 为 multiple 或 range 时为数组 | _  string ¦ string[]
_ | 今天 | `false` | +| allowSameDay | 是否允许日期范围的起止时间为同一天 | _  boolean
_ | false | `false` | +| confirmDisabledText | 确认按钮处于禁用状态时的文字 | _  string
_ | 确定 | `false` | +| type | 类型 | _  "single" ¦ "multiple" ¦ "range"
_ | - | `false` | +| minDate | 可选择的最小日期 | _  number
_ | 当前日期 | `false` | +| maxDate | 可选择的最大日期 | _  number
_ | 当前日期六个月后 | `false` | +| position | 弹窗弹出的位置 | _  "left" ¦ "right" ¦ "bottom" ¦ "top"
_ | bottom | `false` | +| rowHeight | 日期行高 | _  number ¦ string
_ | 64 | `false` | +| round | 弹窗是否圆角 | _  boolean
_ | true | `false` | +| poppable | 是否以弹层的形式展示日历 | _  boolean
_ | true | `false` | +| showMark | 是否显示月份背景水印 | _  boolean
_ | true | `false` | +| showTitle | 是否展示日历标题 | _  boolean
_ | true | `false` | +| showConfirm | 是否展示确认按钮 | _  boolean
_ | true | `false` | +| showSubtitle | 是否展示日历副标题（年月） | _  boolean
_ | true | `false` | +| safeAreaInsetBottom | 是否开启底部安全区适配 | _  boolean
_ | true | `false` | +| closeOnClickOverlay | 是否在点击遮罩层后关闭 | _  boolean
_ | true | `false` | +| maxRange | 日期区间最多可选天数，默认无限制 | _  number
_ | - | `false` | +| firstDayOfWeek | 设置周起始日 | _  0 ¦ 1 ¦ 2 ¦ 3 ¦ 4 ¦ 5 ¦ 6
_ | 0 | `false` | +| onOpen | - | _  () => void
_ | - | `false` | +| onClose | - | _  () => void
_ | - | `false` | +| onOpened | - | _  () => void
_ | - | `false` | +| onClosed | - | _  () => void
_ | - | `false` | +| onConfirm | - | _  (e: CalendarEvents) => void
_ | - | `false` | +| overRange | - | _  () => void
_ | - | `false` | +| onUnselect | - | _  (e: CalendarEventsSingle) => void
_ | - | `false` | +| onSelect | - | _  (e: CalendarEvents) => void
_ | - | `false` | +| onClickSubtitle | - | _  (a?: any) => void
_ | - | `false` | +| renderTitle | 自定义标题 | _  React.ReactNode
_ | - | `false` | +| renderFooter | 自定义底部区域内容 | _  React.ReactNode
_ | - | `false` | + +### formatter 回调参数 Day [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) + +| 参数 | 说明 | 类型 | +| ---------- | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| date | - | _  attr:
    ¦ "selected"
    ¦ "start"
    ¦ "middle"
    ¦ "end"
    ¦ "disabled"
_ | +| type | - | _  string
_ | +| text | - | _  string ¦ number
_ | +| bottomInfo | - | _  string
_ | +| className | - | _  string
_ | +| topInfo | - | _  string
_ | + +### ICalendarInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) + +使用 ref 获取到的组件实例 | 方法 | 说明 | 类型 | | --- | --- | --- | | reset | - | _  (date?: Date ¦ Date[]) => void
  //
_ | | scrollToDate | - | _  (date: Date) => void
_ | -### CalendarEvents [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) -onConfirm和onSelect的回调函数参数 +### CalendarEvents [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) + +onConfirm 和 onSelect 的回调函数参数 | 参数 | 说明 | 类型 | | --- | --- | --- | | detail | - | _  {
    value: Date ¦ Date[]
  }
_ | -### CalendarEvents [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) -onUnselect的回调函数参数 +### CalendarEvents [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/calendar.d.ts) + +onUnselect 的回调函数参数 | 参数 | 说明 | 类型 | | --- | --- | --- | | detail | - | _  {
    value: Date
  }
_ | - diff --git a/packages/vantui-doc/src/card/README.md b/packages/vantui-doc/src/card/README.md index 6164df96f..9957a40b3 100644 --- a/packages/vantui-doc/src/card/README.md +++ b/packages/vantui-doc/src/card/README.md @@ -54,31 +54,31 @@ function Demo() { ) } ``` -### CardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/card.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| tag | - | _  string
_ | - | `false` | -| num | - | _  string
_ | - | `false` | -| desc | - | _  string
_ | - | `false` | -| thumb | - | _  string
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| price | - | _  string
_ | - | `true` | -| centered | - | _  boolean
_ | - | `false` | -| lazyLoad | - | _  boolean
_ | - | `false` | -| thumbLink | - | _  string
_ | - | `false` | -| originPrice | - | _  string
_ | - | `false` | -| thumbMode | - | _  keyof ImageProps.mode
_ | - | `false` | -| currency | - | _  string
_ | - | `false` | -| renderFooter | - | _  ReactNode
_ | - | `false` | -| renderBottom | - | _  ReactNode
_ | - | `false` | -| renderNum | - | _  ReactNode
_ | - | `false` | -| renderOriginPrice | - | _  ReactNode
_ | - | `false` | -| renderPrice | - | _  ReactNode
_ | - | `false` | -| renderPriceTop | - | _  ReactNode
_ | - | `false` | -| renderTags | - | _  ReactNode
_ | - | `false` | -| renderDesc | - | _  ReactNode
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderTag | - | _  ReactNode
_ | - | `false` | -| renderThumb | - | _  ReactNode
_ | - | `false` | +### CardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/card.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ---- | --------------------------------------------- | ------ | ------- | +| tag | - | _  string
_ | - | `false` | +| num | - | _  string
_ | - | `false` | +| desc | - | _  string
_ | - | `false` | +| thumb | - | _  string
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| price | - | _  string
_ | - | `true` | +| centered | - | _  boolean
_ | - | `false` | +| lazyLoad | - | _  boolean
_ | - | `false` | +| thumbLink | - | _  string
_ | - | `false` | +| originPrice | - | _  string
_ | - | `false` | +| thumbMode | - | _  keyof ImageProps.mode
_ | - | `false` | +| currency | - | _  string
_ | - | `false` | +| renderFooter | - | _  ReactNode
_ | - | `false` | +| renderBottom | - | _  ReactNode
_ | - | `false` | +| renderNum | - | _  ReactNode
_ | - | `false` | +| renderOriginPrice | - | _  ReactNode
_ | - | `false` | +| renderPrice | - | _  ReactNode
_ | - | `false` | +| renderPriceTop | - | _  ReactNode
_ | - | `false` | +| renderTags | - | _  ReactNode
_ | - | `false` | +| renderDesc | - | _  ReactNode
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderTag | - | _  ReactNode
_ | - | `false` | +| renderThumb | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/cell/README.md b/packages/vantui-doc/src/cell/README.md index a75144b73..c91fac182 100644 --- a/packages/vantui-doc/src/cell/README.md +++ b/packages/vantui-doc/src/cell/README.md @@ -173,39 +173,39 @@ function Demo() { ) } ``` -### CellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| url | 点击后跳转的链接地址 | _  string
_ | - | `false` | -| linkType | 点击后跳转的链接地址 | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | navigateTo | `false` | -| title | 左侧标题 | _  string ¦ number
_ | - | `false` | -| value | 右侧内容 | _  string ¦ number
_ | - | `false` | -| icon | 标题下方的描述信息 | _  string
_ | - | `false` | -| size | 单元格大小，可选值为 large | _  "large"
_ | - | `false` | -| label | 标题下方的描述信息 | _  string
_ | - | `false` | -| center | 是否使内容垂直居中 | _  boolean
_ | - | `false` | -| isLink | 是否展示右侧箭头并开启点击反馈 | _  boolean
_ | - | `false` | -| required | 是否显示表单必填星号 | _  boolean
_ | false | `false` | -| clickable | 是否开启点击反馈 | _  boolean
_ | false | `false` | -| titleWidth | 标题宽度，须包含单位 | _  string
_ | - | `false` | -| style | - | _  string
_ | - | `false` | -| arrowDirection | 箭头方向 | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | -| border | 是否显示下边框 | _  boolean
_ | - | `false` | -| titleStyle | 标题样式 | _  string
_ | - | `false` | -| renderTitle | 自定义渲染标题 | _  ReactNode
_ | - | `false` | -| renderIcon | 自定义渲染左侧icon | _  ReactNode
_ | - | `false` | -| renderLabel | 自定义label显示内容 | _  ReactNode
_ | - | `false` | -| renderRightIcon | 自定义icon显示内容 | _  ReactNode
_ | - | `false` | -| renderExtra | 自定义右边内容后跟随的内容 | _  ReactNode
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | - -### CellGroup Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| title | 标题 | _  string
_ | - | `false` | -| border | 是否显示外边框 | _  boolean
_ | true | `false` | -| inset | 是否展示为圆角卡片风格 | _  boolean
_ | false | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### CellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ------------------------------ | --------------------------------------------------------------------------------------------- | ---------- | ------- | +| url | 点击后跳转的链接地址 | _  string
_ | - | `false` | +| linkType | 点击后跳转的链接地址 | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | navigateTo | `false` | +| title | 左侧标题 | _  string ¦ number
_ | - | `false` | +| value | 右侧内容 | _  string ¦ number
_ | - | `false` | +| icon | 标题下方的描述信息 | _  string
_ | - | `false` | +| size | 单元格大小，可选值为 large | _  "large"
_ | - | `false` | +| label | 标题下方的描述信息 | _  string
_ | - | `false` | +| center | 是否使内容垂直居中 | _  boolean
_ | - | `false` | +| isLink | 是否展示右侧箭头并开启点击反馈 | _  boolean
_ | - | `false` | +| required | 是否显示表单必填星号 | _  boolean
_ | false | `false` | +| clickable | 是否开启点击反馈 | _  boolean
_ | false | `false` | +| titleWidth | 标题宽度，须包含单位 | _  string
_ | - | `false` | +| style | - | _  string
_ | - | `false` | +| arrowDirection | 箭头方向 | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | +| border | 是否显示下边框 | _  boolean
_ | - | `false` | +| titleStyle | 标题样式 | _  string
_ | - | `false` | +| renderTitle | 自定义渲染标题 | _  ReactNode
_ | - | `false` | +| renderIcon | 自定义渲染左侧 icon | _  ReactNode
_ | - | `false` | +| renderLabel | 自定义 label 显示内容 | _  ReactNode
_ | - | `false` | +| renderRightIcon | 自定义 icon 显示内容 | _  ReactNode
_ | - | `false` | +| renderExtra | 自定义右边内容后跟随的内容 | _  ReactNode
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | + +### CellGroup Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ---------------------- | ---------------------------- | ------ | ------- | +| title | 标题 | _  string
_ | - | `false` | +| border | 是否显示外边框 | _  boolean
_ | true | `false` | +| inset | 是否展示为圆角卡片风格 | _  boolean
_ | false | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/checkbox/README.md b/packages/vantui-doc/src/checkbox/README.md index 35545c221..6a5895cff 100644 --- a/packages/vantui-doc/src/checkbox/README.md +++ b/packages/vantui-doc/src/checkbox/README.md @@ -207,30 +207,30 @@ function Demo() { flex: none !important; } ``` -### CheckboxProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/checkbox.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | - | _  string
_ | - | `false` | -| value | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| checkedColor | - | _  string
_ | - | `false` | -| labelPosition | - | _  string
_ | - | `false` | -| labelDisabled | - | _  boolean
_ | - | `false` | -| shape | - | _  "round" ¦ "square"
_ | - | `false` | -| iconSize | - | _  string ¦ number
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | - -### CheckboxGroupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/checkbox.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| max | - | _  number
_ | - | `false` | -| value | - | _  Array
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| direction | - | _  "horizontal" ¦ "vertical"
_ | - | `false` | -| children | - | _  Array
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | +### CheckboxProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/checkbox.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| name | - | _  string
_ | - | `false` | +| value | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| checkedColor | - | _  string
_ | - | `false` | +| labelPosition | - | _  string
_ | - | `false` | +| labelDisabled | - | _  boolean
_ | - | `false` | +| shape | - | _  "round" ¦ "square"
_ | - | `false` | +| iconSize | - | _  string ¦ number
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | + +### CheckboxGroupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/checkbox.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| max | - | _  number
_ | - | `false` | +| value | - | _  Array
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| direction | - | _  "horizontal" ¦ "vertical"
_ | - | `false` | +| children | - | _  Array
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/circle/README.md b/packages/vantui-doc/src/circle/README.md index 53a085c8f..95ee8eaff 100644 --- a/packages/vantui-doc/src/circle/README.md +++ b/packages/vantui-doc/src/circle/README.md @@ -78,20 +78,20 @@ function Demo() { ) } ``` -### CircleProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/circle.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| text | - | _  string
_ | - | `false` | -| lineCap | - | _  string
_ | - | `false` | -| value | - | _  number
_ | - | `false` | -| speed | - | _  number
_ | - | `false` | -| size | - | _  number
_ | - | `false` | -| fill | - | _  string
_ | - | `false` | -| layerColor | - | _  string
_ | - | `false` | -| color | - | _  string ¦ Record
_ | - | `false` | -| type | - | _  string
_ | - | `false` | -| strokeWidth | - | _  number
_ | - | `false` | -| clockwise | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### CircleProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/circle.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ------------------------------------------------------------------------ | ------ | ------- | +| text | - | _  string
_ | - | `false` | +| lineCap | - | _  string
_ | - | `false` | +| value | - | _  number
_ | - | `false` | +| speed | - | _  number
_ | - | `false` | +| size | - | _  number
_ | - | `false` | +| fill | - | _  string
_ | - | `false` | +| layerColor | - | _  string
_ | - | `false` | +| color | - | _  string ¦ Record
_ | - | `false` | +| type | - | _  string
_ | - | `false` | +| strokeWidth | - | _  number
_ | - | `false` | +| clockwise | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/col/README.md b/packages/vantui-doc/src/col/README.md index 9ed2fe485..01b79ca9f 100644 --- a/packages/vantui-doc/src/col/README.md +++ b/packages/vantui-doc/src/col/README.md @@ -74,19 +74,19 @@ function Demo() { ) } ``` -### ColProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| span | 列元素宽度 | _  number ¦ string
_ | - | `true` | -| offset | 列元素偏移距离 | _  number ¦ string
_ | - | `false` | -| gutter | 列元素之间的间距（单位为 px）, 从Row上获取 | _  number ¦ string
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `true` | +### ColProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) -### Row Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | -------------------------------------------- | --------------------------------------------------- | ------ | ------- | +| span | 列元素宽度 | _  number ¦ string
_ | - | `true` | +| offset | 列元素偏移距离 | _  number ¦ string
_ | - | `false` | +| gutter | 列元素之间的间距（单位为 px）, 从 Row 上获取 | _  number ¦ string
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `true` | -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| gutter | 列元素之间的间距（单位为 px） | _  number ¦ string
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `true` | +### Row Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ----------------------------- | --------------------------------------------------- | ------ | ------- | +| gutter | 列元素之间的间距（单位为 px） | _  number ¦ string
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `true` | diff --git a/packages/vantui-doc/src/collapse/README.md b/packages/vantui-doc/src/collapse/README.md index 1fe73c314..2fbaf631c 100644 --- a/packages/vantui-doc/src/collapse/README.md +++ b/packages/vantui-doc/src/collapse/README.md @@ -123,35 +123,35 @@ function Demo() { ) } ``` -### CollapseProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  Array ¦ string
_ | - | `false` | -| accordion | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| children | - | _  Array
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onOpen | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | - -### CollapseItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | - | _  string ¦ number
_ | - | `false` | -| title | - | _  string ¦ number
_ | - | `false` | -| value | - | _  string ¦ number
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| clickable | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| isLink | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| renderValue | - | _  ReactNode
_ | - | `false` | -| size | - | _  "large"
_ | - | `false` | +### CollapseProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ------------------------------------------------------------------------------------ | ------ | ------- | +| value | - | _  Array ¦ string
_ | - | `false` | +| accordion | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| children | - | _  Array
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onOpen | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | + +### CollapseItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | --------------------------------------------------- | ------ | ------- | +| name | - | _  string ¦ number
_ | - | `false` | +| title | - | _  string ¦ number
_ | - | `false` | +| value | - | _  string ¦ number
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| clickable | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| isLink | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| renderValue | - | _  ReactNode
_ | - | `false` | +| size | - | _  "large"
_ | - | `false` | diff --git a/packages/vantui-doc/src/config-provider/README.md b/packages/vantui-doc/src/config-provider/README.md index 59730e870..00eee874e 100644 --- a/packages/vantui-doc/src/config-provider/README.md +++ b/packages/vantui-doc/src/config-provider/README.md @@ -125,10 +125,10 @@ function Demo() { ) } ``` -### ConfigProviderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/config-provider.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| themeVars | 自定义主题变量 | _  Normal.IAnyObject
_ | - | `true` | -| children | - | _  ReactNode
_ | - | `true` | +### ConfigProviderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/config-provider.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | -------------- | ------------------------------------ | ------ | ------ | +| themeVars | 自定义主题变量 | _  Normal.IAnyObject
_ | - | `true` | +| children | - | _  ReactNode
_ | - | `true` | diff --git a/packages/vantui-doc/src/count-down/README.md b/packages/vantui-doc/src/count-down/README.md index 55265f9f0..4f7607e01 100644 --- a/packages/vantui-doc/src/count-down/README.md +++ b/packages/vantui-doc/src/count-down/README.md @@ -116,34 +116,34 @@ function Demo() { ) } ``` -### ICountDownRef [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| start | - | _  () => void
_ | -| pause | - | _  () => void
_ | -| reset | - | _  () => void
_ | - -### ITimeData [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| days | - | _  number
_ | -| hours | - | _  number
_ | -| minutes | - | _  number
_ | -| seconds | - | _  number
_ | -| milliseconds | - | _  number
_ | - -### CountDownProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| millisecond | - | _  boolean
_ | - | `false` | -| time | - | _  number
_ | - | `false` | -| format | - | _  string
_ | - | `false` | -| autoStart | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (timeData: {
    detail: ITimeData
  }) => void
_ | - | `false` | -| onFinish | - | _  () => void
_ | - | `false` | -| ref | - | _  React.MutableRefObject<
    ICountDownRef ¦ undefined
  >
_ | - | `false` | +### ICountDownRef [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) + +| 参数 | 说明 | 类型 | +| ----- | ---- | --------------------------------------- | +| start | - | _  () => void
_ | +| pause | - | _  () => void
_ | +| reset | - | _  () => void
_ | + +### ITimeData [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) + +| 参数 | 说明 | 类型 | +| ------------ | ---- | ------------------------- | +| days | - | _  number
_ | +| hours | - | _  number
_ | +| minutes | - | _  number
_ | +| seconds | - | _  number
_ | +| milliseconds | - | _  number
_ | + +### CountDownProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| millisecond | - | _  boolean
_ | - | `false` | +| time | - | _  number
_ | - | `false` | +| format | - | _  string
_ | - | `false` | +| autoStart | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (timeData: {
    detail: ITimeData
  }) => void
_ | - | `false` | +| onFinish | - | _  () => void
_ | - | `false` | +| ref | - | _  React.MutableRefObject<
    ICountDownRef ¦ undefined
  >
_ | - | `false` | diff --git a/packages/vantui-doc/src/datetime-picker/README.md b/packages/vantui-doc/src/datetime-picker/README.md index 3c92e0f6a..5ffb6ff4f 100644 --- a/packages/vantui-doc/src/datetime-picker/README.md +++ b/packages/vantui-doc/src/datetime-picker/README.md @@ -198,45 +198,46 @@ function Demo() { ) } ``` -### DatetimePickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | 选项的值 | _  string ¦ number
_ | null | `false` | -| filter | 对选项数组进行过滤，实现自定义时间间隔 | _  (
    type: string,
    values: (string ¦ number)[]
  ) => (number ¦ string)[]
_ | - | `false` | -| type | 时间类型，不建议动态修改 | _  attr:
    ¦ "datetime"
    ¦ "date"
    ¦ "year-month"
    ¦ "time"
_ | datetime | `false` | -| showToolbar | 是否显示顶部栏 | _  boolean
_ | true | `false` | -| formatter | 选项格式化函数 | _  (
    type: string,
    value: string ¦ number
  ) => number ¦ string
_ | - | `false` | -| minDate | 可选的最小时间，精确到分钟 | _  number ¦ string
_ | 十年前 | `false` | -| maxDate | 可选的最大时间，精确到分钟 | _  number ¦ string
_ | 十年后 | `false` | -| minHour | 可选的最小小时，针对type=time | _  number ¦ string
_ | 0 | `false` | -| maxHour | 可选的最大小时，针对type=time | _  number ¦ string
_ | 23 | `false` | -| minMinute | 可选的最小分钟，针对type=time | _  number ¦ string
_ | 0 | `false` | -| maxMinute | 可选的最大分钟，针对type=time | _  number ¦ string
_ | 59 | `false` | -| onInput | 当值变化时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | -| onChange | 当值变化时触发的事件 | _  (
    e: DatetimePickerEventsByInstance
  ) => void
_ | - | `false` | -| onConfirm | 点击完成按钮时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | -| onCancel | 点击取消按钮时触发的事件 | _  () => void
_ | - | `false` | - -### onInput、onConfirm的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) -继承了@taro/components的ITouchEvent + +### DatetimePickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | +| value | 选项的值 | _  string ¦ number
_ | null | `false` | +| filter | 对选项数组进行过滤，实现自定义时间间隔 | _  (
    type: string,
    values: (string ¦ number)[]
  ) => (number ¦ string)[]
_ | - | `false` | +| type | 时间类型，不建议动态修改 | _  attr:
    ¦ "datetime"
    ¦ "date"
    ¦ "year-month"
    ¦ "time"
_ | datetime | `false` | +| showToolbar | 是否显示顶部栏 | _  boolean
_ | true | `false` | +| formatter | 选项格式化函数 | _  (
    type: string,
    value: string ¦ number
  ) => number ¦ string
_ | - | `false` | +| minDate | 可选的最小时间，精确到分钟 | _  number ¦ string
_ | 十年前 | `false` | +| maxDate | 可选的最大时间，精确到分钟 | _  number ¦ string
_ | 十年后 | `false` | +| minHour | 可选的最小小时，针对 type=time | _  number ¦ string
_ | 0 | `false` | +| maxHour | 可选的最大小时，针对 type=time | _  number ¦ string
_ | 23 | `false` | +| minMinute | 可选的最小分钟，针对 type=time | _  number ¦ string
_ | 0 | `false` | +| maxMinute | 可选的最大分钟，针对 type=time | _  number ¦ string
_ | 59 | `false` | +| onInput | 当值变化时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | +| onChange | 当值变化时触发的事件 | _  (
    e: DatetimePickerEventsByInstance
  ) => void
_ | - | `false` | +| onConfirm | 点击完成按钮时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | +| onCancel | 点击取消按钮时触发的事件 | _  () => void
_ | - | `false` | + +### onInput、onConfirm 的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) + +继承了@taro/components 的 ITouchEvent | 参数 | 说明 | 类型 | | --- | --- | --- | | detail | 选项的值 | _  {
    value?: string ¦ number
  }
_ | -### onChange的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) - -| 方法 | 说明 | 类型 | -| --- | --- | --- | -| detail | 包含每项的值columns、当前时间innerValue、手动设置列数据setColumns、更新某列值updateColumnValue | _  {
    datetimePicker: {
      columns: (string ¦ number)[]
      setColumns: (
        columns: (string ¦ number)[]
      ) => void
      innerValue: Date
      updateColumnValue: (
        value: string
      ) => Promise
    }
  }
_ | +### onChange 的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) -### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) +| 方法 | 说明 | 类型 | +| ------ | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| detail | 包含每项的值 columns、当前时间 innerValue、手动设置列数据 setColumns、更新某列值 updateColumnValue | _  {
    datetimePicker: {
      columns: (string ¦ number)[]
      setColumns: (
        columns: (string ¦ number)[]
      ) => void
      innerValue: Date
      updateColumnValue: (
        value: string
      ) => Promise
    }
  }
_ | -| 方法 | 说明 | 类型 | -| --- | --- | --- | -| columns | - | _  (string ¦ number)[]
_ | -| setColumns | - | _  (columns: (string ¦ number)[]) => void
_ | -| innerValue | - | _  Date
_ | -| updateColumnValue | - | _  (value: string) => Promise
_ | -| pickerInstance | - | _  IPickerInstance
_ | +### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) +| 方法 | 说明 | 类型 | +| ----------------- | ---- | ----------------------------------------------------------------------------------------- | +| columns | - | _  (string ¦ number)[]
_ | +| setColumns | - | _  (columns: (string ¦ number)[]) => void
_ | +| innerValue | - | _  Date
_ | +| updateColumnValue | - | _  (value: string) => Promise
_ | +| pickerInstance | - | _  IPickerInstance
_ | diff --git a/packages/vantui-doc/src/dialog/README.md b/packages/vantui-doc/src/dialog/README.md index 4152d7973..4267bd4bb 100644 --- a/packages/vantui-doc/src/dialog/README.md +++ b/packages/vantui-doc/src/dialog/README.md @@ -158,35 +158,35 @@ function Demo() { ) } ``` -### DialogProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dialog.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| show | - | _  boolean
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| width | - | _  string ¦ number
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| theme | - | _  "round-button"
_ | - | `false` | -| cancelButtonColor | - | _  string
_ | - | `false` | -| confirmButtonColor | - | _  string
_ | - | `false` | -| onConfirm | - | _  (event: {
    detail: {
      action: string
      dialog?: { dialog: any }
    }
  }) => void
_ | - | `false` | -| onCancel | - | _  (event: {
    detail: {
      action: string
      dialog?: { dialog: any }
    }
  }) => void
_ | - | `false` | -| onClose | - | _  (event: { detail: string }) => void
_ | - | `false` | -| message | - | _  string
_ | - | `false` | -| overlay | - | _  boolean
_ | - | `false` | -| selector | - | _  string
_ | - | `false` | -| ariaLabel | - | _  string
_ | - | `false` | -| className | - | _  string
_ | - | `false` | -| style | - | _  string
_ | - | `false` | -| transition | - | _  "fade" ¦ "none"
_ | - | `false` | -| asyncClose | - | _  boolean
_ | - | `false` | -| beforeClose | - | _  (
    action: string
  ) => Promise ¦ void ¦ boolean
_ | - | `false` | -| messageAlign | - | _  "left" ¦ "right"
_ | - | `false` | -| confirmButtonText | - | _  string
_ | - | `false` | -| cancelButtonText | - | _  string
_ | - | `false` | -| showConfirmButton | - | _  boolean
_ | - | `false` | -| showCancelButton | - | _  boolean
_ | - | `false` | -| closeOnClickOverlay | - | _  boolean
_ | - | `false` | -| confirmButtonOpenType | - | _  TaroButtonProps.openType
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | +### DialogProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dialog.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| show | - | _  boolean
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| width | - | _  string ¦ number
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| theme | - | _  "round-button"
_ | - | `false` | +| cancelButtonColor | - | _  string
_ | - | `false` | +| confirmButtonColor | - | _  string
_ | - | `false` | +| onConfirm | - | _  (event: {
    detail: {
      action: string
      dialog?: { dialog: any }
    }
  }) => void
_ | - | `false` | +| onCancel | - | _  (event: {
    detail: {
      action: string
      dialog?: { dialog: any }
    }
  }) => void
_ | - | `false` | +| onClose | - | _  (event: { detail: string }) => void
_ | - | `false` | +| message | - | _  string
_ | - | `false` | +| overlay | - | _  boolean
_ | - | `false` | +| selector | - | _  string
_ | - | `false` | +| ariaLabel | - | _  string
_ | - | `false` | +| className | - | _  string
_ | - | `false` | +| style | - | _  string
_ | - | `false` | +| transition | - | _  "fade" ¦ "none"
_ | - | `false` | +| asyncClose | - | _  boolean
_ | - | `false` | +| beforeClose | - | _  (
    action: string
  ) => Promise ¦ void ¦ boolean
_ | - | `false` | +| messageAlign | - | _  "left" ¦ "right"
_ | - | `false` | +| confirmButtonText | - | _  string
_ | - | `false` | +| cancelButtonText | - | _  string
_ | - | `false` | +| showConfirmButton | - | _  boolean
_ | - | `false` | +| showCancelButton | - | _  boolean
_ | - | `false` | +| closeOnClickOverlay | - | _  boolean
_ | - | `false` | +| confirmButtonOpenType | - | _  TaroButtonProps.openType
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/divider/README.md b/packages/vantui-doc/src/divider/README.md index a723e92fc..6eed9ca39 100644 --- a/packages/vantui-doc/src/divider/README.md +++ b/packages/vantui-doc/src/divider/README.md @@ -102,15 +102,15 @@ function Demo() { ) } ``` -### DividerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/divider.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| dashed | - | _  boolean
_ | - | `false` | -| hairline | - | _  boolean
_ | - | `false` | -| contentPosition | - | _  "left" ¦ "center" ¦ "right"
_ | - | `false` | -| fontSize | - | _  string
_ | - | `false` | -| borderColor | - | _  string
_ | - | `false` | -| textColor | - | _  string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### DividerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/divider.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | -------------------------------------------------------------------------------- | ------ | ------- | +| dashed | - | _  boolean
_ | - | `false` | +| hairline | - | _  boolean
_ | - | `false` | +| contentPosition | - | _  "left" ¦ "center" ¦ "right"
_ | - | `false` | +| fontSize | - | _  string
_ | - | `false` | +| borderColor | - | _  string
_ | - | `false` | +| textColor | - | _  string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/dropdown-menu/README.md b/packages/vantui-doc/src/dropdown-menu/README.md index ebd303ce9..13eddf188 100644 --- a/packages/vantui-doc/src/dropdown-menu/README.md +++ b/packages/vantui-doc/src/dropdown-menu/README.md @@ -201,47 +201,48 @@ function Demo() { ) } ``` -### DropdownMenuProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| activeColor | 选中选项后颜色 | _  string
_ | - | `false` | -| overlay | 是否展示蒙层 | _  boolean
_ | - | `false` | -| zIndex | 弹出层zIndex | _  number
_ | - | `false` | -| duration | 弹出层执行时间 | _  number
_ | - | `false` | -| direction | 弹出层执行方向 | _  "down" ¦ "up"
_ | - | `false` | -| closeOnClickOverlay | 点击蒙层是否关闭弹出层 | _  boolean
_ | - | `false` | -| closeOnClickOutside | 是否在点击外部 menu 后关闭菜单 | _  boolean
_ | - | `false` | -| children | 子元素,须为DropdownMenuItem | _  React.ReactNode
_ | - | `true` | - -### DropdownItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | 对应菜单选项的值 | _  string ¦ number
_ | - | `false` | -| title | 未选择时候的按钮标题 | _  string
_ | - | `false` | -| disabled | 是否禁用 | _  boolean
_ | - | `false` | -| titleClass | 标题元素的class | _  string
_ | - | `false` | -| options | 所有选项 | _  Array
_ | - | `true` | -| popupStyle | 弹出层的样式 | _  React.CSSProperties
_ | - | `false` | -| onOpen | 展开下拉项触发 | _  () => void
_ | - | `false` | -| onOpened | 展开下拉项完成时触发 | _  () => void
_ | - | `false` | -| onClose | 关闭下拉项触发 | _  () => void
_ | - | `false` | -| onClosed | 展开下拉项完成触发 | _  () => void
_ | - | `false` | -| onChange | 点击选项触发 | _  (value?: number ¦ string) => void
_ | - | `false` | -| children | 传入的子元素 | _  React.ReactNode ¦ React.ReactNode[]
_ | - | `false` | - -### 菜单下拉选项DropdownMenuOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| text | 展示的label | _  string
_ | -| value | 对应的数值 | _  number ¦ string
_ | -| icon | 前缀图标 | _  string
_ | -### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) -通过ref获取到的方法如下 +### DropdownMenuProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ------------------------------ | ------------------------------------------------- | ------ | ------- | +| activeColor | 选中选项后颜色 | _  string
_ | - | `false` | +| overlay | 是否展示蒙层 | _  boolean
_ | - | `false` | +| zIndex | 弹出层 zIndex | _  number
_ | - | `false` | +| duration | 弹出层执行时间 | _  number
_ | - | `false` | +| direction | 弹出层执行方向 | _  "down" ¦ "up"
_ | - | `false` | +| closeOnClickOverlay | 点击蒙层是否关闭弹出层 | _  boolean
_ | - | `false` | +| closeOnClickOutside | 是否在点击外部 menu 后关闭菜单 | _  boolean
_ | - | `false` | +| children | 子元素,须为 DropdownMenuItem | _  React.ReactNode
_ | - | `true` | + +### DropdownItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | -------------------- | ------------------------------------------------------------------------------------ | ------ | ------- | +| value | 对应菜单选项的值 | _  string ¦ number
_ | - | `false` | +| title | 未选择时候的按钮标题 | _  string
_ | - | `false` | +| disabled | 是否禁用 | _  boolean
_ | - | `false` | +| titleClass | 标题元素的 class | _  string
_ | - | `false` | +| options | 所有选项 | _  Array
_ | - | `true` | +| popupStyle | 弹出层的样式 | _  React.CSSProperties
_ | - | `false` | +| onOpen | 展开下拉项触发 | _  () => void
_ | - | `false` | +| onOpened | 展开下拉项完成时触发 | _  () => void
_ | - | `false` | +| onClose | 关闭下拉项触发 | _  () => void
_ | - | `false` | +| onClosed | 展开下拉项完成触发 | _  () => void
_ | - | `false` | +| onChange | 点击选项触发 | _  (value?: number ¦ string) => void
_ | - | `false` | +| children | 传入的子元素 | _  React.ReactNode ¦ React.ReactNode[]
_ | - | `false` | + +### 菜单下拉选项 DropdownMenuOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +| 参数 | 说明 | 类型 | +| ----- | ------------ | --------------------------------------------------- | +| text | 展示的 label | _  string
_ | +| value | 对应的数值 | _  number ¦ string
_ | +| icon | 前缀图标 | _  string
_ | + +### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +通过 ref 获取到的方法如下 | 方法 | 说明 | 类型 | | --- | --- | --- | -| toggle | 控制展开/收起菜单栏，传入参数show是否展开，options.immediate是否不需要动画 | _  (
    show?: boolean,
    options?: { immediate: boolean }
  ) => void
_ | - +| toggle | 控制展开/收起菜单栏，传入参数 show 是否展开，options.immediate 是否不需要动画 | _  (
    show?: boolean,
    options?: { immediate: boolean }
  ) => void
_ | diff --git a/packages/vantui-doc/src/empty/README.md b/packages/vantui-doc/src/empty/README.md index f654e8e2a..d566ecd7a 100644 --- a/packages/vantui-doc/src/empty/README.md +++ b/packages/vantui-doc/src/empty/README.md @@ -80,13 +80,13 @@ function Demo() { ) } ``` -### EmptyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/empty.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| description | - | _  string
_ | - | `false` | -| image | - | _  attr:
    ¦ "error"
    ¦ "search"
    ¦ "default"
    ¦ "network"
    ¦ string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderImage | - | _  ReactNode
_ | - | `false` | -| renderDescription | - | _  ReactNode
_ | - | `false` | +### EmptyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/empty.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| description | - | _  string
_ | - | `false` | +| image | - | _  attr:
    ¦ "error"
    ¦ "search"
    ¦ "default"
    ¦ "network"
    ¦ string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderImage | - | _  ReactNode
_ | - | `false` | +| renderDescription | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/field/README.md b/packages/vantui-doc/src/field/README.md index bb9013898..d020fa697 100644 --- a/packages/vantui-doc/src/field/README.md +++ b/packages/vantui-doc/src/field/README.md @@ -193,71 +193,71 @@ function Demo() { 这是微信小程序的 input 组件本身的问题，如果需要兼容手写输入法的场景，可以在 `blur` 事件中取到输入的值。 相关的讨论可以查看[微信开放社区](https://developers.weixin.qq.com/community/search?query=input%20%E6%89%8B%E5%86%99%E8%BE%93%E5%85%A5&page=1&block=1&random=1567079239098)。 -### FieldProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/field.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  string ¦ number
_ | - | `false` | -| placeholder | - | _  string
_ | - | `false` | -| placeholderStyle | - | _  string
_ | - | `false` | -| placeholderClass | - | _  string
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| maxlength | - | _  number
_ | - | `false` | -| cursorSpacing | - | _  number
_ | - | `false` | -| autoFocus | - | _  boolean
_ | - | `false` | -| focus | - | _  boolean
_ | - | `false` | -| cursor | - | _  number
_ | - | `false` | -| selectionStart | - | _  number
_ | - | `false` | -| selectionEnd | - | _  number
_ | - | `false` | -| adjustPosition | - | _  boolean
_ | - | `false` | -| holdKeyboard | - | _  boolean
_ | - | `false` | -| type | - | _  attr:
    ¦ "number"
    ¦ "text"
    ¦ "idcard"
    ¦ "digit"
    ¦ "textarea"
    ¦ "password"
_ | - | `false` | -| password | - | _  boolean
_ | - | `false` | -| confirmType | - | _  attr:
    ¦ "send"
    ¦ "search"
    ¦ "next"
    ¦ "go"
    ¦ "done"
_ | - | `false` | -| confirmHold | - | _  boolean
_ | - | `false` | -| autoHeight | - | _  boolean
_ | - | `false` | -| fixed | - | _  boolean
_ | - | `false` | -| showConfirmBar | - | _  boolean
_ | - | `false` | -| disableDefaultPadding | - | _  boolean
_ | - | `false` | -| size | - | _  "large"
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| error | - | _  boolean
_ | - | `false` | -| center | - | _  boolean
_ | - | `false` | -| isLink | - | _  boolean
_ | - | `false` | -| leftIcon | - | _  string
_ | - | `false` | -| rightIcon | - | _  string
_ | - | `false` | -| autosize | - | _  boolean ¦ Normal.IAnyObject
_ | - | `false` | -| required | - | _  boolean
_ | - | `false` | -| iconClass | - | _  string
_ | - | `false` | -| clickable | - | _  boolean
_ | - | `false` | -| inputAlign | - | _  string
_ | - | `false` | -| style | - | _  string
_ | - | `false` | -| errorMessage | - | _  string
_ | - | `false` | -| arrowDirection | - | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | -| showWordLimit | - | _  boolean
_ | - | `false` | -| errorMessageAlign | - | _  string
_ | - | `false` | -| alwaysEmbed | - | _  boolean
_ | - | `false` | -| readonly | - | _  boolean
_ | - | `false` | -| clearable | - | _  boolean
_ | - | `false` | -| clearTrigger | - | _  string
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| titleWidth | - | _  string
_ | - | `false` | -| clearIcon | - | _  string
_ | - | `false` | -| renderLeftIcon | - | _  ReactNode
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderInput | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| renderButton | - | _  ReactNode
_ | - | `false` | -| onInput | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onConfirm | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClickIcon | - | _  () => void
_ | - | `false` | -| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClear | - | _  () => void
_ | - | `false` | -| onClickInput | - | _  () => void
_ | - | `false` | -| onLineChange | - | _  CommonEventFunction
_ | - | `false` | -| onKeyboardHeightChange | - | _  CommonEventFunction
_ | - | `false` | +### FieldProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/field.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| value | - | _  string ¦ number
_ | - | `false` | +| placeholder | - | _  string
_ | - | `false` | +| placeholderStyle | - | _  string
_ | - | `false` | +| placeholderClass | - | _  string
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| maxlength | - | _  number
_ | - | `false` | +| cursorSpacing | - | _  number
_ | - | `false` | +| autoFocus | - | _  boolean
_ | - | `false` | +| focus | - | _  boolean
_ | - | `false` | +| cursor | - | _  number
_ | - | `false` | +| selectionStart | - | _  number
_ | - | `false` | +| selectionEnd | - | _  number
_ | - | `false` | +| adjustPosition | - | _  boolean
_ | - | `false` | +| holdKeyboard | - | _  boolean
_ | - | `false` | +| type | - | _  attr:
    ¦ "number"
    ¦ "text"
    ¦ "idcard"
    ¦ "digit"
    ¦ "textarea"
    ¦ "password"
_ | - | `false` | +| password | - | _  boolean
_ | - | `false` | +| confirmType | - | _  attr:
    ¦ "send"
    ¦ "search"
    ¦ "next"
    ¦ "go"
    ¦ "done"
_ | - | `false` | +| confirmHold | - | _  boolean
_ | - | `false` | +| autoHeight | - | _  boolean
_ | - | `false` | +| fixed | - | _  boolean
_ | - | `false` | +| showConfirmBar | - | _  boolean
_ | - | `false` | +| disableDefaultPadding | - | _  boolean
_ | - | `false` | +| size | - | _  "large"
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| error | - | _  boolean
_ | - | `false` | +| center | - | _  boolean
_ | - | `false` | +| isLink | - | _  boolean
_ | - | `false` | +| leftIcon | - | _  string
_ | - | `false` | +| rightIcon | - | _  string
_ | - | `false` | +| autosize | - | _  boolean ¦ Normal.IAnyObject
_ | - | `false` | +| required | - | _  boolean
_ | - | `false` | +| iconClass | - | _  string
_ | - | `false` | +| clickable | - | _  boolean
_ | - | `false` | +| inputAlign | - | _  string
_ | - | `false` | +| style | - | _  string
_ | - | `false` | +| errorMessage | - | _  string
_ | - | `false` | +| arrowDirection | - | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | +| showWordLimit | - | _  boolean
_ | - | `false` | +| errorMessageAlign | - | _  string
_ | - | `false` | +| alwaysEmbed | - | _  boolean
_ | - | `false` | +| readonly | - | _  boolean
_ | - | `false` | +| clearable | - | _  boolean
_ | - | `false` | +| clearTrigger | - | _  string
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| titleWidth | - | _  string
_ | - | `false` | +| clearIcon | - | _  string
_ | - | `false` | +| renderLeftIcon | - | _  ReactNode
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderInput | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| renderButton | - | _  ReactNode
_ | - | `false` | +| onInput | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onConfirm | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClickIcon | - | _  () => void
_ | - | `false` | +| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClear | - | _  () => void
_ | - | `false` | +| onClickInput | - | _  () => void
_ | - | `false` | +| onLineChange | - | _  CommonEventFunction
_ | - | `false` | +| onKeyboardHeightChange | - | _  CommonEventFunction
_ | - | `false` | diff --git a/packages/vantui-doc/src/form/README.md b/packages/vantui-doc/src/form/README.md index 53973f498..852336241 100644 --- a/packages/vantui-doc/src/form/README.md +++ b/packages/vantui-doc/src/form/README.md @@ -302,41 +302,43 @@ function DatetimePickerBox_(props) { ) } ``` -### FormProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| form | 传入form实例（const formStore1 = useRef()） | _  IFormInstanceAPI
_ | - | `false` | -| initialValues | 初始化表单仓库值 | _  Record
_ | - | `false` | -| children | 第一级必须是FormItem组件 | _  ReactNode
_ | - | `true` | -| className | 类名 | _  string
_ | - | `false` | -| onFinish | 表单提交触发，配合button.formType = submit | _  () => void
_ | - | `false` | -| onFinishFailed | 表单提交失败触发 | _  () => void
_ | - | `false` | - -### FormItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | 对应表单字段名 | _  string
_ | - | `true` | -| children | 第一级操作表单组件 | _  ReactNode
_ | - | `true` | -| label | 表单label | _  ReactNode
_ | - | `true` | -| layout | 垂直 ｜ 水平 | _  "vertical" ¦ "horizontal"
_ | horizontal | `false` | -| required | 是否必填 | _  boolean
_ | false | `false` | -| validateTrigger | 验证表单触发方法名 | _  string
_ | onChange | `false` | -| labelClassName | label的外层className | _  string
_ | - | `false` | -| requiredClassName | required的外层className | _  string
_ | - | `false` | -| controllClassName | 表单组件的外层className | _  string
_ | - | `false` | -| className | formItem最外层className | _  string
_ | - | `false` | -| requiredIcon | 自定义必填标识 | _  ReactNode
_ | - | `false` | -| feedback | 验证后反馈的信息，可设置为校验成功、失败、都展示或隐藏 | _  "success" ¦ "failed" ¦ "all" ¦ "hidden"
_ | failed | `false` | -| renderRight | 自定义渲染右边内容 | _  ReactNode
_ | - | `false` | -| trigger | 表单交互触发方法 | _  string
_ | onChange | `false` | -| valueKey | 表单控制展示的具体值的字段名 | _  string
_ | value | `false` | -| valueFormat | 根据表单交互回掉函数（时间）参数的重新定义 | _  (
    value: any,
    name: string,
    IFormInstance: IFormInstanceAPI
  ) => any
_ | value | `false` | -| rules | 正则校验值，或者自定义校验后call回掉函数返回错误信息 | _  {
    rule:
      ¦ ((
          value: any,
          call: (errMess: string) => void
        ) => void)
      ¦ RegExp
    message?: string
  }
_ | - | `false` | - -### IFormInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) -通过ref获取到的form的实例 + +### FormProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------------- | --------------------------------------------- | ------------------------------------------- | ------ | ------- | +| form | 传入 form 实例（const formStore1 = useRef()） | _  IFormInstanceAPI
_ | - | `false` | +| initialValues | 初始化表单仓库值 | _  Record
_ | - | `false` | +| children | 第一级必须是 FormItem 组件 | _  ReactNode
_ | - | `true` | +| className | 类名 | _  string
_ | - | `false` | +| onFinish | 表单提交触发，配合 button.formType = submit | _  () => void
_ | - | `false` | +| onFinishFailed | 表单提交失败触发 | _  () => void
_ | - | `false` | + +### FormItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | ------- | +| name | 对应表单字段名 | _  string
_ | - | `true` | +| children | 第一级操作表单组件 | _  ReactNode
_ | - | `true` | +| label | 表单 label | _  ReactNode
_ | - | `true` | +| layout | 垂直 ｜ 水平 | _  "vertical" ¦ "horizontal"
_ | horizontal | `false` | +| required | 是否必填 | _  boolean
_ | false | `false` | +| validateTrigger | 验证表单触发方法名 | _  string
_ | onChange | `false` | +| labelClassName | label 的外层 className | _  string
_ | - | `false` | +| requiredClassName | required 的外层 className | _  string
_ | - | `false` | +| controllClassName | 表单组件的外层 className | _  string
_ | - | `false` | +| className | formItem 最外层 className | _  string
_ | - | `false` | +| requiredIcon | 自定义必填标识 | _  ReactNode
_ | - | `false` | +| feedback | 验证后反馈的信息，可设置为校验成功、失败、都展示或隐藏 | _  "success" ¦ "failed" ¦ "all" ¦ "hidden"
_ | failed | `false` | +| renderRight | 自定义渲染右边内容 | _  ReactNode
_ | - | `false` | +| trigger | 表单交互触发方法 | _  string
_ | onChange | `false` | +| valueKey | 表单控制展示的具体值的字段名 | _  string
_ | value | `false` | +| valueFormat | 根据表单交互回掉函数（时间）参数的重新定义 | _  (
    value: any,
    name: string,
    IFormInstance: IFormInstanceAPI
  ) => any
_ | value | `false` | +| rules | 正则校验值，或者自定义校验后 call 回掉函数返回错误信息 | _  {
    rule:
      ¦ ((
          value: any,
          call: (errMess: string) => void
        ) => void)
      ¦ RegExp
    message?: string
  }
_ | - | `false` | + +### IFormInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) + +通过 ref 获取到的 form 的实例 | 方法 | 说明 | 类型 | | --- | --- | --- | | registerValidateFields | 注册校验规则 | _  (
    name: string,
    control: Record,
    model: Record
  ) => void
_ | @@ -347,5 +349,4 @@ function DatetimePickerBox_(props) { | getFieldsValue | 获取所有表单值 | _  () => void
_ | | getFieldValue | 获取单个表单值 | _  (name: string) => any
_ | | validateFields | 校验表单，并获取错误信息和所有表单值 | _  (
    callback: (
      errorMess: Array,
      values: Record
    ) => void
  ) => void
_ | -| submit | 校验表单，并获取错误信息和所有表单值，触发form.onFinish和onFinishFailed | _  (
    callback?: (
      errs: Array ¦ null,
      values: Record
    ) => void
  ) => void
_ | - +| submit | 校验表单，并获取错误信息和所有表单值，触发 form.onFinish 和 onFinishFailed | _  (
    callback?: (
      errs: Array ¦ null,
      values: Record
    ) => void
  ) => void
_ | diff --git a/packages/vantui-doc/src/goods-action/README.md b/packages/vantui-doc/src/goods-action/README.md index dfbf868fb..e9881ccb1 100644 --- a/packages/vantui-doc/src/goods-action/README.md +++ b/packages/vantui-doc/src/goods-action/README.md @@ -92,10 +92,10 @@ function Demo() { ) } ``` -### GoodsActionProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/goods-action.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `true` | +### GoodsActionProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/goods-action.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ---------------------------- | ------ | ------- | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `true` | diff --git a/packages/vantui-doc/src/grid/README.md b/packages/vantui-doc/src/grid/README.md index 7185ebdc0..1fda573b5 100644 --- a/packages/vantui-doc/src/grid/README.md +++ b/packages/vantui-doc/src/grid/README.md @@ -158,33 +158,33 @@ function Demo() { ) } ``` -### GridProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| square | - | _  boolean
_ | - | `false` | -| gutter | - | _  number ¦ string
_ | - | `false` | -| clickable | - | _  boolean
_ | - | `false` | -| columnNum | - | _  number
_ | - | `false` | -| center | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| direction | - | _  string
_ | - | `false` | -| iconSize | - | _  string ¦ number
_ | - | `false` | -| reverse | - | _  boolean
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | - -### GridItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| icon | - | _  string
_ | - | `false` | -| iconColor | - | _  string
_ | - | `false` | -| iconPrefix | - | _  string
_ | - | `false` | -| dot | - | _  boolean
_ | - | `false` | -| info | - | _  string ¦ number ¦ undefined
_ | - | `false` | -| badge | - | _  string ¦ number ¦ undefined
_ | - | `false` | -| text | - | _  string
_ | - | `false` | -| url | - | _  string
_ | - | `false` | -| linkType | - | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | +### GridProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | --------------------------------------------------- | ------ | ------- | +| square | - | _  boolean
_ | - | `false` | +| gutter | - | _  number ¦ string
_ | - | `false` | +| clickable | - | _  boolean
_ | - | `false` | +| columnNum | - | _  number
_ | - | `false` | +| center | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| direction | - | _  string
_ | - | `false` | +| iconSize | - | _  string ¦ number
_ | - | `false` | +| reverse | - | _  boolean
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | + +### GridItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | ---- | --------------------------------------------------------------------------------------------- | ------ | ------- | +| icon | - | _  string
_ | - | `false` | +| iconColor | - | _  string
_ | - | `false` | +| iconPrefix | - | _  string
_ | - | `false` | +| dot | - | _  boolean
_ | - | `false` | +| info | - | _  string ¦ number ¦ undefined
_ | - | `false` | +| badge | - | _  string ¦ number ¦ undefined
_ | - | `false` | +| text | - | _  string
_ | - | `false` | +| url | - | _  string
_ | - | `false` | +| linkType | - | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/icon/README.md b/packages/vantui-doc/src/icon/README.md index ef7cbfc09..028aba17a 100644 --- a/packages/vantui-doc/src/icon/README.md +++ b/packages/vantui-doc/src/icon/README.md @@ -185,15 +185,15 @@ function Demo() { ) } ``` -### IconProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/icon.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| dot | 是否显示图标右上角小红点 | _  boolean
_ | - | `false` | -| info | 图标右上角文字提示 | _  number ¦ string
_ | false | `false` | -| size | 图标大小，如 20px，单位为px | _  number ¦ string
_ | - | `false` | -| color | 图标颜色 | _  string
_ | - | `false` | -| style | 自定义样式 | _  string
_ | - | `false` | -| classPrefix | 类名前缀 | _  string
_ | vant-icon | `false` | -| name | 图标名称或图片链接 | _  string
_ | - | `false` | +### IconProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/icon.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---------------------------- | --------------------------------------------------- | --------- | ------- | +| dot | 是否显示图标右上角小红点 | _  boolean
_ | - | `false` | +| info | 图标右上角文字提示 | _  number ¦ string
_ | false | `false` | +| size | 图标大小，如 20px，单位为 px | _  number ¦ string
_ | - | `false` | +| color | 图标颜色 | _  string
_ | - | `false` | +| style | 自定义样式 | _  string
_ | - | `false` | +| classPrefix | 类名前缀 | _  string
_ | vant-icon | `false` | +| name | 图标名称或图片链接 | _  string
_ | - | `false` | diff --git a/packages/vantui-doc/src/image/README.md b/packages/vantui-doc/src/image/README.md index 3addda484..e8012b7e7 100644 --- a/packages/vantui-doc/src/image/README.md +++ b/packages/vantui-doc/src/image/README.md @@ -185,20 +185,20 @@ function Demo() { ) } ``` -### ImageProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/image.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| src | 图片链接 | _  string
_ | - | `true` | -| round | 是否圆角 | _  boolean
_ | false | `false` | -| width | 宽度，单位为px | _  number ¦ string
_ | - | `false` | -| height | 高度，单位为px | _  number ¦ string
_ | - | `false` | -| radius | 圆角大小 | _  number ¦ string
_ | 0 | `false` | -| lazyLoad | 是否懒加载 | _  boolean
_ | false | `false` | -| showMenuByLongpress | 是否开启长按图片显示识别小程序码菜单 | _  boolean
_ | false | `false` | -| fit | 图片填充模式 | _  attr:
    ¦ "contain"
    ¦ "cover"
    ¦ "fill"
    ¦ "widthFix"
    ¦ "heightFix"
    ¦ "none"
_ | fill | `false` | -| showError | 是否展示图片加载失败提示 | _  boolean
_ | false | `false` | -| showLoading | 是否使用 loading 状态 | _  boolean
_ | true | `false` | -| renderLoading | 渲染loading展示元素 | _  ReactNode
_ | - | `false` | -| renderError | 渲染错误描述展示元素 | _  ReactNode
_ | - | `false` | +### ImageProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/image.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| src | 图片链接 | _  string
_ | - | `true` | +| round | 是否圆角 | _  boolean
_ | false | `false` | +| width | 宽度，单位为 px | _  number ¦ string
_ | - | `false` | +| height | 高度，单位为 px | _  number ¦ string
_ | - | `false` | +| radius | 圆角大小 | _  number ¦ string
_ | 0 | `false` | +| lazyLoad | 是否懒加载 | _  boolean
_ | false | `false` | +| showMenuByLongpress | 是否开启长按图片显示识别小程序码菜单 | _  boolean
_ | false | `false` | +| fit | 图片填充模式 | _  attr:
    ¦ "contain"
    ¦ "cover"
    ¦ "fill"
    ¦ "widthFix"
    ¦ "heightFix"
    ¦ "none"
_ | fill | `false` | +| showError | 是否展示图片加载失败提示 | _  boolean
_ | false | `false` | +| showLoading | 是否使用 loading 状态 | _  boolean
_ | true | `false` | +| renderLoading | 渲染 loading 展示元素 | _  ReactNode
_ | - | `false` | +| renderError | 渲染错误描述展示元素 | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/index-bar/README.md b/packages/vantui-doc/src/index-bar/README.md index f2e9980b0..a41374b84 100644 --- a/packages/vantui-doc/src/index-bar/README.md +++ b/packages/vantui-doc/src/index-bar/README.md @@ -61,15 +61,15 @@ function Demo() { ``` -### IndexBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/index-bar.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| sticky | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| highlightColor | - | _  string
_ | - | `false` | -| stickyOffsetTop | - | _  number
_ | - | `false` | -| indexList | - | _  string[] ¦ number[]
_ | - | `false` | -| onSelect | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### IndexBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/index-bar.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| sticky | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| highlightColor | - | _  string
_ | - | `false` | +| stickyOffsetTop | - | _  number
_ | - | `false` | +| indexList | - | _  string[] ¦ number[]
_ | - | `false` | +| onSelect | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/loading/README.md b/packages/vantui-doc/src/loading/README.md index 18dc69bcc..62aa0d443 100644 --- a/packages/vantui-doc/src/loading/README.md +++ b/packages/vantui-doc/src/loading/README.md @@ -59,14 +59,14 @@ function Demo() { ) } ``` -### LoadingProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/loading.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| color | - | _  string
_ | - | `false` | -| vertical | - | _  boolean
_ | - | `false` | -| type | - | _  "spinner" ¦ "circular"
_ | - | `false` | -| size | - | _  string ¦ number
_ | - | `false` | -| textSize | - | _  string ¦ number
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | +### LoadingProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/loading.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ---- | ---------------------------------------------------------- | ------ | ------- | +| color | - | _  string
_ | - | `false` | +| vertical | - | _  boolean
_ | - | `false` | +| type | - | _  "spinner" ¦ "circular"
_ | - | `false` | +| size | - | _  string ¦ number
_ | - | `false` | +| textSize | - | _  string ¦ number
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/nav-bar/README.md b/packages/vantui-doc/src/nav-bar/README.md index 9b5570971..e417a9e9b 100644 --- a/packages/vantui-doc/src/nav-bar/README.md +++ b/packages/vantui-doc/src/nav-bar/README.md @@ -50,23 +50,23 @@ function Demo() { ) } ``` -### NavBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/nav-bar.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| title | - | _  string
_ | - | `false` | -| fixed | - | _  boolean
_ | - | `false` | -| placeholder | - | _  boolean
_ | - | `false` | -| leftText | - | _  string
_ | - | `false` | -| rightText | - | _  string
_ | - | `false` | -| style | - | _  string
_ | - | `false` | -| leftArrow | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| safeAreaInsetTop | - | _  boolean
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderLeft | - | _  ReactNode
_ | - | `false` | -| renderRight | - | _  ReactNode
_ | - | `false` | -| onClickLeft | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClickRight | - | _  (e: ITouchEvent) => void
_ | - | `false` | +### NavBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/nav-bar.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ---------------------------------------------------------- | ------ | ------- | +| title | - | _  string
_ | - | `false` | +| fixed | - | _  boolean
_ | - | `false` | +| placeholder | - | _  boolean
_ | - | `false` | +| leftText | - | _  string
_ | - | `false` | +| rightText | - | _  string
_ | - | `false` | +| style | - | _  string
_ | - | `false` | +| leftArrow | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| safeAreaInsetTop | - | _  boolean
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderLeft | - | _  ReactNode
_ | - | `false` | +| renderRight | - | _  ReactNode
_ | - | `false` | +| onClickLeft | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClickRight | - | _  (e: ITouchEvent) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/notice-bar/README.md b/packages/vantui-doc/src/notice-bar/README.md index d08c8eeed..e503928ce 100644 --- a/packages/vantui-doc/src/notice-bar/README.md +++ b/packages/vantui-doc/src/notice-bar/README.md @@ -111,25 +111,25 @@ function Demo() { ) } ``` -### NoticeBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notice-bar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| text | - | _  string
_ | - | `false` | -| mode | - | _  "closeable" ¦ "link"
_ | - | `false` | -| url | - | _  string
_ | - | `false` | -| openType | - | _  any
_ | - | `false` | -| delay | - | _  number
_ | - | `false` | -| speed | - | _  number
_ | - | `false` | -| scrollable | - | _  boolean
_ | - | `false` | -| leftIcon | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| backgroundColor | - | _  string
_ | - | `false` | -| background | - | _  string
_ | - | `false` | -| wrapable | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderLeftIcon | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| onClick | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | +### NoticeBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notice-bar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| text | - | _  string
_ | - | `false` | +| mode | - | _  "closeable" ¦ "link"
_ | - | `false` | +| url | - | _  string
_ | - | `false` | +| openType | - | _  any
_ | - | `false` | +| delay | - | _  number
_ | - | `false` | +| speed | - | _  number
_ | - | `false` | +| scrollable | - | _  boolean
_ | - | `false` | +| leftIcon | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| backgroundColor | - | _  string
_ | - | `false` | +| background | - | _  string
_ | - | `false` | +| wrapable | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderLeftIcon | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| onClick | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/notify/README.md b/packages/vantui-doc/src/notify/README.md index b573a5229..fbd6e634f 100644 --- a/packages/vantui-doc/src/notify/README.md +++ b/packages/vantui-doc/src/notify/README.md @@ -139,21 +139,21 @@ function Demo() { ) } ``` -### NotifyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notify.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| selector | - | _  string
_ | - | `false` | -| message | - | _  string
_ | - | `false` | -| background | - | _  string
_ | - | `false` | -| type | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| duration | - | _  number
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| safeAreaInsetTop | - | _  boolean
_ | - | `false` | -| top | - | _  number
_ | - | `false` | -| id | - | _  string
_ | - | `false` | -| onClick | - | _  (data: any) => void
_ | - | `false` | -| onOpened | - | _  () => void
_ | - | `false` | -| onClose | - | _  () => void
_ | - | `false` | +### NotifyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notify.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ----------------------------------------------------- | ------ | ------- | +| selector | - | _  string
_ | - | `false` | +| message | - | _  string
_ | - | `false` | +| background | - | _  string
_ | - | `false` | +| type | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| duration | - | _  number
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| safeAreaInsetTop | - | _  boolean
_ | - | `false` | +| top | - | _  number
_ | - | `false` | +| id | - | _  string
_ | - | `false` | +| onClick | - | _  (data: any) => void
_ | - | `false` | +| onOpened | - | _  () => void
_ | - | `false` | +| onClose | - | _  () => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/number-keyboard/README.md b/packages/vantui-doc/src/number-keyboard/README.md index 4d79579e9..65eaf2b1d 100644 --- a/packages/vantui-doc/src/number-keyboard/README.md +++ b/packages/vantui-doc/src/number-keyboard/README.md @@ -105,20 +105,20 @@ function Demo() { ) } ``` -### NumberKeyboardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/number-keyboard.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| visible | 是否展示 | _  boolean
_ | - | `false` | -| title | 键盘标题 | _  string
_ | - | `false` | -| confirmText | 完成按钮文案，null 不展示 | _  string ¦ null
_ | null | `false` | -| customKey | 自定义按钮 | _  "-" ¦ "." ¦ "X"
_ | - | `false` | -| randomOrder | 是否乱序键盘 | _  boolean
_ | false | `false` | -| showCloseButton | 是否展示收起键盘箭头 | _  boolean
_ | true | `false` | -| onInput | 输入内容回调 | _  (v: string) => void
_ | true | `false` | -| onDelete | 删除内容回调 | _  () => void
_ | - | `false` | -| onClose | 点击关闭时触发 | _  () => void
_ | - | `false` | -| onConfirm | 点击确定按钮时触发 | _  () => void
_ | - | `false` | -| afterClose | 键盘完全收起回调 | _  () => void
_ | - | `false` | -| closeOnConfirm | 是否在点击确定按钮时自动关闭 | _  boolean
_ | true | `false` | +### NumberKeyboardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/number-keyboard.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---------------------------- | -------------------------------------------------------------------- | ------ | ------- | +| visible | 是否展示 | _  boolean
_ | - | `false` | +| title | 键盘标题 | _  string
_ | - | `false` | +| confirmText | 完成按钮文案，null 不展示 | _  string ¦ null
_ | null | `false` | +| customKey | 自定义按钮 | _  "-" ¦ "." ¦ "X"
_ | - | `false` | +| randomOrder | 是否乱序键盘 | _  boolean
_ | false | `false` | +| showCloseButton | 是否展示收起键盘箭头 | _  boolean
_ | true | `false` | +| onInput | 输入内容回调 | _  (v: string) => void
_ | true | `false` | +| onDelete | 删除内容回调 | _  () => void
_ | - | `false` | +| onClose | 点击关闭时触发 | _  () => void
_ | - | `false` | +| onConfirm | 点击确定按钮时触发 | _  () => void
_ | - | `false` | +| afterClose | 键盘完全收起回调 | _  () => void
_ | - | `false` | +| closeOnConfirm | 是否在点击确定按钮时自动关闭 | _  boolean
_ | true | `false` | diff --git a/packages/vantui-doc/src/overlay/README.md b/packages/vantui-doc/src/overlay/README.md index ec46cfc6d..666d5fdf0 100644 --- a/packages/vantui-doc/src/overlay/README.md +++ b/packages/vantui-doc/src/overlay/README.md @@ -51,13 +51,13 @@ function Demo() { ) } ``` -### OverlayProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/overlay.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| show | - | _  boolean
_ | - | `false` | -| lockScroll | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| duration | - | _  attr:
    ¦ string
    ¦ number
    ¦ {
        enter: string ¦ number
        leave: string ¦ number
      }
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### OverlayProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/overlay.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| show | - | _  boolean
_ | - | `false` | +| lockScroll | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| duration | - | _  attr:
    ¦ string
    ¦ number
    ¦ {
        enter: string ¦ number
        leave: string ¦ number
      }
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/pagination/README.md b/packages/vantui-doc/src/pagination/README.md index 170bd93df..c92a87843 100644 --- a/packages/vantui-doc/src/pagination/README.md +++ b/packages/vantui-doc/src/pagination/README.md @@ -109,21 +109,21 @@ function Demo() { ) } ``` -### PaginationProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/pagination.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| defaultValue | 默认页码 | _  number
_ | 1 | `false` | -| modelValue | 当前页码 | _  number
_ | 1 | `true` | -| mode | - | _  "multi" ¦ "simple"
_ | multi | `false` | -| prevText | 自定义上一页按钮内容 | _  React.ReactNode
_ | 上一页 | `false` | -| nextText | 自定义下一页按钮内容 | _  React.ReactNode
_ | 下一页 | `false` | -| pageCount | 总页数 | _  string ¦ number
_ | 传入或者根据数据量计算 | `true` | -| totalItems | 总记录数 | _  string ¦ number
_ | 0 | `false` | -| itemsPerPage | 每页数量 | _  string ¦ number
_ | 10 | `false` | -| showPageSize | 显示页码个数 | _  string ¦ number
_ | 5 | `false` | -| forceEllipses | 是否展示省略号 | _  boolean
_ | false | `false` | -| pageNodeRender | 自定义渲染页码结构, 入参数为number页数、text文本、 active选中状态 | _  (page: {
    number: number
    text: string
    active: boolean
  }) => React.ReactNode
_ | - | `false` | -| onChange | 页码改变的时候触发 | _  (currPage: number) => void
_ | - | `true` | -| updatecurrent | - | _  (currPage: number) => void
_ | - | `false` | +### PaginationProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/pagination.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ------- | +| defaultValue | 默认页码 | _  number
_ | 1 | `false` | +| modelValue | 当前页码 | _  number
_ | 1 | `true` | +| mode | - | _  "multi" ¦ "simple"
_ | multi | `false` | +| prevText | 自定义上一页按钮内容 | _  React.ReactNode
_ | 上一页 | `false` | +| nextText | 自定义下一页按钮内容 | _  React.ReactNode
_ | 下一页 | `false` | +| pageCount | 总页数 | _  string ¦ number
_ | 传入或者根据数据量计算 | `true` | +| totalItems | 总记录数 | _  string ¦ number
_ | 0 | `false` | +| itemsPerPage | 每页数量 | _  string ¦ number
_ | 10 | `false` | +| showPageSize | 显示页码个数 | _  string ¦ number
_ | 5 | `false` | +| forceEllipses | 是否展示省略号 | _  boolean
_ | false | `false` | +| pageNodeRender | 自定义渲染页码结构, 入参数为 number 页数、text 文本、 active 选中状态 | _  (page: {
    number: number
    text: string
    active: boolean
  }) => React.ReactNode
_ | - | `false` | +| onChange | 页码改变的时候触发 | _  (currPage: number) => void
_ | - | `true` | +| updatecurrent | - | _  (currPage: number) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/picker/README.md b/packages/vantui-doc/src/picker/README.md index 13dcf3a59..8a636a0e0 100644 --- a/packages/vantui-doc/src/picker/README.md +++ b/packages/vantui-doc/src/picker/README.md @@ -153,39 +153,43 @@ function Demo() { return } ``` -### PickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| valueKey | 选项为对象的时候，文字对应的 key | _  string
_ | text | `false` | -| toolbarPosition | 顶部栏位置，可选值为bottom | _  string
_ | top | `false` | -| defaultIndex | 单列选择器的默认选中项索引,多列选择器请参考下方的 Columns 配置 | _  number
_ | 0 | `false` | -| columns | 每一项数据，可为字符或者对象，对象默认展示值是valueKey设置的key | _  any[]
_ | [] | `false` | -| title | 顶部栏标题 | _  string
_ | '' | `false` | -| cancelButtonText | 取消按钮文字 | _  string
_ | 取消 | `false` | -| confirmButtonText | 确认按钮文字 | _  string
_ | 确认 | `false` | -| loading | 加载状态 | _  boolean
_ | false | `false` | -| itemHeight | 选项高度,对应单位PX | _  string ¦ number
_ | 48 | `false` | -| visibleItemCount | 可见的选项个数 | _  number
_ | 6 | `false` | -| onChange | 变化触发方法 | _  (e: PickerChangeEvents) => void
_ | - | `false` | -| onCancel | 取消触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | -| onConfirm | 确认触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | -| showToolbar | 是否显示顶部栏 | _  boolean
_ | false | `false` | - -### 事件 onConfirm 和 onCancel [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) -继承了Taro的ITouchEvent类型 + +### PickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------- | ------ | ------- | +| valueKey | 选项为对象的时候，文字对应的 key | _  string
_ | text | `false` | +| toolbarPosition | 顶部栏位置，可选值为 bottom | _  string
_ | top | `false` | +| defaultIndex | 单列选择器的默认选中项索引,多列选择器请参考下方的 Columns 配置 | _  number
_ | 0 | `false` | +| columns | 每一项数据，可为字符或者对象，对象默认展示值是 valueKey 设置的 key | _  any[]
_ | [] | `false` | +| title | 顶部栏标题 | _  string
_ | '' | `false` | +| cancelButtonText | 取消按钮文字 | _  string
_ | 取消 | `false` | +| confirmButtonText | 确认按钮文字 | _  string
_ | 确认 | `false` | +| loading | 加载状态 | _  boolean
_ | false | `false` | +| itemHeight | 选项高度,对应单位 PX | _  string ¦ number
_ | 48 | `false` | +| visibleItemCount | 可见的选项个数 | _  number
_ | 6 | `false` | +| onChange | 变化触发方法 | _  (e: PickerChangeEvents) => void
_ | - | `false` | +| onCancel | 取消触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | +| onConfirm | 确认触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | +| showToolbar | 是否显示顶部栏 | _  boolean
_ | false | `false` | + +### 事件 onConfirm 和 onCancel [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +继承了 Taro 的 ITouchEvent 类型 | 参数 | 说明 | 类型 | | --- | --- | --- | | detail | 返回选项对应的值和选项对应的下标 | _  {
    value: number ¦ number[]
    index: number ¦ number[]
  }
_ | -### 触发事件 onChange [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) -继承了Taro的ITouchEvent类型 +### 触发事件 onChange [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +继承了 Taro 的 ITouchEvent 类型 | 参数 | 说明 | 类型 | | --- | --- | --- | -| detail | 返回选项对应的值、picker实例和多列返回当前第多少列、单列返回选项对应值 | _  {
    value: number ¦ number[]
    picker: IPickerInstance
    index: number
  }
_ | +| detail | 返回选项对应的值、picker 实例和多列返回当前第多少列、单列返回选项对应值 | _  {
    value: number ¦ number[]
    picker: IPickerInstance
    index: number
  }
_ | -### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) -通过ref获取到的方法如下 +### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +通过 ref 获取到的方法如下 | 方法 | 说明 | 类型 | | --- | --- | --- | | setColumnValues | 设置每一列的值 | _  (
    index: number,
    options: string[]
  ) => Promise
_ | @@ -197,4 +201,3 @@ function Demo() { | setIndexes | 获取每一列展示的下标 | _  () => void
_ | | getValues | 每一列展示的下标 | _  () => number ¦ string
_ | | confirm | 触发确认的方法 | _  () => void
_ | - diff --git a/packages/vantui-doc/src/popup/README.md b/packages/vantui-doc/src/popup/README.md index ed8626af2..619463e01 100644 --- a/packages/vantui-doc/src/popup/README.md +++ b/packages/vantui-doc/src/popup/README.md @@ -119,23 +119,23 @@ function Demo() { ``` -### PopupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/popup.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| round | 是否显示圆角 | _  boolean
_ | - | `false` | -| closeable | 是否显示关闭图标 | _  boolean
_ | - | `false` | -| overlayStyle | 自定义遮罩层样式 | _  string
_ | - | `false` | -| transition | 执行 | _  string
_ | - | `false` | -| zIndex | 弹出层的层级 | _  number
_ | - | `false` | -| overlay | 是否显示遮罩层 | _  boolean
_ | - | `false` | -| closeIcon | 关闭图标名称或图片链接 | _  string
_ | - | `false` | -| closeIconPosition | 关闭图标名称或图片链接的位置 | _  attr:
    ¦ "top-left"
    ¦ "top-right"
    ¦ "bottom-left"
    ¦ "bottom-right"
_ | - | `false` | -| closeOnClickOverlay | 是否在点击遮罩层后关闭 | _  boolean
_ | true | `false` | -| position | 弹出位置 | _  "top" ¦ "bottom" ¦ "right" ¦ "left"
_ | center | `false` | -| safeAreaInsetBottom | 是否为 iPhoneX 留出底部安全距离 | _  boolean
_ | true | `false` | -| safeAreaInsetTop | 是否留出顶部安全距离（状态栏高度） | _  boolean
_ | false | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onClickOverlay | 点击蒙层触发的方法 | _  () => void
_ | - | `false` | -| onClose | 蒙层关闭触发的方法 | _  () => void
_ | - | `false` | +### PopupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/popup.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| round | 是否显示圆角 | _  boolean
_ | - | `false` | +| closeable | 是否显示关闭图标 | _  boolean
_ | - | `false` | +| overlayStyle | 自定义遮罩层样式 | _  string
_ | - | `false` | +| transition | 执行 | _  string
_ | - | `false` | +| zIndex | 弹出层的层级 | _  number
_ | - | `false` | +| overlay | 是否显示遮罩层 | _  boolean
_ | - | `false` | +| closeIcon | 关闭图标名称或图片链接 | _  string
_ | - | `false` | +| closeIconPosition | 关闭图标名称或图片链接的位置 | _  attr:
    ¦ "top-left"
    ¦ "top-right"
    ¦ "bottom-left"
    ¦ "bottom-right"
_ | - | `false` | +| closeOnClickOverlay | 是否在点击遮罩层后关闭 | _  boolean
_ | true | `false` | +| position | 弹出位置 | _  "top" ¦ "bottom" ¦ "right" ¦ "left"
_ | center | `false` | +| safeAreaInsetBottom | 是否为 iPhoneX 留出底部安全距离 | _  boolean
_ | true | `false` | +| safeAreaInsetTop | 是否留出顶部安全距离（状态栏高度） | _  boolean
_ | false | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onClickOverlay | 点击蒙层触发的方法 | _  () => void
_ | - | `false` | +| onClose | 蒙层关闭触发的方法 | _  () => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/progress/README.md b/packages/vantui-doc/src/progress/README.md index 4e0ede8bb..5a707dfe1 100644 --- a/packages/vantui-doc/src/progress/README.md +++ b/packages/vantui-doc/src/progress/README.md @@ -64,17 +64,17 @@ function Demo() { ) } ``` -### ProgressProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/progress.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| inactive | - | _  boolean
_ | - | `false` | -| percentage | - | _  number
_ | - | `true` | -| pivotText | - | _  string
_ | - | `false` | -| pivotColor | - | _  string
_ | - | `false` | -| trackColor | - | _  string
_ | - | `false` | -| showPivot | - | _  boolean
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| textColor | - | _  string
_ | - | `false` | -| strokeWidth | - | _  number ¦ string
_ | - | `false` | +### ProgressProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/progress.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | --------------------------------------------------- | ------ | ------- | +| inactive | - | _  boolean
_ | - | `false` | +| percentage | - | _  number
_ | - | `true` | +| pivotText | - | _  string
_ | - | `false` | +| pivotColor | - | _  string
_ | - | `false` | +| trackColor | - | _  string
_ | - | `false` | +| showPivot | - | _  boolean
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| textColor | - | _  string
_ | - | `false` | +| strokeWidth | - | _  number ¦ string
_ | - | `false` | diff --git a/packages/vantui-doc/src/radio/README.md b/packages/vantui-doc/src/radio/README.md index 6247aa47a..451604834 100644 --- a/packages/vantui-doc/src/radio/README.md +++ b/packages/vantui-doc/src/radio/README.md @@ -221,29 +221,29 @@ function Demo() { ) } ``` -### RadioProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | - | _  string
_ | - | `false` | -| value | - | _  any
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| checkedColor | - | _  string
_ | - | `false` | -| labelPosition | - | _  string
_ | - | `false` | -| labelDisabled | - | _  boolean
_ | - | `false` | -| shape | - | _  "round" ¦ "square"
_ | - | `false` | -| iconSize | - | _  number ¦ string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | - -### RadioGroupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  any
_ | - | `false` | -| direction | - | _  "vertical" ¦ "horizontal"
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | +### RadioProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| name | - | _  string
_ | - | `false` | +| value | - | _  any
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| checkedColor | - | _  string
_ | - | `false` | +| labelPosition | - | _  string
_ | - | `false` | +| labelDisabled | - | _  boolean
_ | - | `false` | +| shape | - | _  "round" ¦ "square"
_ | - | `false` | +| iconSize | - | _  number ¦ string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | + +### RadioGroupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| value | - | _  any
_ | - | `false` | +| direction | - | _  "vertical" ¦ "horizontal"
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/rate/README.md b/packages/vantui-doc/src/rate/README.md index a8c3a5d2a..d454dd424 100644 --- a/packages/vantui-doc/src/rate/README.md +++ b/packages/vantui-doc/src/rate/README.md @@ -106,23 +106,23 @@ function Demo() { return } ``` -### RateProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/rate.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  number
_ | - | `false` | -| defaultValue | - | _  number
_ | - | `false` | -| readonly | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| allowHalf | - | _  boolean
_ | - | `false` | -| size | - | _  string ¦ number
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| voidIcon | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| voidColor | - | _  string
_ | - | `false` | -| disabledColor | - | _  string
_ | - | `false` | -| count | - | _  number
_ | - | `false` | -| gutter | - | _  string ¦ number
_ | - | `false` | -| touchable | - | _  boolean
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent) => any
_ | - | `false` | +### RateProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/rate.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | --------------------------------------------------------- | ------ | ------- | +| value | - | _  number
_ | - | `false` | +| defaultValue | - | _  number
_ | - | `false` | +| readonly | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| allowHalf | - | _  boolean
_ | - | `false` | +| size | - | _  string ¦ number
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| voidIcon | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| voidColor | - | _  string
_ | - | `false` | +| disabledColor | - | _  string
_ | - | `false` | +| count | - | _  number
_ | - | `false` | +| gutter | - | _  string ¦ number
_ | - | `false` | +| touchable | - | _  boolean
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/search/README.md b/packages/vantui-doc/src/search/README.md index 2be1d7f3b..4198152b2 100644 --- a/packages/vantui-doc/src/search/README.md +++ b/packages/vantui-doc/src/search/README.md @@ -108,39 +108,39 @@ function Demo() { ) } ``` -### SearchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/search.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  string ¦ number
_ | - | `false` | -| defaultValue | - | _  string ¦ number
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| focus | - | _  boolean
_ | - | `false` | -| error | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| readonly | - | _  boolean
_ | - | `false` | -| inputAlign | - | _  string
_ | - | `false` | -| showAction | - | _  boolean
_ | - | `false` | -| leftIcon | - | _  string
_ | - | `false` | -| rightIcon | - | _  string
_ | - | `false` | -| placeholder | - | _  string
_ | - | `false` | -| placeholderStyle | - | _  string
_ | - | `false` | -| actionText | - | _  string
_ | - | `false` | -| background | - | _  string
_ | - | `false` | -| maxlength | - | _  number
_ | - | `false` | -| shape | - | _  string
_ | - | `false` | -| clearable | - | _  boolean
_ | - | `false` | -| clearTrigger | - | _  string
_ | - | `false` | -| clearIcon | - | _  string
_ | - | `false` | -| renderLabel | - | _  ReactNode
_ | - | `false` | -| renderLeftIcon | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| renderAction | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onSearch | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClear | - | _  () => void
_ | - | `false` | -| onCancel | - | _  () => void
_ | - | `false` | -| onClickInput | - | _  () => void
_ | - | `false` | +### SearchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/search.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ---------------------------------------------------------- | ------ | ------- | +| value | - | _  string ¦ number
_ | - | `false` | +| defaultValue | - | _  string ¦ number
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| focus | - | _  boolean
_ | - | `false` | +| error | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| readonly | - | _  boolean
_ | - | `false` | +| inputAlign | - | _  string
_ | - | `false` | +| showAction | - | _  boolean
_ | - | `false` | +| leftIcon | - | _  string
_ | - | `false` | +| rightIcon | - | _  string
_ | - | `false` | +| placeholder | - | _  string
_ | - | `false` | +| placeholderStyle | - | _  string
_ | - | `false` | +| actionText | - | _  string
_ | - | `false` | +| background | - | _  string
_ | - | `false` | +| maxlength | - | _  number
_ | - | `false` | +| shape | - | _  string
_ | - | `false` | +| clearable | - | _  boolean
_ | - | `false` | +| clearTrigger | - | _  string
_ | - | `false` | +| clearIcon | - | _  string
_ | - | `false` | +| renderLabel | - | _  ReactNode
_ | - | `false` | +| renderLeftIcon | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| renderAction | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onSearch | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClear | - | _  () => void
_ | - | `false` | +| onCancel | - | _  () => void
_ | - | `false` | +| onClickInput | - | _  () => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/share-sheet/README.md b/packages/vantui-doc/src/share-sheet/README.md index 7c74227f2..6d0f753cf 100644 --- a/packages/vantui-doc/src/share-sheet/README.md +++ b/packages/vantui-doc/src/share-sheet/README.md @@ -187,42 +187,42 @@ function Demo() { | icon | - | _  string
_ | | description | - | _  string
_ | | openType | - | _  string
_ | -### ShareSheetOptionItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| name | - | _  string
_ | -| icon | - | _  string
_ | -| description | - | _  string
_ | -| openType | - | _  string
_ | - -### ShareSheetOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| showBorder | - | _  boolean
_ | -| options | - | _  ShareSheetOptionItem[]
_ | -| onSelect | - | _  (
    option: ShareSheetOptionItem,
    index: number
  ) => void
_ | - -### ShareSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| show | - | _  boolean
_ | - | `false` | -| overlayStyle | - | _  string
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| overlay | - | _  boolean
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| closeOnClickOverlay | - | _  boolean
_ | - | `false` | -| duration | - | _  number ¦ string
_ | - | `false` | -| onClickOverlay | - | _  () => void
_ | - | `false` | -| onCancel | - | _  () => void
_ | - | `false` | -| onSelect | - | _  (event: {
    detail: ShareSheetOptionItem
  }) => void
_ | - | `false` | -| onClose | - | _  () => void
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderDescription | - | _  ReactNode
_ | - | `false` | -| cancelText | - | _  string
_ | - | `false` | -| description | - | _  string
_ | - | `false` | -| options | - | _  attr:
    ¦ ShareSheetOptionItem[]
    ¦ ShareSheetOptionItem[][]
_ | - | `false` | +### ShareSheetOptionItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) +| 参数 | 说明 | 类型 | +| ----------- | ---- | ------------------------- | +| name | - | _  string
_ | +| icon | - | _  string
_ | +| description | - | _  string
_ | +| openType | - | _  string
_ | + +### ShareSheetOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) + +| 参数 | 说明 | 类型 | +| ---------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| showBorder | - | _  boolean
_ | +| options | - | _  ShareSheetOptionItem[]
_ | +| onSelect | - | _  (
    option: ShareSheetOptionItem,
    index: number
  ) => void
_ | + +### ShareSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| show | - | _  boolean
_ | - | `false` | +| overlayStyle | - | _  string
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| overlay | - | _  boolean
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| closeOnClickOverlay | - | _  boolean
_ | - | `false` | +| duration | - | _  number ¦ string
_ | - | `false` | +| onClickOverlay | - | _  () => void
_ | - | `false` | +| onCancel | - | _  () => void
_ | - | `false` | +| onSelect | - | _  (event: {
    detail: ShareSheetOptionItem
  }) => void
_ | - | `false` | +| onClose | - | _  () => void
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderDescription | - | _  ReactNode
_ | - | `false` | +| cancelText | - | _  string
_ | - | `false` | +| description | - | _  string
_ | - | `false` | +| options | - | _  attr:
    ¦ ShareSheetOptionItem[]
    ¦ ShareSheetOptionItem[][]
_ | - | `false` | diff --git a/packages/vantui-doc/src/sidebar/README.md b/packages/vantui-doc/src/sidebar/README.md index 1f56df391..09abd5930 100644 --- a/packages/vantui-doc/src/sidebar/README.md +++ b/packages/vantui-doc/src/sidebar/README.md @@ -88,24 +88,24 @@ function Demo() { ) } ``` -### SidebarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| dot | - | _  boolean
_ | - | `false` | -| badge | - | _  string
_ | - | `false` | -| info | - | _  string
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| onClick | - | _  (a: any) => void
_ | - | `false` | -| onChange | - | _  (a: OnChangeEvent) => void
_ | - | `false` | -| renderTitle | - | _  (a: any) => React.ReactNode
_ | - | `false` | - -### SidebarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| onChange | - | _  (a: OnChangeEvent) => any
_ | - | `false` | -| activeKey | - | _  number
_ | - | `true` | -| children | - | _  React.ReactNode
_ | - | `true` | +### SidebarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| dot | - | _  boolean
_ | - | `false` | +| badge | - | _  string
_ | - | `false` | +| info | - | _  string
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| onClick | - | _  (a: any) => void
_ | - | `false` | +| onChange | - | _  (a: OnChangeEvent) => void
_ | - | `false` | +| renderTitle | - | _  (a: any) => React.ReactNode
_ | - | `false` | + +### SidebarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ----------------------------------------------------------- | ------ | ------- | +| onChange | - | _  (a: OnChangeEvent) => any
_ | - | `false` | +| activeKey | - | _  number
_ | - | `true` | +| children | - | _  React.ReactNode
_ | - | `true` | diff --git a/packages/vantui-doc/src/skeleton/README.md b/packages/vantui-doc/src/skeleton/README.md index 4de321863..ede54f4d5 100644 --- a/packages/vantui-doc/src/skeleton/README.md +++ b/packages/vantui-doc/src/skeleton/README.md @@ -56,18 +56,18 @@ function Demo() { ) } ``` -### SkeletonProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/skeleton.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| row | - | _  number
_ | - | `false` | -| title | - | _  boolean
_ | - | `false` | -| avatar | - | _  boolean
_ | - | `false` | -| loading | - | _  boolean
_ | - | `false` | -| animate | - | _  boolean
_ | - | `false` | -| avatarSize | - | _  string ¦ number
_ | - | `false` | -| avatarShape | - | _  "square" ¦ "round"
_ | - | `false` | -| titleWidth | - | _  string ¦ number
_ | - | `false` | -| rowWidth | - | _  string ¦ string[]
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### SkeletonProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/skeleton.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ------------------------------------------------------ | ------ | ------- | +| row | - | _  number
_ | - | `false` | +| title | - | _  boolean
_ | - | `false` | +| avatar | - | _  boolean
_ | - | `false` | +| loading | - | _  boolean
_ | - | `false` | +| animate | - | _  boolean
_ | - | `false` | +| avatarSize | - | _  string ¦ number
_ | - | `false` | +| avatarShape | - | _  "square" ¦ "round"
_ | - | `false` | +| titleWidth | - | _  string ¦ number
_ | - | `false` | +| rowWidth | - | _  string ¦ string[]
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/slider/README.md b/packages/vantui-doc/src/slider/README.md index 7f71b421d..113eb57d4 100644 --- a/packages/vantui-doc/src/slider/README.md +++ b/packages/vantui-doc/src/slider/README.md @@ -106,25 +106,25 @@ function Demo() { ) } ``` -### SliderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/slider.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| range | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| max | - | _  number
_ | - | `false` | -| min | - | _  number
_ | - | `false` | -| step | - | _  number
_ | - | `false` | -| value | - | _  number
_ | - | `false` | -| barHeight | - | _  number ¦ string
_ | - | `false` | -| vertical | - | _  boolean
_ | - | `false` | -| onDrag | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | -| onDragStart | - | _  () => void
_ | - | `false` | -| onDragEnd | - | _  () => void
_ | - | `false` | -| renderLeftButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | -| renderRightButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | -| renderButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | +### SliderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/slider.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ---- | ---------------------------------------------------------------------------------- | ------ | ------- | +| range | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| max | - | _  number
_ | - | `false` | +| min | - | _  number
_ | - | `false` | +| step | - | _  number
_ | - | `false` | +| value | - | _  number
_ | - | `false` | +| barHeight | - | _  number ¦ string
_ | - | `false` | +| vertical | - | _  boolean
_ | - | `false` | +| onDrag | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | +| onDragStart | - | _  () => void
_ | - | `false` | +| onDragEnd | - | _  () => void
_ | - | `false` | +| renderLeftButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | +| renderRightButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | +| renderButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/stepper/README.md b/packages/vantui-doc/src/stepper/README.md index fbcbfc6da..5390fac32 100644 --- a/packages/vantui-doc/src/stepper/README.md +++ b/packages/vantui-doc/src/stepper/README.md @@ -123,35 +123,35 @@ function Demo() { return } ``` -### StepperProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/stepper.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | - | _  string
_ | - | `false` | -| value | - | _  string ¦ number
_ | - | `false` | -| integer | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| inputWidth | - | _  string ¦ number
_ | - | `false` | -| buttonSize | - | _  string ¦ number
_ | - | `false` | -| asyncChange | - | _  boolean
_ | - | `false` | -| disableInput | - | _  boolean
_ | - | `false` | -| decimalLength | - | _  number
_ | - | `false` | -| min | - | _  string ¦ number
_ | - | `false` | -| max | - | _  string ¦ number
_ | - | `false` | -| step | - | _  string ¦ number
_ | - | `false` | -| showPlus | - | _  boolean
_ | - | `false` | -| showMinus | - | _  boolean
_ | - | `false` | -| disablePlus | - | _  boolean
_ | - | `false` | -| disableMinus | - | _  boolean
_ | - | `false` | -| longPress | - | _  boolean
_ | - | `false` | -| theme | - | _  "round"
_ | - | `false` | -| alwaysEmbed | - | _  boolean
_ | - | `false` | -| onFocus | - | _  CommonEventFunction
_ | - | `false` | -| onChange | - | _  (event: {
    detail: number ¦ string
  }) => void
_ | - | `false` | -| onBlur | - | _  CommonEventFunction
_ | - | `false` | -| onOverlimit | - | _  () => void
_ | - | `false` | -| onPlus | - | _  () => void
_ | - | `false` | -| onMinus | - | _  () => void
_ | - | `false` | -| renderMinus | - | _  ReactNode
_ | - | `false` | -| renderPlus | - | _  ReactNode
_ | - | `false` | +### StepperProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/stepper.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| name | - | _  string
_ | - | `false` | +| value | - | _  string ¦ number
_ | - | `false` | +| integer | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| inputWidth | - | _  string ¦ number
_ | - | `false` | +| buttonSize | - | _  string ¦ number
_ | - | `false` | +| asyncChange | - | _  boolean
_ | - | `false` | +| disableInput | - | _  boolean
_ | - | `false` | +| decimalLength | - | _  number
_ | - | `false` | +| min | - | _  string ¦ number
_ | - | `false` | +| max | - | _  string ¦ number
_ | - | `false` | +| step | - | _  string ¦ number
_ | - | `false` | +| showPlus | - | _  boolean
_ | - | `false` | +| showMinus | - | _  boolean
_ | - | `false` | +| disablePlus | - | _  boolean
_ | - | `false` | +| disableMinus | - | _  boolean
_ | - | `false` | +| longPress | - | _  boolean
_ | - | `false` | +| theme | - | _  "round"
_ | - | `false` | +| alwaysEmbed | - | _  boolean
_ | - | `false` | +| onFocus | - | _  CommonEventFunction
_ | - | `false` | +| onChange | - | _  (event: {
    detail: number ¦ string
  }) => void
_ | - | `false` | +| onBlur | - | _  CommonEventFunction
_ | - | `false` | +| onOverlimit | - | _  () => void
_ | - | `false` | +| onPlus | - | _  () => void
_ | - | `false` | +| onMinus | - | _  () => void
_ | - | `false` | +| renderMinus | - | _  ReactNode
_ | - | `false` | +| renderPlus | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/steps/README.md b/packages/vantui-doc/src/steps/README.md index 7f694b427..a06bb6a12 100644 --- a/packages/vantui-doc/src/steps/README.md +++ b/packages/vantui-doc/src/steps/README.md @@ -130,17 +130,17 @@ function Demo() { ) } ``` -### StepsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/steps.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| icon | - | _  string
_ | - | `false` | -| steps | - | _  {
    index?: number
    desc: string
    text: string
    activeIcon?: string
    inactiveIcon?: string
  }[]
_ | - | `false` | -| active | - | _  number
_ | - | `false` | -| direction | - | _  "horizontal" ¦ "vertical"
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| activeIcon | - | _  string
_ | - | `false` | -| inactiveIcon | - | _  string
_ | - | `false` | -| onClickStep | - | _  (
    event: ITouchEvent & { detail: number }
  ) => void
_ | - | `false` | +### StepsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/steps.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| icon | - | _  string
_ | - | `false` | +| steps | - | _  {
    index?: number
    desc: string
    text: string
    activeIcon?: string
    inactiveIcon?: string
  }[]
_ | - | `false` | +| active | - | _  number
_ | - | `false` | +| direction | - | _  "horizontal" ¦ "vertical"
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| activeIcon | - | _  string
_ | - | `false` | +| inactiveIcon | - | _  string
_ | - | `false` | +| onClickStep | - | _  (
    event: ITouchEvent & { detail: number }
  ) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/sticky/README.md b/packages/vantui-doc/src/sticky/README.md index 635cc6250..1ac2b92f1 100644 --- a/packages/vantui-doc/src/sticky/README.md +++ b/packages/vantui-doc/src/sticky/README.md @@ -45,15 +45,15 @@ function Demo() { ) } ``` -### StickyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sticky.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| zIndex | - | _  number
_ | - | `false` | -| offsetTop | - | _  number
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| container | - | _  () => any
_ | - | `false` | -| scrollTop | - | _  number
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number
      isFixed?: boolean
    }
  }) => any
_ | - | `false` | +### StickyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sticky.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| zIndex | - | _  number
_ | - | `false` | +| offsetTop | - | _  number
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| container | - | _  () => any
_ | - | `false` | +| scrollTop | - | _  number
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number
      isFixed?: boolean
    }
  }) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/submit-bar/README.md b/packages/vantui-doc/src/submit-bar/README.md index b99edb26b..de1db9aa2 100644 --- a/packages/vantui-doc/src/submit-bar/README.md +++ b/packages/vantui-doc/src/submit-bar/README.md @@ -87,24 +87,24 @@ function Demo() { ) } ``` -### SubmitBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/submit-bar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| tip | - | _  string
_ | - | `false` | -| tipIcon | - | _  string
_ | - | `false` | -| price | - | _  number
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| loading | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| buttonText | - | _  string
_ | - | `false` | -| currency | - | _  string
_ | - | `false` | -| buttonType | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | -| decimalLength | - | _  number
_ | - | `false` | -| suffixLabel | - | _  string
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderTop | - | _  ReactNode
_ | - | `false` | -| renderTip | - | _  ReactNode
_ | - | `false` | -| onSubmit | - | _  (event: ITouchEvent) => void
_ | - | `false` | +### SubmitBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/submit-bar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| tip | - | _  string
_ | - | `false` | +| tipIcon | - | _  string
_ | - | `false` | +| price | - | _  number
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| loading | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| buttonText | - | _  string
_ | - | `false` | +| currency | - | _  string
_ | - | `false` | +| buttonType | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | +| decimalLength | - | _  number
_ | - | `false` | +| suffixLabel | - | _  string
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderTop | - | _  ReactNode
_ | - | `false` | +| renderTip | - | _  ReactNode
_ | - | `false` | +| onSubmit | - | _  (event: ITouchEvent) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/swipe-cell/README.md b/packages/vantui-doc/src/swipe-cell/README.md index a2153787c..f95db296c 100644 --- a/packages/vantui-doc/src/swipe-cell/README.md +++ b/packages/vantui-doc/src/swipe-cell/README.md @@ -90,28 +90,28 @@ function Demo() { ) } ``` -### SwipeCellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| disabled | - | _  boolean
_ | - | `false` | -| leftWidth | - | _  number
_ | - | `false` | -| rightWidth | - | _  number
_ | - | `false` | -| asyncClose | - | _  boolean
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| catchMove | - | _  boolean
_ | - | `false` | -| wrapperStyle | - | _  React.CSSProperties
_ | - | `false` | -| onOpen | - | _  (e: ITouchEvent & SwipeCellOpen) => void
_ | - | `false` | -| onClick | - | _  (
    e: ITouchEvent & SwipeCellClick
  ) => void
_ | - | `false` | -| onClose | - | _  (
    e: ITouchEvent & SwipeCellClose
  ) => void
_ | - | `false` | -| renderLeft | - | _  React.ReactNode
_ | - | `false` | -| renderRight | - | _  React.ReactNode
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | - -### ISwiperCellInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) - -| 方法 | 说明 | 类型 | -| --- | --- | --- | -| open | - | _  (position: "left" ¦ "right") => void
_ | -| close | - | _  () => void
_ | +### SwipeCellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| disabled | - | _  boolean
_ | - | `false` | +| leftWidth | - | _  number
_ | - | `false` | +| rightWidth | - | _  number
_ | - | `false` | +| asyncClose | - | _  boolean
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| catchMove | - | _  boolean
_ | - | `false` | +| wrapperStyle | - | _  React.CSSProperties
_ | - | `false` | +| onOpen | - | _  (e: ITouchEvent & SwipeCellOpen) => void
_ | - | `false` | +| onClick | - | _  (
    e: ITouchEvent & SwipeCellClick
  ) => void
_ | - | `false` | +| onClose | - | _  (
    e: ITouchEvent & SwipeCellClose
  ) => void
_ | - | `false` | +| renderLeft | - | _  React.ReactNode
_ | - | `false` | +| renderRight | - | _  React.ReactNode
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | + +### ISwiperCellInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) + +| 方法 | 说明 | 类型 | +| ----- | ---- | --------------------------------------------------------------------------------------- | +| open | - | _  (position: "left" ¦ "right") => void
_ | +| close | - | _  () => void
_ | diff --git a/packages/vantui-doc/src/switch/README.md b/packages/vantui-doc/src/switch/README.md index ba0cac6b9..34aeb06ad 100644 --- a/packages/vantui-doc/src/switch/README.md +++ b/packages/vantui-doc/src/switch/README.md @@ -94,17 +94,17 @@ function Demo() { ) } ``` -### SwitchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/switch.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| checked | - | _  boolean
_ | - | `false` | -| loading | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| size | - | _  string
_ | - | `false` | -| activeValue | - | _  any
_ | - | `false` | -| inactiveValue | - | _  any
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | +### SwitchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/switch.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| checked | - | _  boolean
_ | - | `false` | +| loading | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| size | - | _  string
_ | - | `false` | +| activeValue | - | _  any
_ | - | `false` | +| inactiveValue | - | _  any
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/tab/README.md b/packages/vantui-doc/src/tab/README.md index c47a7d420..7a4c8385b 100644 --- a/packages/vantui-doc/src/tab/README.md +++ b/packages/vantui-doc/src/tab/README.md @@ -213,44 +213,44 @@ function Demo() { ) } ``` -### TabsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| sticky | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| swipeable | - | _  boolean
_ | - | `false` | -| titleActiveColor | - | _  string
_ | - | `false` | -| titleInactiveColor | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| animated | - | _  boolean
_ | - | `false` | -| lineWidth | - | _  number ¦ string
_ | - | `false` | -| lineHeight | - | _  number ¦ string
_ | - | `false` | -| active | - | _  number ¦ string
_ | - | `false` | -| type | - | _  string
_ | - | `false` | -| ellipsis | - | _  boolean
_ | - | `false` | -| duration | - | _  number
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| swipeThreshold | - | _  number
_ | - | `false` | -| offsetTop | - | _  number
_ | - | `false` | -| lazyRender | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `true` | -| renderNavLeft | - | _  ReactNode
_ | - | `false` | -| renderNavRight | - | _  ReactNode
_ | - | `false` | -| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number ¦ null
      isFixed?: boolean
    }
  }) => void
_ | - | `false` | -| onClick | - | _  (event: eventDetail) => void
_ | - | `false` | -| onChange | - | _  (event: eventDetail) => void
_ | - | `false` | -| onDisabled | - | _  (event: eventDetail) => void
_ | - | `false` | - -### TabProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| dot | - | _  boolean
_ | - | `false` | -| info | - | _  string ¦ number
_ | - | `false` | -| title | - | _  ReactNode
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| titleStyle | - | _  string
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### TabsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| sticky | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| swipeable | - | _  boolean
_ | - | `false` | +| titleActiveColor | - | _  string
_ | - | `false` | +| titleInactiveColor | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| animated | - | _  boolean
_ | - | `false` | +| lineWidth | - | _  number ¦ string
_ | - | `false` | +| lineHeight | - | _  number ¦ string
_ | - | `false` | +| active | - | _  number ¦ string
_ | - | `false` | +| type | - | _  string
_ | - | `false` | +| ellipsis | - | _  boolean
_ | - | `false` | +| duration | - | _  number
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| swipeThreshold | - | _  number
_ | - | `false` | +| offsetTop | - | _  number
_ | - | `false` | +| lazyRender | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `true` | +| renderNavLeft | - | _  ReactNode
_ | - | `false` | +| renderNavRight | - | _  ReactNode
_ | - | `false` | +| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number ¦ null
      isFixed?: boolean
    }
  }) => void
_ | - | `false` | +| onClick | - | _  (event: eventDetail) => void
_ | - | `false` | +| onChange | - | _  (event: eventDetail) => void
_ | - | `false` | +| onDisabled | - | _  (event: eventDetail) => void
_ | - | `false` | + +### TabProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | ---- | --------------------------------------------------- | ------ | ------- | +| dot | - | _  boolean
_ | - | `false` | +| info | - | _  string ¦ number
_ | - | `false` | +| title | - | _  ReactNode
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| titleStyle | - | _  string
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/tabbar/README.md b/packages/vantui-doc/src/tabbar/README.md index 21bf42d9f..1029195d2 100644 --- a/packages/vantui-doc/src/tabbar/README.md +++ b/packages/vantui-doc/src/tabbar/README.md @@ -136,32 +136,32 @@ function Demo() { ### 结合自定义 tabBar 请参考 [微信官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/customTabbar.html) 与 [代码片段](https://developers.weixin.qq.com/s/vaXgTsmQ7hnm)。 -### TabbarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| active | - | _  string ¦ number
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| fixed | - | _  boolean
_ | - | `false` | -| placeholder | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | - -### TabbarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| info | - | _  string
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| dot | - | _  boolean
_ | - | `false` | -| iconPrefix | - | _  string
_ | - | `false` | -| renderIconActive | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onClick | - | _  (name: string ¦ number) => void
_ | - | `false` | +### TabbarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| active | - | _  string ¦ number
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| fixed | - | _  boolean
_ | - | `false` | +| placeholder | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | + +### TabbarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ---------------------------------------------------------------------------------- | ------ | ------- | +| info | - | _  string
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| dot | - | _  boolean
_ | - | `false` | +| iconPrefix | - | _  string
_ | - | `false` | +| renderIconActive | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onClick | - | _  (name: string ¦ number) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/table/README.md b/packages/vantui-doc/src/table/README.md index 2ba7bb4e3..a0f7d027c 100644 --- a/packages/vantui-doc/src/table/README.md +++ b/packages/vantui-doc/src/table/README.md @@ -120,42 +120,43 @@ function Demo() { ) } ``` -### ITableProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/table.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| columns | 表格列配置描述 | _  IColumns[]
_ | - | `true` | -| dataSource | 数据源 | _  Record[]
_ | - | `true` | -| rowKey | 表哥行 key 的取值 | _  string // 表格行 key 的取值
_ | - | `true` | -| className | 最外层包裹节点 css 类名 | _  string
_ | - | `false` | -| style | 最外层包裹节点内联样式 | _  React.CSSProperties
_ | - | `false` | -| colStyle | 单元格统一样式 | _  React.CSSProperties
_ | - | `false` | -| colClassName | 单元格统一类名 | _  string
_ | - | `false` | -| rowStyle | 行统一样式 | _  React.CSSProperties
_ | - | `false` | -| rowClassName | 表格行 css 类名 | _  string
_ | - | `false` | -| titleStyle | 统一设置表头样式 | _  React.CSSProperties
_ | - | `false` | -| titleClassName | 统一设置表头单元格 css 类名 | _  string
_ | - | `false` | -| loading | 是否加载中 | _  boolean
_ | false | `false` | -| sortChange | 排序变化 | _  (columns: IColumns) => void
_ | () => void | `false` | -| placeholder | 数据为空的时候的占位字符 | _  React.ReactNode
_ | '--' | `false` | -| scroll | 表格是否可滚动，也可以指定滚动区域的宽、高 | _  {
    x?: number ¦ string ¦ boolean
    y?: number ¦ string ¦ boolean
  }
_ | - | `false` | - -### IColumns [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/table.d.ts) + +### ITableProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/table.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------------- | ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------- | +| columns | 表格列配置描述 | _  IColumns[]
_ | - | `true` | +| dataSource | 数据源 | _  Record[]
_ | - | `true` | +| rowKey | 表哥行 key 的取值 | _  string // 表格行 key 的取值
_ | - | `true` | +| className | 最外层包裹节点 css 类名 | _  string
_ | - | `false` | +| style | 最外层包裹节点内联样式 | _  React.CSSProperties
_ | - | `false` | +| colStyle | 单元格统一样式 | _  React.CSSProperties
_ | - | `false` | +| colClassName | 单元格统一类名 | _  string
_ | - | `false` | +| rowStyle | 行统一样式 | _  React.CSSProperties
_ | - | `false` | +| rowClassName | 表格行 css 类名 | _  string
_ | - | `false` | +| titleStyle | 统一设置表头样式 | _  React.CSSProperties
_ | - | `false` | +| titleClassName | 统一设置表头单元格 css 类名 | _  string
_ | - | `false` | +| loading | 是否加载中 | _  boolean
_ | false | `false` | +| sortChange | 排序变化 | _  (columns: IColumns) => void
_ | () => void | `false` | +| placeholder | 数据为空的时候的占位字符 | _  React.ReactNode
_ | '--' | `false` | +| scroll | 表格是否可滚动，也可以指定滚动区域的宽、高 | _  {
    x?: number ¦ string ¦ boolean
    y?: number ¦ string ¦ boolean
  }
_ | - | `false` | + +### IColumns [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/table.d.ts) + 表格列配置描述 | 参数 | 说明 | 类型 | | --- | --- | --- | | title | 标题 | _  string ¦ JSX.Element
_ | | dataIndex | 列数据在数据项中对应的路径 | _  string
_ | -| key | React组件key，可忽略 | _  string
_ | +| key | React 组件 key，可忽略 | _  string
_ | | align | 设置该列文本对齐方式 | _  "left" ¦ "right" ¦ "center"
_ | | style | 该列单元格内联样式 | _  React.CSSProperties
_ | | titleStyle | 该列表头内联样式 | _  React.CSSProperties
_ | | className | 该列单元格 css 类名 | _  string
_ | | titleClassName | 设置该列表头单元格 css 类名 | _  string
_ | | render | 自定义渲染函数 | _  (
    text?: any,
    record?: Record,
    index?: number
  ) => JSX.Element ¦ string
_ | -| width | 列宽，单位px | _  number
_ | +| width | 列宽，单位 px | _  number
_ | | sort | 表头是否显示排序按钮 | _  boolean
_ | | sortOrder | 排序的受控属性 | _  "ascend" ¦ "descend" ¦ undefined
_ | | fixed | 固定列 | _  "left" ¦ "right"
_ | | expandable | 该列是否启用点击展开收起功能，默认 true | _  boolean
_ | - diff --git a/packages/vantui-doc/src/tag/README.md b/packages/vantui-doc/src/tag/README.md index 08d58b495..3626f39af 100644 --- a/packages/vantui-doc/src/tag/README.md +++ b/packages/vantui-doc/src/tag/README.md @@ -182,18 +182,18 @@ function Demo() { ) } ``` -### TagProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tag.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| size | - | _  "large" ¦ "medium"
_ | - | `false` | -| mark | - | _  boolean
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| plain | - | _  boolean
_ | - | `false` | -| round | - | _  boolean
_ | - | `false` | -| textColor | - | _  string
_ | - | `false` | -| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "success"
    ¦ "danger"
    ¦ "warning"
_ | - | `false` | -| closeable | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onClose | - | _  (e: any) => void
_ | - | `false` | +### TagProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tag.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| size | - | _  "large" ¦ "medium"
_ | - | `false` | +| mark | - | _  boolean
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| plain | - | _  boolean
_ | - | `false` | +| round | - | _  boolean
_ | - | `false` | +| textColor | - | _  string
_ | - | `false` | +| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "success"
    ¦ "danger"
    ¦ "warning"
_ | - | `false` | +| closeable | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onClose | - | _  (e: any) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/toast/README.md b/packages/vantui-doc/src/toast/README.md index 44ded9a94..ba8ee09b5 100644 --- a/packages/vantui-doc/src/toast/README.md +++ b/packages/vantui-doc/src/toast/README.md @@ -160,25 +160,27 @@ Toast.show({ }, }) ``` -### ToastProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/toast.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| zIndex | 弹出层的层级 | _  number
_ | 1000 | `false` | -| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | _  number
_ | 2000 | `false` | -| mask | 是否有蒙层 | _  boolean
_ | false | `false` | -| forbidClick | 是否禁止背景点击 | _  boolean
_ | false | `false` | -| type | 提示类型 | _  attr:
    ¦ "loading"
    ¦ "success"
    ¦ "fail"
    ¦ "html"
    ¦ "text"
_ | text | `false` | -| position | 展示位置 | _  "top" ¦ "middle" ¦ "bottom"
_ | middle | `false` | -| message | 内容 | _  string ¦ ReactNode
_ | - | `false` | -| loadingType | 加载图标类型 | _  "circular" ¦ "spinner" ¦ undefined
_ | spinner | `false` | -| selector | 自定义选择器, 对应元素id | _  string
_ | van-toast | `false` | -| id | 设置id,配合selector使用 | _  string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onClose | 关闭时的回调函数 | _  () => any
_ | - | `false` | - -### Toast下命令式调用方法 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/toast.d.ts) -调用方式传入ToastProps或者ToastProps.message执行 +### ToastProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/toast.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------- | +| zIndex | 弹出层的层级 | _  number
_ | 1000 | `false` | +| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | _  number
_ | 2000 | `false` | +| mask | 是否有蒙层 | _  boolean
_ | false | `false` | +| forbidClick | 是否禁止背景点击 | _  boolean
_ | false | `false` | +| type | 提示类型 | _  attr:
    ¦ "loading"
    ¦ "success"
    ¦ "fail"
    ¦ "html"
    ¦ "text"
_ | text | `false` | +| position | 展示位置 | _  "top" ¦ "middle" ¦ "bottom"
_ | middle | `false` | +| message | 内容 | _  string ¦ ReactNode
_ | - | `false` | +| loadingType | 加载图标类型 | _  "circular" ¦ "spinner" ¦ undefined
_ | spinner | `false` | +| selector | 自定义选择器, 对应元素 id | _  string
_ | van-toast | `false` | +| id | 设置 id,配合 selector 使用 | _  string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onClose | 关闭时的回调函数 | _  () => any
_ | - | `false` | + +### Toast 下命令式调用方法 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/toast.d.ts) + +调用方式传入 ToastProps 或者 ToastProps.message 执行 | 参数 | 说明 | 类型 | 默认值 | 必填 | | --- | --- | --- | --- | --- | | show | - | _  (options: ToastProps ¦ string) => any
_ | - | `true` | @@ -188,4 +190,3 @@ Toast.show({ | clear | - | _  (options?: ToastProps) => void
_ | - | `true` | | setDefaultOptions | - | _  (options: ToastProps) => void
_ | - | `true` | | resetDefaultOptions | - | _  (options: any) => void
_ | - | `true` | - diff --git a/packages/vantui-doc/src/transition/README.md b/packages/vantui-doc/src/transition/README.md index e69a4da04..4224b5541 100644 --- a/packages/vantui-doc/src/transition/README.md +++ b/packages/vantui-doc/src/transition/README.md @@ -79,9 +79,9 @@ function Demo() { transform: rotate(-360deg) translate3d(-100%, -100%, 0); } ``` -### TransitionPropsCom [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/transition.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| children | - | _  ReactNode
_ | - | `false` | +### TransitionPropsCom [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/transition.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ---- | ---------------------------- | ------ | ------- | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/tree-select/README.md b/packages/vantui-doc/src/tree-select/README.md index 16b570c1e..68925c40a 100644 --- a/packages/vantui-doc/src/tree-select/README.md +++ b/packages/vantui-doc/src/tree-select/README.md @@ -184,18 +184,18 @@ function Demo() { ) } ``` -### TreeSelectProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tree-select.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| items | - | _  {
    text: number ¦ string
    badge?: number ¦ string
    dot?: boolean
    disabled?: boolean
    children?: {
      text: number ¦ string
      id: number ¦ string
      disabled?: boolean
    }[]
  }[]
_ | - | `false` | -| activeId | - | _  string ¦ number ¦ number[] ¦ string[]
_ | - | `false` | -| mainActiveIndex | - | _  number
_ | - | `false` | -| value | - | _  number
_ | - | `false` | -| height | - | _  number ¦ string
_ | - | `false` | -| max | - | _  number
_ | - | `false` | -| selectedIcon | - | _  string
_ | - | `false` | -| onClickItem | - | _  (
    event: TouchEvent & {
      detail: {
        text: string
        id: string ¦ number
        disabled?: boolean
      }
    }
  ) => void
_ | - | `false` | -| onClickNav | - | _  (event: {
    detail: { index: number }
  }) => void
_ | - | `false` | -| renderContent | - | _  ReactNode
_ | - | `false` | +### TreeSelectProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tree-select.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| items | - | _  {
    text: number ¦ string
    badge?: number ¦ string
    dot?: boolean
    disabled?: boolean
    children?: {
      text: number ¦ string
      id: number ¦ string
      disabled?: boolean
    }[]
  }[]
_ | - | `false` | +| activeId | - | _  string ¦ number ¦ number[] ¦ string[]
_ | - | `false` | +| mainActiveIndex | - | _  number
_ | - | `false` | +| value | - | _  number
_ | - | `false` | +| height | - | _  number ¦ string
_ | - | `false` | +| max | - | _  number
_ | - | `false` | +| selectedIcon | - | _  string
_ | - | `false` | +| onClickItem | - | _  (
    event: TouchEvent & {
      detail: {
        text: string
        id: string ¦ number
        disabled?: boolean
      }
    }
  ) => void
_ | - | `false` | +| onClickNav | - | _  (event: {
    detail: { index: number }
  }) => void
_ | - | `false` | +| renderContent | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/uploader/README.md b/packages/vantui-doc/src/uploader/README.md index 83ea50865..b3a6040c0 100644 --- a/packages/vantui-doc/src/uploader/README.md +++ b/packages/vantui-doc/src/uploader/README.md @@ -189,38 +189,38 @@ function Demo() { ) } ``` -### UploaderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/uploader.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| disabled | - | _  boolean
_ | - | `false` | -| multiple | - | _  boolean
_ | - | `false` | -| uploadText | - | _  string
_ | - | `false` | -| useBeforeRead | - | _  boolean
_ | - | `false` | -| afterRead | - | _  any
_ | - | `false` | -| beforeRead | - | _  any
_ | - | `false` | -| previewSize | - | _  string ¦ number
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| accept | - | _  attr:
    ¦ "all"
    ¦ "media"
    ¦ "image"
    ¦ "file"
    ¦ "video"
_ | - | `false` | -| fileList | - | _  Array
_ | - | `false` | -| maxSize | - | _  number
_ | - | `false` | -| maxCount | - | _  number
_ | - | `false` | -| deletable | - | _  boolean
_ | - | `false` | -| showUpload | - | _  boolean
_ | - | `false` | -| previewImage | - | _  boolean
_ | - | `false` | -| previewFullImage | - | _  boolean
_ | - | `false` | -| imageFit | - | _  keyof ImageProps.mode ¦ undefined
_ | - | `false` | -| uploadIcon | - | _  string
_ | - | `false` | -| sizeType | - | _  Array
_ | - | `false` | -| capture | - | _  string ¦ Array
_ | - | `false` | -| compressed | - | _  boolean
_ | - | `false` | -| maxDuration | - | _  number
_ | - | `false` | -| camera | - | _  "back" ¦ "front"
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onError | - | _  (error: any) => any
_ | - | `false` | -| onDelete | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onBeforeRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onAfterRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onOversize | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onClickPreview | - | _  (data: any) => any
_ | - | `false` | +### UploaderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/uploader.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| disabled | - | _  boolean
_ | - | `false` | +| multiple | - | _  boolean
_ | - | `false` | +| uploadText | - | _  string
_ | - | `false` | +| useBeforeRead | - | _  boolean
_ | - | `false` | +| afterRead | - | _  any
_ | - | `false` | +| beforeRead | - | _  any
_ | - | `false` | +| previewSize | - | _  string ¦ number
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| accept | - | _  attr:
    ¦ "all"
    ¦ "media"
    ¦ "image"
    ¦ "file"
    ¦ "video"
_ | - | `false` | +| fileList | - | _  Array
_ | - | `false` | +| maxSize | - | _  number
_ | - | `false` | +| maxCount | - | _  number
_ | - | `false` | +| deletable | - | _  boolean
_ | - | `false` | +| showUpload | - | _  boolean
_ | - | `false` | +| previewImage | - | _  boolean
_ | - | `false` | +| previewFullImage | - | _  boolean
_ | - | `false` | +| imageFit | - | _  keyof ImageProps.mode ¦ undefined
_ | - | `false` | +| uploadIcon | - | _  string
_ | - | `false` | +| sizeType | - | _  Array
_ | - | `false` | +| capture | - | _  string ¦ Array
_ | - | `false` | +| compressed | - | _  boolean
_ | - | `false` | +| maxDuration | - | _  number
_ | - | `false` | +| camera | - | _  "back" ¦ "front"
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onError | - | _  (error: any) => any
_ | - | `false` | +| onDelete | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onBeforeRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onAfterRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onOversize | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onClickPreview | - | _  (data: any) => any
_ | - | `false` |