uview-plus 3.2.3 → 3.2.5

package/types/comps/datetimePicker.d.ts

@@ -0,0 +1,146 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface DatetimePickerProps {
+  /**
+   * 用于控制选择器的弹出与收起
+   * @default false
+   */
+  show?: boolean
+  /**
+   * 是否显示顶部的操作栏
+   * @default true
+   */
+  showToolbar?: boolean
+  /**
+   * 绑定值
+   */
+  ['v-model']?: string | number
+  /**
+   * 顶部标题
+   */
+  title?: string
+  /**
+   * 展示格式
+   * @default "datetime"
+   */
+  mode?: 'datetime' | 'date' | 'time' | 'year-month'
+  /**
+   * 可选的最大时间（时间戳毫秒）
+   * @default 最大默认值为后10年
+   */
+  maxDate?: number
+  /**
+   * 可选的最小时间（时间戳毫秒）
+   * @default 最小默认值为前10年
+   */
+  minDate?: number
+  /**
+   * 可选的最小小时，仅mode=time有效
+   * @default 0
+   */
+  minHour?: number
+  /**
+   * 可选的最大小时，仅mode=time有效
+   * @default 23
+   */
+  maxHour?: number
+  /**
+   * 可选的最小分钟，仅mode=time有效
+   * @default 0
+   */
+  minMinute?: number
+  /**
+   * 可选的最大分钟，仅mode=time有效
+   * @default 59
+   */
+  maxMinute?: number
+  /**
+   * 选项过滤函数
+   * @default null
+   */
+  filter?: (...args: any) => any
+  /**
+   * 输入过滤或格式化函数(如需兼容微信小程序，则只能通过`setFormatter`方法)
+   * @default null
+   */
+  formatter?: (...args: any) => any
+  /**
+   * 是否显示加载中状态
+   * @default false
+   */
+  loading?: boolean
+  /**
+   * 各列中，单个选项的高度
+   * @default 44
+   */
+  itemHeight?: string | number
+  /**
+   * 取消按钮的文字
+   * @default "取消"
+   */
+  cancelText?: string
+  /**
+   * 确认按钮的文字
+   * @default "确认"
+   */
+  confirmText?: string
+  /**
+   * 取消按钮的颜色
+   * @default "#909193"
+   */
+  cancelColor?: string
+  /**
+   * 确认按钮的颜色
+   * @default "#3c9cff"
+   */
+  confirmColor?: string
+  /**
+   * 每列中可见选项的数量
+   * @default 5
+   */
+  visibleItemCount?: string | number
+  /**
+   * 是否允许点击遮罩关闭选择器（注意：关闭事件需要自行处理，只会在开启closeOnClickOverlay后点击遮罩层执行close回调）
+   * @default false
+   */
+  closeOnClickOverlay?: boolean
+  /**
+   * 各列的默认索引
+   */
+  defaultIndex?: any[]
+  /**
+   * 关闭选择器时触发
+   */
+  onClose?: () => any
+  /**
+   * 点击确定按钮，返回当前选择的值
+   */
+  onConfirm?: () => any
+  /**
+   * 当选择值变化时触发
+   */
+  onChange?: () => any
+  /**
+   * 点击取消按钮
+   */
+  onCancel?: () => any
+}
+
+declare interface _DatetimePickerRef {
+  /**
+   * 为兼容微信小程序而暴露的内部方法，详见[文档](https://www.uviewui.com/components/datetimePicker.html#%E6%A0%BC%E5%BC%8F%E5%8C%96)
+   */
+  setFormatter: (type, value) => any
+}
+
+declare interface _DatetimePicker {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      DatetimePickerProps
+  }
+}
+
+export declare const DatetimePicker: _DatetimePicker
+
+export declare const DatetimePickerRef: _DatetimePickerRef

package/types/comps/divider.d.ts

@@ -0,0 +1,58 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface DividerProps {
+  /**
+   * 是否虚线
+   * @default false
+   */
+  dashed?: boolean
+  /**
+   * 是否细线
+   * @default true
+   */
+  hairline?: boolean
+  /**
+   * 是否以点替代文字，优先于text字段起作用
+   * @default false
+   */
+  dot?: boolean
+  /**
+   * 内容文本的位置
+   * @default "center"
+   */
+  textPosition?: 'left' | 'center' | 'right'
+  /**
+   * 文本内容
+   */
+  text?: string | number
+  /**
+   * 文本大小
+   * @default 14
+   */
+  textSize?: string | number
+  /**
+   * 文本颜色
+   * @default #909399
+   */
+  textColor?: string
+  /**
+   * 线条颜色
+   * @default #dcdfe6
+   */
+  lineColor?: string
+  /**
+   * divider组件被点击时触发
+   */
+  onClick?: () => any
+}
+
+declare interface _Divider {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      DividerProps
+  }
+}
+
+export declare const Divider: _Divider
+

package/types/comps/empty.d.ts

@@ -0,0 +1,72 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface EmptyProps {
+  /**
+   * 内置图标名称，或图片路径，建议绝对路径
+   */
+  icon?: string
+  /**
+   * 文字提示
+   */
+  text?: string
+  /**
+   * 文字颜色
+   * @default "#c0c4cc"
+   */
+  textColor?: string
+  /**
+   * 文字大小
+   * @default 14
+   */
+  textSize?: string | number
+  /**
+   * 图标的颜色
+   * @default "#c0c4cc"
+   */
+  iconColor?: string
+  /**
+   * 图标的大小
+   * @default 90
+   */
+  iconSize?: string | number
+  /**
+   * 内置的图标，详细见[文档](https://www.uviewui.com/components/empty.html#%E5%86%85%E7%BD%AE%E5%9B%BE%E6%A0%87)
+   * @default "data"
+   */
+  mode?: string
+  /**
+   * 图标的宽度，单位px
+   * @default 160
+   */
+  width?: string | number
+  /**
+   * 图标的高度，单位px
+   * @default 160
+   */
+  height?: string | number
+  /**
+   * 是否显示组件
+   * @default true
+   */
+  show?: boolean
+  /**
+   * 组件到上一个元素的间距,单位px
+   * @default 0
+   */
+  marginTop?: string | number
+}
+
+declare interface EmptySlots {
+  ['default']?: () => any
+}
+
+declare interface _Empty {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      EmptyProps
+    $slots: EmptySlots
+  }
+}
+
+export declare const Empty: _Empty

package/types/comps/form.d.ts

@@ -0,0 +1,76 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface FormProps {
+  /**
+   * 表单数据对象
+   */
+  model?: Record<string, any>
+  /**
+   * 通过ref设置，如果rules中有自定义方法等，需要使用setRules方法设置规则，详见[文档](https://www.uviewui.com/components/form.html#%E9%AA%8C%E8%AF%81%E8%A7%84%E5%88%99)
+   */
+  rules?: Record<string, any>
+  /**
+   * 错误的提示方式
+   * @default "message"
+   */
+  errorType?: 'message' | 'none' | 'toast' | 'border-bottom' | 'none'
+  /**
+   * 是否显示表单域的下划线边框
+   * @default true
+   */
+  borderBottom?: boolean
+  /**
+   * 表单域提示文字的位置，left-左侧，top-上方
+   * @default "left"
+   */
+  labelPosition?: 'left' | 'top'
+  /**
+   * 提示文字的宽度，单位px
+   * @default 45
+   */
+  labelWidth?: string | number
+  /**
+   * lable字体的对齐方式
+   * @default "left"
+   */
+  labelAlign?: 'left' | 'center' | 'right'
+  /**
+   * lable的样式
+   */
+  labelStyle?: unknown
+}
+
+declare interface _FormRef {
+  /**
+   * 对整个表单进行校验的方法
+   */
+  validate: () => any
+  /**
+   * 如果`rules`中有自定义方法等，需要用此方法设置`rules`规则，否则微信小程序无效
+   */
+  setRules: (rules: any) => any
+  /**
+   * 对部分表单字段进行校验
+   */
+  validateField: (value, cb: ((errorsRes) => any)) => any
+  /**
+   * 对整个表单进行重置，将所有字段值重置为初始值并移除校验结果
+   */
+  resetFields: () => any
+  /**
+   * 清空校验结果
+   */
+  clearValidate: (props: any) => any
+}
+
+declare interface _Form {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      FormProps
+  }
+}
+
+export declare const Form: _Form
+
+export declare const FormRef: _FormRef

package/types/comps/formItem.d.ts

@@ -0,0 +1,68 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface FormItemProps {
+  /**
+   * 左侧提示文字
+   */
+  label?: string
+  /**
+   * 表单域`model`对象的属性名，在使用 validate、resetFields 方法的情况下，该属性是必填的
+   */
+  prop?: string
+  /**
+   * 是否显示下边框，如不需要下边框，需同时将u-form的同名参数设置为false
+   * @default true
+   */
+  borderBottom?: boolean
+  /**
+   * 提示文字的宽度，单位rpx，如设置，将覆盖`u-form`的同名参数
+   */
+  labelWidth?: string | number
+  /**
+   * label的位置
+   */
+  labelPosition?: 'left' | 'top'
+  /**
+   * 右侧自定义字体图标(限uView内置图标)或图片地址
+   */
+  rightIcon?: string
+  /**
+   * 左侧自定义字体图标(限uView内置图标)或图片地址
+   */
+  leftIcon?: string
+  /**
+   * 左侧自定义字体图标的样式
+   */
+  leftIconStyle?: unknown
+  /**
+   * 是否显示左边的"*"号，这里仅起展示作用，如需校验必填，请通过rules配置必填规则，如需在swiper标签内显示星号，需要给予swiper-item内第一个根节点一定的margin样式
+   * @default false
+   */
+  required?: boolean
+  /**
+   * 点击时触发
+   */
+  onClick?: () => any
+}
+
+declare interface FormItemSlots {
+  /**
+   * Form Item 的内容
+   */
+  ['default']?: () => any
+  /**
+   * 右侧自定义内容，可以在此传入一个按钮，用于获取验证码等场景
+   */
+  ['right']?: () => any
+}
+
+declare interface _FormItem {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      FormItemProps
+    $slots: FormItemSlots
+  }
+}
+
+export declare const FormItem: _FormItem

package/types/comps/gap.d.ts

@@ -0,0 +1,35 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface GapProps {
+  /**
+   * 背景颜色
+   * @default "transparent"
+   */
+  bgColor?: string
+  /**
+   * 间隔槽高度，单位px
+   * @default 20
+   */
+  height?: string | number
+  /**
+   * 与前一个元素的距离，单位px
+   * @default 0
+   */
+  marginTop?: string | number
+  /**
+   * 与后一个元素的距离，单位px
+   * @default 0
+   */
+  marginBottom?: string | number
+}
+
+declare interface _Gap {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      GapProps
+  }
+}
+
+export declare const Gap: _Gap
+

package/types/comps/grid.d.ts

@@ -0,0 +1,34 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface GridProps {
+  /**
+   * 宫格的列数
+   * @default 3
+   */
+  col?: string | number
+  /**
+   * 是否显示宫格的边框
+   * @default true
+   */
+  border?: boolean
+  /**
+   * 宫格的对齐方式，用于控制只有一两个宫格时的对齐场景
+   * @default "left"
+   */
+  align?: 'left' | 'center' | 'right'
+  /**
+   * 点击宫格触发
+   * @param name `grid-item` 的 `name`
+   */
+  onClick?: (name: any) => any
+}
+
+declare interface _Grid {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      GridProps
+  }
+}
+
+export declare const Grid: _Grid

package/types/comps/gridItem.d.ts

@@ -0,0 +1,28 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface GridItemProps {
+  /**
+   * 宫格的name
+   */
+  name?: string | number
+  /**
+   * 宫格的背景颜色
+   * @default "transparent"
+   */
+  bgColor?: string
+  /**
+   * 点击宫格触发
+   * @param name `grid-item` 的 `name`
+   */
+  onClick?: (name: any) => any
+}
+
+declare interface _GridItem {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      GridItemProps
+  }
+}
+
+export declare const GridItem: _GridItem

package/types/comps/icon.d.ts

@@ -0,0 +1,93 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+import { ImageMode } from './image'
+
+declare interface IconProps {
+  /**
+   * 图标名称，如名称带有`/`，会被认为是图片图标
+   */
+  name?: string
+  /**
+   * 图标颜色
+   * @default "color['u-content-color']"
+   */
+  color?: string
+  /**
+   * 图标字体大小，单位默认px
+   * @default "16px"
+   */
+  size?: string | number
+  /**
+   * 是否显示粗体
+   * @default false
+   */
+  bold?: boolean
+  /**
+   * 一个用于区分多个图标的值，点击图标时通过`click`事件传出
+   */
+  index?: string | number
+  /**
+   * 图标按下去的样式类，用法同uni的`view`组件的`hover-class`参数，详见：[hover-class](https://uniapp.dcloud.io/component/view)
+   */
+  hoverClass?: string
+  /**
+   * 图标右侧/下方的label文字
+   */
+  label?: string | number
+  /**
+   * `label`相对于图标的位置
+   * @default "right"
+   */
+  labelPos?: 'right' | 'bottom' | 'top' | 'left'
+  /**
+   * `label`字体大小，单位默认px
+   * @default "15px"
+   */
+  labelSize?: string | number
+  /**
+   * `label`字体颜色
+   * @default "color['u-content-color']"
+   */
+  labelColor?: string
+  /**
+   * `label`与图标的距离，单位默认px
+   * @default "3px"
+   */
+  space?: string | number
+  /**
+   * 裁剪模式
+   */
+  imgMode?: ImageMode
+  /**
+   * `name`为图片路径时图片的宽度，单位默认px
+   */
+  width?: string | number
+  /**
+   * `name`为图片路径时图片的高度，单位默认px
+   */
+  height?: string | number
+  /**
+   * 图标到顶部的距离，如果某些场景，如果图标没有垂直居中，可以调整此参数，单位默认px
+   * @default 0
+   */
+  top?: string | number
+  /**
+   * 是否阻止事件传播
+   * @default false
+   */
+  stop?: boolean
+  /**
+   * 点击图标时触发
+   * @param index 通过`props`传递的`index`值
+   */
+  onClick?: (index: any) => any
+}
+
+declare interface _Icon {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      IconProps
+  }
+}
+
+export declare const Icon: _Icon