uview-plus 3.1.52 → 3.2.5

package/types/comps/album.d.ts

@@ -0,0 +1,72 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface AlbumProps {
+  /**
+   * 图片地址列表
+   */
+  urls?: string[] | Record<string, any>[]
+  /**
+   * 指定从数组的对象元素中读取哪个属性作为图片地址
+   */
+  keyName?: string
+  /**
+   * 单图时，图片长边的长度
+   * @default 180
+   */
+  singleSize?: string | number
+  /**
+   * 多图时，图片边长
+   * @default 70
+   */
+  multipleSize?: string | number
+  /**
+   * 多图时，图片水平和垂直之间的间隔
+   * @default 6
+   */
+  space?: string | number
+  /**
+   * 单图时，图片缩放裁剪的模式
+   * @default "scaleToFill"
+   */
+  singleMode?: ImageMode
+  /**
+   * 多图时，图片缩放裁剪的模式
+   * @default "aspectFill"
+   */
+  multipleMode?: ImageMode
+  /**
+   * 最多展示的图片数量，超出时最后一个位置将会显示剩余图片数量
+   * @default 9
+   */
+  maxCount?: string | number
+  /**
+   * 是否可以预览图片
+   * @default true
+   */
+  previewFullImage?: boolean
+  /**
+   * 每行展示图片数量，如设置，singleSize和multipleSize将会无效
+   * @default 3
+   */
+  rowCount?: string | number
+  /**
+   * 超出maxCount时是否显示查看更多的提示
+   * @default true
+   */
+  showMore?: boolean
+  /**
+   * 某些特殊的情况下，需要让文字与相册的宽度相等，这里事件的形式对外发送
+   * @param width 宽度
+   */
+  onAlbumWidth?: (width: any) => any
+}
+
+declare interface _Album {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      AlbumProps
+  }
+}
+
+export declare const Album: _Album

package/types/comps/alert.d.ts

@@ -0,0 +1,55 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface AlertProps {
+  /**
+   * 显示的文字
+   */
+  title?: string
+  /**
+   * 使用预设的颜色
+   * @default "warning"
+   */
+  type?: 'warning' | 'success' | 'primary' | 'error' | 'info'
+  /**
+   * 辅助性文字，颜色比`title`浅一点，字号也小一点，可选
+   */
+  description?: string
+  /**
+   * 关闭按钮(默认为叉号icon图标)
+   * @default false
+   */
+  closable?: boolean
+  /**
+   * 是否显示左边的辅助图标
+   * @default false
+   */
+  showIcon?: boolean
+  /**
+   * 多图时，图片缩放裁剪的模式
+   */
+  effect?: 'light' | 'dark'
+  /**
+   * 文字是否居中
+   * @default false
+   */
+  center?: boolean
+  /**
+   * 字体大小
+   * @default 14
+   */
+  fontSize?: string | number
+  /**
+   * 点击组件时触发
+   */
+  onClick?: () => any
+}
+
+declare interface _Alert {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      AlertProps
+  }
+}
+
+export declare const Alert: _Alert

package/types/comps/avatar.d.ts

@@ -0,0 +1,85 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+import { ImageMode } from './image'
+
+declare interface AvatarProps {
+  /**
+   * 头像路径，如加载失败，将会显示默认头像(不能为相对路径)
+   */
+  src?: string
+  /**
+   * 头像形状
+   * @default "circle"
+   */
+  shape?: 'circle' | 'square'
+  /**
+   * 头像尺寸
+   * @default 40
+   */
+  size?: 'large' | 'default' | 'mini' | number
+  /**
+   * 裁剪类型
+   * @default "scaleToFill"
+   */
+  mode?: ImageMode
+  /**
+   * 用文字替代图片，级别优先于`src`
+   */
+  text?: string
+  /**
+   * 背景颜色
+   * @default "#c0c4cc"
+   */
+  bgColor?: string
+  /**
+   * 文字颜色
+   * @default "#fff"
+   */
+  color?: string
+  /**
+   * 文字大小
+   * @default 18
+   */
+  fontSize?: string | number
+  /**
+   * 显示的图标
+   */
+  icon?: string
+  /**
+   * 显示小程序头像，只对百度，微信，QQ小程序有效
+   * @default false
+   */
+  mpAvatar?: boolean
+  /**
+   * 是否使用随机背景色
+   * @default false
+   */
+  randomBgColor?: boolean
+  /**
+   * 加载失败的默认头像(组件有内置默认图片)
+   */
+  defaultUrl?: string
+  /**
+   * 如果配置了randomBgColor为true，且配置了此值，则从默认的背景色数组中取出对应索引的颜色值，取值0-19之间
+   */
+  colorIndex?: string | number
+  /**
+   * 组件标识符
+   * @default "level"
+   */
+  name?: string
+  /**
+   * 头像被点击
+   * @param index 用户传递的标识符
+   */
+  onClick?: (index: any) => any
+}
+
+declare interface _Avatar {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      AvatarProps
+  }
+}
+
+export declare const Avatar: _Avatar

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