uview-plus 3.2.3 → 3.2.6

package/types/comps/image.d.ts

@@ -0,0 +1,119 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+export declare type ImageMode = 'scaleToFill' | 'aspectFit' | 'aspectFill' | 'widthFix' | 'heightFix' | 'top' | 'bottom' | 'center' | 'left' | 'right' | 'top left' | 'top right' | 'bottom left' | 'bottom right'
+
+declare interface ImageProps {
+  /**
+   * 图片地址，强烈建议使用绝对或者网络路径
+   */
+  src?: string
+  /**
+   * 裁剪模式
+   * @default "aspectFill"
+   */
+  mode?: ImageMode
+  /**
+   * 宽度，单位任意，如果为数值，默认单位px
+   * @default 300
+   */
+  width?: string | number
+  /**
+   * 高度，单位任意，如果为数值，默认单位px
+   * @default 225
+   */
+  height?: string | number
+  /**
+   * 图片形状
+   * @default "square"
+   */
+  shape?: 'circle' | 'square'
+  /**
+   * 圆角，默认单位px
+   * @default 0
+   */
+  radius?: string | number
+  /**
+   * 是否懒加载，仅微信小程序、App、百度小程序、字节跳动小程序有效
+   * @default true
+   */
+  lazyLoad?: boolean
+  /**
+   * 是否开启长按图片显示识别小程序码菜单，仅微信小程序有效
+   */
+  showMenuByLongpress?: boolean
+  /**
+   * 加载中的图标，或者小图片
+   * @default "photo"
+   */
+  loadingIcon?: string
+  /**
+   * 加载失败的图标，或者小图片
+   * @default "error-circle"
+   */
+  errorIcon?: string
+  /**
+   * 是否显示加载中的图标或者自定义的slot
+   * @default true
+   */
+  showLoading?: boolean
+  /**
+   * 是否显示加载错误的图标或者自定义的slot
+   * @default true
+   */
+  showError?: boolean
+  /**
+   * 是否需要淡入效果
+   * @default true
+   */
+  fade?: boolean
+  /**
+   * 只支持网络资源，只对微信小程序有效
+   * @default false
+   */
+  webp?: boolean
+  /**
+   * 搭配`fade`参数的过渡时间，单位ms
+   * @default 500
+   */
+  duration?: string | number
+  /**
+   * 背景颜色，用于深色页面加载图片时，为了和背景色融合
+   * @default "#f3f4f6"
+   */
+  bgColor?: string
+  /**
+   * 点击图片时触发
+   */
+  onClick?: () => any
+  /**
+   * 图片加载失败时触发
+   * @param err 错误信息
+   */
+  onError?: (err: any) => any
+  /**
+   * 图片加载成功时触发
+   */
+  onLoad?: () => any
+}
+
+declare interface ImageSlots {
+  /**
+   * 自定义加载中的提示内容
+   */
+  ['loading']?: () => any
+  /**
+   * 自定义失败的提示内容
+   */
+  ['error']?: () => any
+}
+
+declare interface _Image {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      ImageProps
+    $slots: ImageSlots
+  }
+}
+
+export declare const Image: _Image

package/types/comps/indexAnchor.d.ts

@@ -0,0 +1,38 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface IndexAnchorProps {
+  /**
+   * 列表锚点文本内容
+   */
+  text?: string | number
+  /**
+   * 列表锚点文字颜色
+   * @default "#606266"
+   */
+  color?: string
+  /**
+   * 列表锚点文字大小，单位默认px
+   * @default 14
+   */
+  size?: string | number
+  /**
+   * 列表锚点背景颜色
+   * @default "#dedede"
+   */
+  bgColor?: string
+  /**
+   * 列表锚点高度，单位默认px
+   * @default 32
+   */
+  height?: string | number
+}
+
+declare interface _IndexAnchor {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      IndexAnchorProps
+  }
+}
+
+export declare const IndexAnchor: _IndexAnchor

package/types/comps/indexItem.d.ts

@@ -0,0 +1,18 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface IndexItemSlots {
+  /**
+   * 自定义列表内容
+   */
+  ['default']?: () => any
+}
+
+declare interface _IndexItem {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps
+    $slots: IndexItemSlots
+  }
+}
+
+export declare const IndexItem: _IndexItem

package/types/comps/indexList.d.ts

@@ -0,0 +1,39 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface IndexListProps {
+  /**
+   * 右边锚点状态非激活时的颜色
+   * @default "#606266"
+   */
+  inactiveColor?: string
+  /**
+   * 右边锚点状态激活时的颜色
+   * @default "#5677fc"
+   */
+  activeColor?: string
+  /**
+   * 索引字符列表，数组
+   * @default "A-Z"
+   */
+  indexList?: (string | number)[]
+  /**
+   * 是否开启锚点自动吸顶
+   * @default true
+   */
+  sticky?: boolean
+  /**
+   * 自定义导航栏的高度，单位默认px
+   * @default 0
+   */
+  customNavHeight?: string | number
+}
+
+declare interface _IndexList {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      IndexListProps
+  }
+}
+
+export declare const IndexList: _IndexList

package/types/comps/input.d.ts

@@ -0,0 +1,234 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface InputProps {
+  /**
+   * 输入的值
+   */
+  value?: string | number
+  /**
+   * 输入框类型，详见[文档](https://www.uviewui.com/components/input.html#%E8%BE%93%E5%85%A5%E6%A1%86%E7%9A%84%E7%B1%BB%E5%9E%8B)
+   * @default "text"
+   */
+  type?: 'text' | 'number' | 'idcard' | 'digit' | 'password'
+  /**
+   * 是否禁用输入框
+   * @default false
+   */
+  disabled?: boolean
+  /**
+   * 禁用状态时的背景色
+   * @default "#f5f7fa"
+   */
+  disabledColor?: string
+  /**
+   * 是否显示清除控件
+   * @default false
+   */
+  clearable?: boolean
+  /**
+   * 是否密码类型
+   * @default false
+   */
+  password?: boolean
+  /**
+   * 最大输入长度，设置为 -1 的时候不限制最大长度
+   * @default -1
+   */
+  maxlength?: string | number
+  /**
+   * 输入框为空时的占位符
+   */
+  placeholder?: string
+  /**
+   * 指定placeholder的样式类，注意页面或组件的style中写了scoped时，需要在类名前写/deep/
+   * @default "input-placeholder"
+   */
+  placeholderClass?: string
+  /**
+   * 指定placeholder的样式
+   * @default "color: #c0c4cc"
+   */
+  placeholderStyle?: unknown
+  /**
+   * 是否显示输入字数统计，只在 type ="text"或type ="textarea"时有效
+   * @default false
+   */
+  showWordLimit?: boolean
+  /**
+   * 设置右下角按钮的文字
+   * @default "done"
+   */
+  confirmType?: 'send' | 'search' | 'next' | 'go' | 'done'
+  /**
+   * 点击键盘右下角按钮时是否保持键盘不收起，H5无效
+   * @default false
+   */
+  confirmHold?: boolean
+  /**
+   * focus时，点击页面的时候不收起键盘，微信小程序有效
+   * @default false
+   */
+  holdKeyboard?: boolean
+  /**
+   * 自动获取焦点，在 H5 平台能否聚焦以及软键盘是否跟随弹出，取决于当前浏览器本身的实现。nvue 页面不支持，需使用组件的 focus()、blur() 方法控制焦点
+   * @default false
+   */
+  focus?: boolean
+  /**
+   * 键盘收起时，是否自动失去焦点，目前仅App3.0.0+有效
+   * @default false
+   */
+  autoBlur?: boolean
+  /**
+   * 是否忽略组件内对文本合成系统事件的处理。为 false 时将触发 compositionstart、compositionend、compositionupdate 事件，且在文本合成期间会触发 input 事件
+   * @default true
+   */
+  ignoreCompositionEvent?: boolean
+  /**
+   * 是否去掉 iOS 下的默认内边距，仅微信小程序，且type=textarea时有效
+   * @default false
+   */
+  disableDefaultPadding?: boolean
+  /**
+   * 指定focus时光标的位置
+   * @default -1
+   */
+  cursor?: string | number
+  /**
+   * 输入框聚焦时底部与键盘的距离
+   * @default 30
+   */
+  cursorSpacing?: string | number
+  /**
+   * 光标起始位置，自动聚集时有效，需与selection-end搭配使用
+   * @default -1
+   */
+  selectionStart?: string | number
+  /**
+   * 光标结束位置，自动聚集时有效，需与selection-start搭配使用
+   * @default -1
+   */
+  selectionEnd?: string | number
+  /**
+   * 键盘弹起时，是否自动上推页面
+   * @default true
+   */
+  adjustPosition?: boolean
+  /**
+   * 输入框内容对齐方式
+   * @default "left"
+   */
+  inputAlign?: 'left' | 'center' | 'right'
+  /**
+   * 输入框字体的大小
+   * @default "15px"
+   */
+  fontSize?: string | number
+  /**
+   * 输入框字体颜色
+   * @default "#303133"
+   */
+  color?: string
+  /**
+   * 输入框前置图标
+   */
+  prefixIcon?: string
+  /**
+   * 前置图标样式
+   */
+  prefixIconStyle?: unknown
+  /**
+   * 输入框后置图标
+   */
+  suffixIcon?: string
+  /**
+   * 后置图标样式
+   */
+  suffixIconStyle?: unknown
+  /**
+   * 边框类型，surround-四周边框，bottom-底部边框，none-无边框
+   * @default "surround"
+   */
+  border?: 'surround' | 'bottom' | 'none'
+  /**
+   * 是否只读，与disabled不同之处在于disabled会置灰组件，而readonly则不会
+   * @default false
+   */
+  readonly?: boolean
+  /**
+   * 输入框形状，circle-圆形，square-方形
+   * @default "square"
+   */
+  shape?: 'square' | 'circle'
+  /**
+   * 输入过滤或格式化函数(如需兼容微信小程序，则只能通过`setFormatter`方法)
+   */
+  formatter?: (...args: any) => any
+  /**
+   * 定义需要用到的外部样式
+   */
+  customStyle?: unknown
+  /**
+   * 输入框失去焦点时触发
+   * @param value 内容值
+   */
+  onBlur?: (value: any) => any
+  /**
+   * 输入框聚焦时触发
+   */
+  onFocus?: () => any
+  /**
+   * 点击完成按钮时触发
+   * @param value 内容值
+   */
+  onConfirm?: (value: any) => any
+  /**
+   * 键盘高度发生变化的时候触发此事件
+   */
+  onKeyboardheightchange?: () => any
+  /**
+   * 内容发生变化触发此事件
+   * @param value 内容值
+   */
+  onInput?: (value: any) => any
+  /**
+   * 内容发生变化触发此事件
+   * @param value 内容值
+   */
+  onChange?: (value: any) => any
+  /**
+   * 点击清空内容
+   */
+  onClear?: () => any
+}
+
+declare interface InputSlots {
+  /**
+   * 输入框前置内容，`nuve`环境需`u--input`有效，非`nvue`环境需`u-input`才有效
+   */
+  ['prefix']?: () => any
+  /**
+   * 输入框后置内容，`nuve`环境需`u--input`有效，非`nvue`环境需`u-input`才有效
+   */
+  ['suffix']?: () => any
+}
+
+declare interface _Input {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      InputProps
+    $slots: InputSlots
+  }
+}
+
+declare interface _InputRef {
+  /**
+   * 为兼容微信小程序而暴露的内部方法
+   */
+  setFormatter: () => void
+}
+
+export declare const Input: _Input
+
+export declare const InputRef: _InputRef

package/types/comps/keyboard.d.ts

@@ -0,0 +1,125 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface KeyboardProps {
+  /**
+   * 键盘的类型，number-数字键盘，card-身份证键盘，car-车牌号键盘
+   * @default "car"
+   */
+  mode?: 'car' | 'number' | 'card'
+  /**
+   * 是否显示"."按键，只在mode=number时有效
+   * @default false
+   */
+  dotDisabled?: boolean
+  /**
+   * 是否显示键盘顶部工具条
+   * @default true
+   */
+  tooltip?: boolean
+  /**
+   * 是否显示工具条中间的提示
+   * @default true
+   */
+  showTips?: boolean
+  /**
+   * 工具条中间的提示文字，详见[文档](https://www.uviewui.com/components/keyboard.html#%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8)
+   */
+  tips?: string
+  /**
+   * 是否显示工具条左边的"取消"按钮
+   * @default true
+   */
+  showCancel?: boolean
+  /**
+   * 是否显示工具条右边的"完成"按钮
+   * @default true
+   */
+  showConfirm?: boolean
+  /**
+   * 是否打乱键盘按键的顺序
+   * @default false
+   */
+  random?: boolean
+  /**
+   * 是否开启底部安全区适配
+   * @default false
+   */
+  safeAreaInsetBottom?: boolean
+  /**
+   * 是否允许点击遮罩收起键盘（注意：关闭事件需要自行处理，只会在开启closeOnClickOverlay后点击遮罩层执行close回调）
+   * @default true
+   */
+  closeOnClickOverlay?: boolean
+  /**
+   * 控制键盘的弹出与收起
+   * @default true
+   */
+  show?: boolean
+  /**
+   * 是否显示遮罩
+   * @default true
+   */
+  overlay?: boolean
+  /**
+   * 弹出键盘的`z-index`值
+   * @default 1075
+   */
+  zIndex?: string | number
+  /**
+   * 确认按钮的文字
+   * @default "确认"
+   */
+  confirmText?: string
+  /**
+   * 取消按钮的文字
+   * @default "取消"
+   */
+  cancelText?: string
+  /**
+   * 自定义样式
+   */
+  customStyle?: unknown
+  /**
+   * `mode`为`car`下，输入文字后，是否自动切换为字母模式
+   * @default false
+   */
+  autoChange?: boolean
+  /**
+   * 按键被点击(不包含退格键被点击)
+   */
+  onChange?: () => any
+  /**
+   * 键盘关闭
+   */
+  onClose?: () => any
+  /**
+   * 键盘顶部工具条右边的"完成"按钮被点击
+   */
+  onConfirm?: () => any
+  /**
+   * 键盘顶部工具条左边的"取消"按钮被点击
+   */
+  onCancel?: () => any
+  /**
+   * 键盘退格键被点击
+   */
+  onBackspace?: () => any
+}
+
+declare interface KeyboardSlots {
+  /**
+   * 内容将会显示键盘的工具条上面，可以结合MessageInput 验证码输入组件实现类似支付宝输入密码时，上方显示输入内容的功能
+   */
+  ['default']: () => any
+}
+
+declare interface _Keyboard {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      KeyboardProps
+    $slots: KeyboardSlots
+  }
+}
+
+export declare const Keyboard: _Keyboard

package/types/comps/line.d.ts

@@ -0,0 +1,44 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface LineProps {
+  /**
+   * 线条的颜色
+   * @default "#d6d7d9"
+   */
+  color?: string
+  /**
+   * 长度，竖向时表现为高度，横向时表现为长度，可以为百分比，带rpx单位的值等
+   * @default 100%
+   */
+  length?: string | number
+  /**
+   * 线条的方向，`row`-横向，`col`-竖向
+   * @default "row"
+   */
+  direction?: "row" | "col"
+  /**
+   * 是否显示细边框
+   * @default true
+   */
+  hairline?: boolean
+  /**
+   * 线条与上下左右元素的间距，字符串形式，如"30rpx"、"20rpx 30rpx"，默认单位px
+   * @default 0
+   */
+  margin?: string | number
+  /**
+   * 是否虚线，false-实线，true-虚线
+   * @default false
+   */
+  dashed?: boolean
+}
+
+declare interface _Line {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      LineProps
+  }
+}
+
+export declare const Line: _Line

package/types/comps/lineProgress.d.ts

@@ -0,0 +1,51 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+declare interface LineProgressProps {
+  /**
+   * 进度条激活部分的颜色
+   * @default "#19be6b"
+   */
+  activeColor?: string
+  /**
+   * 进度条的底色，默认为灰色
+   * @default "#ececec"
+   */
+  inactiveColor?: string
+  /**
+   * 进度百分比，数值
+   * @default 0
+   */
+  percentage?: string | number
+  /**
+   * 是否在进度条内部显示百分比的值
+   * @default true
+   */
+  showText?: boolean
+  /**
+   * 进度条的高度，默认单位px
+   * @default 12
+   */
+  height?: string | number
+  /**
+   * 点击触发事件
+   */
+  onClick?: () => any
+}
+
+declare interface LineProgressSlots {
+  /**
+   * 传入自定义的显示内容，将会覆盖默认显示的百分比值
+   */
+  ['default']?: (arg: any) => any
+}
+
+declare interface _LineProgress {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      LineProgressProps
+    $slots: LineProgressSlots
+  }
+}
+
+export declare const LineProgress: _LineProgress