uview-plus 3.2.3 → 3.2.6

package/types/comps/noticeBar.d.ts

@@ -0,0 +1,85 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface NoticeBarProps {
+  /**
+   * 显示的内容，direction为column时要求为数组， 为row时要求为字符串
+   */
+  text?: string | string[]
+  /**
+   * 通告滚动模式，row-横向滚动，column-竖向滚动
+   * @default "row"
+   */
+  direction?: 'row' | 'column'
+  /**
+   * direction = row时，是否使用步进形式滚动
+   * @default false
+   */
+  step?: boolean
+  /**
+   * 是否显示左侧的音量图标
+   * @default "volume"
+   */
+  icon?: string
+  /**
+   * 通告模式，link-显示右箭头，closable-显示右侧关闭图标
+   */
+  mode?: 'link' | 'closable'
+  /**
+   * 文字颜色
+   * @default "#f9ae3d"
+   */
+  color?: string
+  /**
+   * 背景颜色
+   * @default "#fdf6ec"
+   */
+  bgColor?: string
+  /**
+   * 水平滚动时的滚动速度，即每秒滚动多少px(rpx)，这有利于控制文字无论多少时，都能有一个恒定的速度
+   * @default 80
+   */
+  speed?: string | number
+  /**
+   * 字体大小
+   * @default 14
+   */
+  fontSize?: string | number
+  /**
+   * 滚动一个周期的时间长，单位ms
+   * @default 2000
+   */
+  duration?: string | number
+  /**
+   * 是否禁止用手滑动切换（目前HX2.6.11，只支持App 2.5.5+、H5 2.5.5+、支付宝小程序、字节跳动小程序）
+   * @default true
+   */
+  disableTouch?: boolean
+  /**
+   * 跳转的页面路径
+   */
+  url?: string
+  /**
+   * 页面跳转的类型
+   * @default "navigateTo"
+   */
+  linkType?: string
+  /**
+   * 点击通告文字触发
+   * @param index 点击的text的索引
+   */
+  onClick?: (index: number) => any
+  /**
+   * 点击右侧关闭图标触发
+   */
+  onClose?: () => any
+}
+
+declare interface _NoticeBar {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      NoticeBarProps
+  }
+}
+
+export declare const NoticeBar: _NoticeBar

package/types/comps/notify.d.ts

@@ -0,0 +1,73 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface NotifyProps {
+  /**
+   * 到顶部的距离
+   * @default 0
+   */
+  top?: string | number
+  /**
+   * 主题
+   * @default "primary"
+   */
+  type?: 'primary' | 'success' | 'warning' | 'error'
+  /**
+   * 字体颜色
+   * @default "#fff"
+   */
+  color?: string
+  /**
+   * 背景颜色
+   */
+  bgColor?: string
+  /**
+   * 展示的文字内容
+   */
+  message?: string
+  /**
+   * 展示时长，为0时不消失，单位ms
+   * @default 3000
+   */
+  duration?: string | number
+  /**
+   * 字体大小，单位rpx
+   * @default 15
+   */
+  fontSize?: string | number
+  /**
+   * 是否留出顶部安全距离（状态栏高度）
+   * @default false
+   */
+  safeAreaInsetTop?: boolean
+}
+
+declare interface NotifySlots {
+  /**
+   * 通知内容
+   */
+  ['icon']?: () => any
+}
+
+declare interface _NotifyRef {
+  /**
+   * 显示并加载配置
+   */
+  show: (options: NotifyProps) => void
+  /**
+   * 关闭消息提示
+   */
+  close: () => void
+}
+
+declare interface _Notify {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      NotifyProps
+    $slots: NotifySlots
+  }
+}
+
+export declare const Notify: _Notify
+
+export declare const NotifyRef: _NotifyRef

package/types/comps/numberBox.d.ts

@@ -0,0 +1,155 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface NumberBoxProps {
+  /**
+   * 步进器标识符，在change回调返回
+   */
+  name?: string | number
+  /**
+   * 用于双向绑定的值，初始化时设置设为默认min值(最小值)
+   * @default 1
+   */
+  value?: string | number
+  /**
+   * 用户可输入的最小值
+   * @default 1
+   */
+  min?: string | number
+  /**
+   * 用户可输入的最大值
+   * @default Number.MAX_SAFE_INTEGER
+   */
+  max?: string | number
+  /**
+   * 步长，每次加或减的值， 支持小数值，如需小数
+   * @default 1
+   */
+  step?: string | number
+  /**
+   * 是否只能输入正整数
+   * @default false
+   */
+  integer?: boolean
+  /**
+   * 是否禁用操作，包括输入框，加减按钮
+   * @default false
+   */
+  disabled?: boolean
+  /**
+   * 是否禁止输入框
+   * @default false
+   */
+  disabledInput?: boolean
+  /**
+   * 是否开启异步变更，开启后需要手动控制输入值
+   * @default false
+   */
+  asyncChange?: boolean
+  /**
+   * 输入框宽度，单位px
+   * @default 35
+   */
+  inputWidth?: string | number
+  /**
+   * 是否显示减少按钮
+   * @default true
+   */
+  showMinus?: boolean
+  /**
+   * 是否显示增加按钮
+   * @default true
+   */
+  showPlus?: boolean
+  /**
+   * 显示的小数位数
+   */
+  decimalLength?: string | number
+  /**
+   * 是否允许长按进行加减
+   * @default true
+   */
+  longPress?: boolean
+  /**
+   * 输入框文字和加减按钮图标的颜色
+   * @default "#323233"
+   */
+  color?: string
+  /**
+   * 按钮大小，宽高等于此值，单位px，输入框高度和此值保持一致
+   * @default 30
+   */
+  buttonSize?: string | number
+  /**
+   * 输入框和按钮的背景颜色
+   * @default "#EBECEE"
+   */
+  bgColor?: string
+  /**
+   * 指定光标于键盘的距离，避免键盘遮挡输入框，单位px
+   * @default 100
+   */
+  cursorSpacing?: string | number
+  /**
+   * 是否禁用增加按钮
+   * @default false
+   */
+  disablePlus?: boolean
+  /**
+   * 是否禁用减少按钮
+   * @default false
+   */
+  disableMinus?: boolean
+  /**
+   * 加减按钮图标的样式
+   */
+  iconStyle?: string
+  /**
+   * 输入框得到焦点触发(按钮可点击情况下)
+   * @param value 输入框当前值
+   * @param value 步进器标识符
+   */
+  onFocus?: (value: any, name: any) => any
+  /**
+   * 输入框失去焦点时触发
+   * @param value 输入框当前值
+   * @param value 步进器标识符
+   */
+  onBlur?: (value: any, name: any) => any
+  /**
+   * 输入框内容发生变化时触发
+   * @param value 输入框当前值
+   * @param value 步进器标识符
+   */
+  onChange?: (value: any, name: any) => any
+  /**
+   * 超过范围阈值时触发
+   * @type type 限制类型
+   */
+  onOverlimit?: (type: 'minus' | 'plus') => any
+}
+
+declare interface NumberBoxSlots {
+  /**
+   * 减少按钮
+   */
+  ['minus']?: () => any
+  /**
+   * 输入框
+   */
+  ['input']?: () => any
+  /**
+   * 增加按钮
+   */
+  ['plus']?: () => any
+}
+
+declare interface _NumberBox {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      NumberBoxProps
+    $slots: NumberBoxSlots
+  }
+}
+
+export declare const NumberBox: _NumberBox

package/types/comps/overlay.d.ts

@@ -0,0 +1,46 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface OverlayProps {
+  /**
+   * 是否显示遮罩
+   * @default false
+   */
+  show?: boolean
+  /**
+   * z-index 层级
+   * @default 10070
+   */
+  zIndex?: string | number
+  /**
+   * 动画时长，单位毫秒
+   * @default 300
+   */
+  duration?: string | number
+  /**
+   * 不透明度值，当做rgba的第四个参数
+   * @default 0.5
+   */
+  opacity?: string | number
+  /**
+   * 点击遮罩发送此事件
+   */
+  onClick?: () => any
+}
+
+declare interface OverlaySlots {
+  /**
+   * 默认插槽，用于在遮罩层上方嵌入内容
+   */
+  ['default']?: () => any
+}
+
+declare interface _Overlay {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      OverlayProps
+    $slots: OverlaySlots
+  }
+}
+
+export declare const Overlay: _Overlay

package/types/comps/parse.d.ts

@@ -0,0 +1,101 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface ParseProps {
+  /**
+   * 背景颜色，只适用与APP-PLUS-NVUE
+   */
+  bgColor?: string
+  /**
+   * 要显示的富文本字符串
+   */
+  content?: string
+  /**
+   * 是否允许外部链接被点击时自动复制
+   */
+  copyLink?: string
+  /**
+   * 主域名，设置后将给链接自动拼接上主域名或协议名
+   */
+  domain?: string
+  /**
+   * 图片出错时的占位图链接
+   */
+  errorImg?: string
+  /**
+   * 是否开启图片懒加载，nvue不支持此属性
+   * @default true
+   */
+  lazyLoad?: boolean
+  /**
+   * 图片加载完成前的占位图
+   */
+  loadingImg?: string
+  /**
+   * 是否在播放一个视频时自动暂停其它视频
+   */
+  pauseVideo?: boolean
+  /**
+   * 是否开启图片被点击时自动预览
+   * @default true
+   */
+  previewImg?: boolean
+  /**
+   * 是否自动给 table 添加一个滚动层（使表格可以单独横向滚动）
+   * @default false
+   */
+  scrollTable?: boolean
+  /**
+   * 是否开启长按复制内容
+   * @default false
+   */
+  selectable?: boolean
+  /**
+   * 是否自动将 title 标签的内容设置到页面标题
+   * @default true
+   */
+  setTitle?: boolean
+  /**
+   * 是否开启图片被长按时显示菜单
+   * @default true
+   */
+  showImgMenu?: boolean
+  /**
+   * 设置标签的默认样式
+   */
+  tagStyle?: unknown
+  /**
+   * 是否使用页面内锚点
+   * @default false
+   */
+  useAnchor?: boolean | number
+  /**
+   * dom 加载完成时触发
+   */
+  onLoad?: () => any
+  /**
+   * 渲染完成时触发
+   */
+  onReady?: (...args: any) => any
+  /**
+   * 出错时触发
+   */
+  onError?: (...args: any) => any
+  /**
+   * 图片被点击时触发
+   */
+  onImgTap?: (...args: any) => any
+  /**
+   * 在链接被点击时触发
+   */
+  onLinkTap?: (...args: any) => any
+}
+
+declare interface _Parse {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      ParseProps
+  }
+}
+
+export declare const Parse: _Parse

package/types/comps/picker.d.ts

@@ -0,0 +1,115 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface PickerProps {
+  /**
+   * 用于控制选择器的弹出与收起
+   * @default false
+   */
+  show?: boolean
+  /**
+   * 是否显示顶部的操作栏
+   * @default true
+   */
+  showToolbar?: boolean
+  /**
+   * 顶部中间的标题
+   */
+  title?: string
+  /**
+   * 设置每一列的数据，详见[文档](https://www.uviewui.com/components/picker.html#%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8)
+   */
+  columns?: any[]
+  /**
+   * 加载状态
+   * @default false
+   */
+  loading?: boolean
+  /**
+   * 各列中，单个选项的高度
+   * @default 14
+   */
+  itemHeight?: string | number
+  /**
+   * 取消按钮的文字
+   * @default "取消"
+   */
+  cancelText?: string
+  /**
+   * 确认按钮的文字
+   * @default "确认"
+   */
+  confirmText?: string
+  /**
+   * 取消按钮的颜色
+   * @default "#909193"
+   */
+  cancelColor?: string
+  /**
+   * 确认按钮的颜色
+   * @default "#3c9cff"
+   */
+  confirmColor?: string
+  /**
+   * 每列中可见选项的数量
+   * @default 5
+   */
+  visibleItemCount?: string | number
+  /**
+   * 自定义需要展示的`text`属性键名
+   * @default "text"
+   */
+  keyName?: string
+  /**
+   * 是否允许点击遮罩关闭选择器（注意：关闭事件需要自行处理，只会在开启closeOnClickOverlay后点击遮罩层执行close回调）
+   * @default false
+   */
+  closeOnClickOverlay?: boolean
+  /**
+   * 各列的默认索引
+   */
+  defaultIndex?: any[]
+  /**
+   * 是否在手指松开时立即触发`change`事件。若不开启则会在滚动动画结束后触发`change`事件，只在微信`2.21.1`及以上有效
+   * @default false
+   */
+  immediateChange?: boolean
+  /**
+   * 关闭选择器时触发
+   */
+  onClose?: () => any
+  /**
+   * 点击确定按钮，返回当前选择的值
+   */
+  onConfirm?: (...args: any) => any
+  /**
+   * 当选择值变化时触发
+   */
+  onChange?: (...args: any) => any
+  /**
+   * 点击取消按钮
+   */
+  onCancel?: () => any
+}
+
+declare interface _PickerRef {
+  /**
+   * 设置对应列的选择值
+   */
+  setIndexs: (index, setLastIndex) => any
+  /**
+   * 多列联动时需要用到，详见[文档](https://www.uviewui.com/components/picker.html#%E5%A4%9A%E5%88%97%E6%A8%A1%E5%BC%8F%E4%B8%8E%E5%A4%9A%E5%88%97%E8%81%94%E5%8A%A8)
+   */
+  setColumnValues: (...args: any) => any
+}
+
+declare interface _Picker {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      PickerProps
+  }
+}
+
+export declare const Picker: _Picker
+
+export declare const PickerRef: _PickerRef

package/types/comps/popup.d.ts

@@ -0,0 +1,103 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface PopupProps {
+  /**
+   * 是否展示弹窗
+   * @default false
+   */
+  show?: boolean
+  /**
+   * 是否显示遮罩
+   * @default true
+   */
+  overlay?: boolean
+  /**
+   * 弹出方向
+   * @default 'bottom'
+   */
+  mode?: 'top' | 'right' | 'bottom' | 'center'
+  /**
+   * 遮罩打开或收起的动画过渡时间，单位ms
+   * @default 300
+   */
+  duration?: number
+  /**
+   * 是否显示关闭图标
+   * @default false
+   */
+  closeable?: boolean
+  /**
+   * 遮罩自定义样式，一般用于修改遮罩颜色，如：{background: 'rgba(3, 100, 219, 0.5)'}
+   */
+  overlayStyle?: unknown
+  /**
+   * 遮罩透明度，0-1之间，勿与overlayStyle共用
+   * @default 0.5
+   */
+  overlayOpacity?: number | string
+  /**
+   * 点击遮罩是否关闭弹窗（注意：关闭事件需要自行处理，只会在开启closeOnClickOverlay后点击遮罩层执行close回调）
+   * @default true
+   */
+  closeOnClickOverlay?: boolean
+  /**
+   * 弹出层的z-index值
+   * @default 10075
+   */
+  zIndex?: number | string
+  /**
+   * 是否为留出底部安全距离
+   * @default true
+   */
+  safeAreaInsetBottom?: boolean
+  /**
+   * 是否留出顶部安全距离（状态栏高度）
+   * @default false
+   */
+  safeAreaInsetTop?: boolean
+  /**
+   * 自定义关闭图标位置，top-left为左上角，top-right为右上角，bottom-left为左下角，bottom-right为右下角
+   */
+  closeIconPos?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
+  /**
+   * 设置圆角值，仅对mode = top | bottom | center有效
+   * @default 0
+   */
+  round?: number | string
+  /**
+   * 当mode=center时 是否开启缩放
+   * @default true
+   */
+  zoom?: boolean
+  /**
+   * 背景色，一般用于特殊弹窗内容场景，设置为transparent可去除默认的白色背景
+   */
+  bgColor?: string
+  /**
+   * 用户自定义样式
+   */
+  customStyle?: unknown
+  /**
+   * 弹出层打开
+   */
+  onOpen?: () => any
+  /**
+   * 弹出层收起
+   */
+  onClose?: () => any
+}
+
+declare interface PopupSlots {
+  ['default']?: () => any
+}
+
+declare interface _Popup {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      PopupProps
+    $slots: PopupSlots
+  }
+}
+
+export declare const Popup: _Popup