uview-plus 3.2.3 → 3.2.5

package/types/comps/avatarGroup.d.ts

@@ -0,0 +1,62 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+import { ImageMode } from './image'
+
+declare interface AvatarGroupProps {
+  /**
+   * 头像图片组
+   * @default []
+   */
+  urls?: string[]
+  /**
+   * 最多展示的头像数量
+   * @default 5
+   */
+  maxCount?: string | number
+  /**
+   * 头像形状
+   * @default "circle"
+   */
+  shape?: 'circle' | 'square'
+  /**
+   * 裁剪模式
+   * @default "aspectFill"
+   */
+  mode?: ImageMode
+  /**
+   * 超出maxCount时是否显示查看更多的提示
+   * @default true
+   */
+  showMore?: boolean
+  /**
+   * 头像大小
+   * @default 40
+   */
+  size?: string | number
+  /**
+   * 指定从数组的对象元素中读取哪个属性作为图片地址
+   */
+  keyName?: string
+  /**
+   * 头像之间的遮挡比例（0.4代表遮挡40%）
+   * @default 0.5
+   */
+  gap?: string | number
+  /**
+   * 需额外显示的值，如设置则优先于内部的`urls.length - maxCount`值
+   */
+  extraValue?: string | number
+  /**
+   * 头像组更多点击
+   */
+  onShowMore?: () => any
+}
+
+declare interface _AvatarGroup {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      AvatarGroupProps
+  }
+}
+
+export declare const AvatarGroup: _AvatarGroup

package/types/comps/backTop.d.ts

@@ -0,0 +1,74 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface BackTopProps {
+  /**
+   * 按钮形状
+   * @default "circle"
+   */
+  mode?: 'circle' | 'square'
+  /**
+   * uView内置图标名称，或图片路径
+   * @default "arrow-upward"
+   */
+  icon?: string
+  /**
+   * 返回顶部按钮的提示文字
+   */
+  text?: string
+  /**
+   * 返回顶部过程中的过渡时间，单位ms
+   * @default 100
+   */
+  duration?: string | number
+  /**
+   * 页面的滚动距离，通过`onPageScroll`生命周期获取
+   * @default 0
+   */
+  scrollTop?: string | number
+  /**
+   * 滚动条滑动多少距离时显示，单位rpx
+   * @default 400
+   */
+  top?: string | number
+  /**
+   * 返回按钮位置到屏幕底部的距离，单位rpx
+   * @default 100
+   */
+  bottom?: string | number
+  /**
+   * 返回按钮位置到屏幕右边的距离，单位rpx
+   * @default 20
+   */
+  right?: string | number
+  /**
+   * 返回顶部按钮的层级
+   * @default 9
+   */
+  zIndex?: string | number
+  /**
+   * 图标的样式
+   */
+  iconStyle?: unknown
+  /**
+   * 按钮外层的自定义样式
+   */
+  customStyle?: unknown
+}
+
+declare interface BackTopSlots {
+  /**
+   * 自定义返回按钮的所有内容
+   */
+  ['default']?: () => any
+}
+
+declare interface _BackTop {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      BackTopProps
+    $slots: BackTopSlots
+  }
+}
+
+export declare const BackTop: _BackTop

package/types/comps/badge.d.ts

@@ -0,0 +1,76 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface BadgeProps {
+  /**
+   * 不展示数字，只有一个小点
+   * @default false
+   */
+  isDot?: boolean
+  /**
+   * 展示的数字，大于`overflowCount`时显示为`${overflowCount}+`，为`0`且`show-zero`为`false`时隐藏
+   */
+  value?: string | number
+  /**
+   * 组件是否显示
+   * @default true
+   */
+  show?: boolean
+  /**
+   * 最大值，超过最大值会显示 '{max}+'
+   * @default 99
+   */
+  max?: string | number
+  /**
+   * 主题类型
+   * @default "error"
+   */
+  type?: 'error' | 'warning' | 'success' | 'primary' | 'info'
+  /**
+   * 当数值为 0 时，是否展示 Badge
+   * @default false
+   */
+  showZero?: boolean
+  /**
+   * 背景颜色，优先级比`type`高，如设置，`type`参数会失效
+   */
+  bgColor?: string
+  /**
+   * 字体颜色
+   * @default "#fff"
+   */
+  color?: string
+  /**
+   * 徽标形状，circle-四角均为圆角，horn-左下角为直角
+   * @default "circle"
+   */
+  shape?: 'circle' | 'horn'
+  /**
+   * 置数字的显示方式，详细见[文档](https://www.uviewui.com/components/badge.html#%E8%AE%BE%E7%BD%AE%E6%95%B0%E5%AD%97%E7%9A%84%E6%98%BE%E7%A4%BA%E6%96%B9%E5%BC%8F-overflow-ellipsis-limit)
+   * @default "overflow"
+   */
+  numberType?: 'overflow' | 'ellipsis' | 'limit'
+  /**
+   * 设置badge的位置偏移，格式为 [x, y]，也即设置的为`top`和`right`的值，`absolute`为`true`时有效
+   */
+  offset?: string[]
+  /**
+   * 是否反转背景和字体颜色
+   * @default false
+   */
+  inverted?: boolean
+  /**
+   * 组件是否绝对定位，为`true`时，`offset`参数才有效
+   * @default false
+   */
+  absolute?: boolean
+}
+
+declare interface _Badge {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      BadgeProps
+  }
+}
+
+export declare const Badge: _Badge

package/types/comps/button.d.ts

@@ -0,0 +1,169 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface ButtonProps {
+  /**
+   * 是否显示按钮的细边框
+   * @default true
+   */
+  hairline?: boolean
+  /**
+   * 按钮的样式类型
+   * @default "info"
+   */
+  type?: 'info' | 'primary' | 'error' | 'warning' | 'success'
+  /**
+   * 按钮的大小
+   * @default "normal"
+   */
+  size?: 'normal' | 'large' | 'mini'
+  /**
+   * 按钮外观形状
+   * @default "square"
+   */
+  shape?: 'square' | 'circle'
+  /**
+   * 按钮是否镂空
+   * @default false
+   */
+  plain?: boolean
+  /**
+   * 是否禁用
+   * @default false
+   */
+  disabled?: boolean
+  /**
+   * 按钮名称前是否带 loading 图标
+   * @default false
+   */
+  loading?: boolean
+  /**
+   * 加载中提示文字
+   */
+  loadingText?: string
+  /**
+   * 加载状态图标类型
+   * @default "spinner"
+   */
+  loadingMode?: string
+  /**
+   * 加载图标大小
+   * @default 15
+   */
+  loadingSize?: string | number
+  /**
+   * 开放能力，具体请看 [button](https://uniapp.dcloud.net.cn/component/button.html#open-type-%E6%9C%89%E6%95%88%E5%80%BC)
+   */
+  openType?: string
+  /**
+   * 用于 <form> 组件
+   */
+  formType?: 'submit' | 'reset'
+  /**
+   * 打开 APP 时，向 APP 传递的参数，open-type=launchApp时有效 （注：只微信小程序、QQ小程序有效）
+   */
+  appParameter?: string
+  /**
+   * 指定是否阻止本节点的祖先节点出现点击态，微信小程序有效
+   * @default true
+   */
+  hoverStopPropagation?: boolean
+  /**
+   * 指定返回用户信息的语言
+   * @default "en"
+   */
+  lang?: 'en' | 'zh_CN' | 'zh_TW'
+  /**
+   * 会话来源，openType="contact"时有效
+   */
+  sessionFrom?: string
+  /**
+   * 会话内消息卡片标题，openType="contact"时有效
+   */
+  sendMessageTitle?: string
+  /**
+   * 会话内消息卡片点击跳转小程序路径，openType="contact"时有效
+   */
+  sendMessagePath?: string
+  /**
+   * 会话内消息卡片图片，openType="contact"时有效
+   */
+  sendMessageImg?: string
+  /**
+   * 是否显示会话内消息卡片，设置此参数为 true，用户进入客服会话会在右下角显示"可能要发送的小程序"提示，用户点击后可以快速发送小程序消息，openType="contact"时有效
+   */
+  showMessageCard?: string
+  /**
+   * 额外传参参数，用于小程序的data-xxx属性，通过target.dataset.name获取
+   */
+  dataName?: string
+  /**
+   * 节流，一定时间内只能触发一次，单位毫秒
+   * @default 0
+   */
+  throttleTime?: string | number
+  /**
+   * 按住后多久出现点击态，单位毫秒
+   * @default 0
+   */
+  hoverStartTime?: string | number
+  /**
+   * 手指松开后点击态保留时间，单位毫秒
+   * @default 200
+   */
+  hoverStayTime?: string | number
+  /**
+   * 	按钮文字，之所以通过props传入，是因为slot传入的话（注：nvue中无法控制文字的样式）
+   */
+  text?: string | number
+  /**
+   * 按钮图标
+   */
+  icon?: string
+  /**
+   * 按钮颜色
+   */
+  iconColor?: string
+  /**
+   * 按钮颜色，支持传入linear-gradient渐变色
+   */
+  color?: string
+  /**
+   * 定义需要用到的外部样式
+   */
+  customStyle?: unknown
+  /**
+   * 按钮点击，请勿使用@tap点击事件，微信小程序无效，返回值为点击事件及参数
+   */
+  onClick?: (...args: any) => any
+  /**
+   * open-type="getPhoneNumber"时有效
+   */
+  onGetphonenumber?: (...args: any) => any
+  /**
+   * 获取用户信息回调，openType="getUserInfo"时有效
+   * @param detail 用户信息
+   */
+  onGetuserinfo?: (detail: any) => any
+  /**
+   * 当使用开放能力时，发生错误的回调
+   */
+  onError?: (...args: any) => any
+  /**
+   * 在打开授权设置页并关闭后回调
+   */
+  onOpensetting?: (...args: any) => any
+  /**
+   * 打开 APP 成功的回调
+   */
+  onLaunchapp?: (...args: any) => any
+}
+
+declare interface _Button {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      ButtonProps
+  }
+}
+
+export declare const Button: _Button

package/types/comps/calendar.d.ts

@@ -0,0 +1,164 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface CalendarProps {
+  /**
+   * 标题内容
+   * @default "日期选择"
+   */
+  title?: string
+  /**
+   * 是否显示标题
+   * @default true
+   */
+  showTitle?: boolean
+  /**
+   * 是否显示副标题
+   * @default true
+   */
+  showSubtitle?: boolean
+  /**
+   * 日期类型选择
+   * @default 'single
+   */
+  mode?: 'single' | 'multiple' | 'range'
+  /**
+   * mode=range时，第一个日期底部的提示文字
+   * @default "开始"
+   */
+  startText?: string
+  /**
+   * mode=range时，最后一个日期底部的提示文字
+   * @default "结束"
+   */
+  endText?: string
+  /**
+   * 自定义列表
+   */
+  customList?: any[]
+  /**
+   * 主题色，对底部按钮和选中日期有效
+   * @default "#3c9cff"
+   */
+  color?: string
+  /**
+   * 最小的可选日期
+   * @default 0
+   */
+  minDate?: string | number
+  /**
+   * 最大可选日期
+   * @default 0
+   */
+  maxDate?: string | number
+  /**
+   * 默认选中的日期，mode为multiple或range是必须为数组格式
+   * @default null
+   */
+  defaultDate?: string | Date | any[]
+  /**
+   * mode=multiple时，最多可选多少个日期
+   * @default Number.MAX_SAFE_INTEGER
+   */
+  maxCount?: string | number
+  /**
+   * 日期行高
+   * @default 56
+   */
+  rowHeight?: string | number
+  /**
+   * 日期格式化函数(如需兼容微信小程序，则只能通过setFormatter方法)
+   */
+  formatter?: (...args: any) => any
+  /**
+   * 是否显示农历
+   * @default false
+   */
+  showLunar?: boolean
+  /**
+   * 是否显示月份背景色
+   * @default true
+   */
+  showMark?: boolean
+  /**
+   * 确定按钮的文字
+   * @default "确定"
+   */
+  confirmText?: string
+  /**
+   * 确认按钮处于禁用状态时的文字
+   * @default "确定"
+   */
+  confirmDisabledText?: string
+  /**
+   * 是否显示日历弹窗
+   * @default false
+   */
+  show?: boolean
+  /**
+   * 是否允许点击遮罩关闭日历 （注意：关闭事件需要自行处理，只会在开启closeOnClickOverlay后点击遮罩层执行close回调）
+   * @default false
+   */
+  closeOnClickOverlay?: boolean
+  /**
+   * 是否为只读状态，只读状态下禁止选择日期
+   * @default false
+   */
+  readonly?: boolean
+  /**
+   * 日期区间最多可选天数，默认无限制，mode = range时有效
+   * @default 无限制
+   */
+  maxRange?: string | number
+  /**
+   * 范围选择超过最多可选天数时的提示文案，mode = range时有效
+   * @default "选择天数不能超过 xx 天"
+   */
+  rangePrompt?: string | null
+  /**
+   * 范围选择超过最多可选天数时，是否展示提示文案，mode = range时有效
+   * @default true
+   */
+  showRangePrompt?: boolean
+  /**
+   * 是否允许日期范围的起止时间为同一天，mode = range时有效
+   * @default false
+   */
+  allowSameDay?: boolean
+  /**
+   * 圆角值，默认无圆角
+   * @default 0
+   */
+  round?: string | number
+  /**
+   * 最大展示的月份数量
+   * @default 3
+   */
+  monthNum?: string | number
+  /**
+   * 日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发
+   */
+  onConfirm?: (...args: any) => any
+  /**
+   * 日历关闭时触发
+   */
+  onClose?: () => any
+}
+
+declare interface _Calendar {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      CalendarProps
+  }
+}
+
+declare interface _CalendarRef {
+  /**
+   * 为兼容微信小程序而暴露的内部方法，详见[文档](https://www.uviewui.com/components/calendar.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%87%E6%A1%88)
+   */
+  setFormatter: (type, value) => any
+}
+
+export declare const Calendar: _Calendar
+
+export declare const CalendarRef: _CalendarRef

package/types/comps/cell.d.ts

@@ -0,0 +1,133 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface CellProps {
+  /**
+   * 左侧标题
+   */
+  title?: string | number
+  /**
+   * 标题下方的描述信息
+   */
+  label?: string | number
+  /**
+   * 右侧的内容
+   */
+  value?: string | number
+  /**
+   * 左侧图标名称，或者图片链接(本地文件建议使用绝对地址)
+   */
+  icon?: string
+  /**
+   * 是否禁用cell
+   * @default false
+   */
+  disabled?: boolean
+  /**
+   * 是否显示下边框
+   * @default true
+   */
+  border?: boolean
+  /**
+   * 内容是否垂直居中(主要是针对右侧的value部分)
+   * @default false
+   */
+  center?: boolean
+  /**
+   * 点击后跳转的URL地址
+   */
+  url?: string
+  /**
+   * 链接跳转的方式，内部使用的是uView封装的route方法，可能会进行拦截操作
+   * @default "navigateTo"
+   */
+  linkType?: string
+  /**
+   * 是否开启点击反馈(表现为点击时加上灰色背景)
+   * @default false
+   */
+  clickable?: boolean
+  /**
+   * 是否展示右侧箭头并开启点击反馈
+   * @default false
+   */
+  isLink?: boolean
+  /**
+   * 是否显示表单状态下的必填星号(此组件可能会内嵌入input组件)
+   * @default false
+   */
+  required?: boolean
+  /**
+   * 右侧的图标箭头
+   * @default "arrow-right"
+   */
+  rightIcon?: string
+  /**
+   * 右侧箭头的方向
+   * @default "right"
+   */
+  arrowDirection?: 'left' | 'right' | 'up' | 'down'
+  /**
+   * 左侧图标样式
+   */
+  iconStyle?: unknown
+  /**
+   * 右侧箭头图标的样式
+   */
+  rightIconStyle?: unknown
+  /**
+   * 标题的样式
+   */
+  titleStyle?: unknown
+  /**
+   * 单位元的大小，可选值为large
+   */
+  size?: string
+  /**
+   * 点击cell是否阻止事件传播
+   * @default true
+   */
+  stop?: boolean
+  /**
+   * 标识符，用于在`click`事件中进行返回
+   */
+  name?: string | number
+  /**
+   * 点击cell列表时触发
+   * @param name `props`的`name`参数标识符
+   */
+  onClick?: (name: any) => any
+}
+
+declare interface CellSlots {
+  /**
+   * 自定义左侧标题部分的内容，如需使用，请勿定义`title`参数，或赋值`null`即可
+   */
+  ['title']?: () => any
+  /**
+   * 自定义右侧标题部分的内容，如需使用，请勿定义`value`参数，或赋值`null`即可
+   */
+  ['value']?: () => any
+  /**
+   * 自定义左侧的图标
+   */
+  ['icon']?: () => any
+  /**
+   * 自定义右侧图标内容，需设置`arrow`为`false`才起作用
+   */
+  ['right-icon']?: () => any
+  /**
+   * 自定义label内容
+   */
+  ['label']?: () => any
+}
+
+declare interface _Cell {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      CellProps
+    $slots: CellSlots
+  }
+}
+
+export declare const Cell: _Cell

package/types/comps/cellGroup.d.ts

@@ -0,0 +1,27 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface CellGroupProps {
+  /**
+   * 分组标题
+   */
+  title?: string
+  /**
+   * 是否显示外边框
+   * @default true
+   */
+  border?: boolean
+  /**
+   * 用户自定义外部样式，对象形式
+   */
+  customStyle?: unknown
+}
+
+declare interface _CellGroup {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      CellGroupProps
+  }
+}
+
+export declare const CellGroup: _CellGroup