uview-plus 3.8.126 → 3.8.128

package/types/comps/form.d.ts

@@ -1,5 +1,25 @@
 import { AllowedComponentProps, VNodeProps } from './_common'
 
+/** 校验未通过时返回的错误项 */
+declare interface FormValidateError {
+  /** 校验未通过的提示信息 */
+  message: string
+  /** 对应 form-item 的 prop */
+  prop: string
+  /** async-validator 返回的字段名 */
+  field?: string
+  [key: string]: any
+}
+
+/** validate/validateField 的可选配置 */
+declare interface FormValidateOptions {
+  /**
+   * 是否把错误信息显示到对应的 form-item 上
+   * @default true
+   */
+  showErrorMsg?: boolean
+}
+
 declare interface FormProps {
   /**
    * 表单数据对象
@@ -8,12 +28,12 @@ declare interface FormProps {
   /**
    * 通过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>
+  rules?: Record<string, any> | any[] | ((...args: any[]) => any)
   /**
    * 错误的提示方式
    * @default "message"
    */
-  errorType?: 'message' | 'none' | 'toast' | 'border-bottom' | 'none'
+  errorType?: 'message' | 'none' | 'toast' | 'border-bottom'
   /**
    * 是否显示表单域的下划线边框
    * @default true
@@ -42,25 +62,41 @@ declare interface FormProps {
 
 declare interface _FormRef {
   /**
-   * 对整个表单进行校验的方法
+   * 对整个表单进行校验
+   * - 校验通过时 resolve(true)，校验不通过时 reject(错误数组)
+   * - 未设置 rules 时开发环境会给出提示并返回 undefined
+   * @example
+   * formRef.value.validate().then(valid => {
+   *   // valid 为 true 表示校验通过
+   * }).catch((errors) => {})
    */
-  validate: () => any
+  validate: (options?: FormValidateOptions) => Promise<boolean>
   /**
    * 如果`rules`中有自定义方法等，需要用此方法设置`rules`规则，否则微信小程序无效
    */
-  setRules: (rules: any) => any
+  setRules: (rules: Record<string, any> | any[] | ((...args: any[]) => any)) => void
   /**
    * 对部分表单字段进行校验
+   * @param value 需要校验的 form-item 的 prop，可传数组批量校验
+   * @param cb 校验完成后的回调，参数为错误数组，长度为0表示校验通过
+   * @param event 触发校验的事件名，仅校验 trigger 包含该事件的规则
+   * @param options 校验配置
    */
-  validateField: (value, cb?: ((errorsRes) => any)) => any
+  validateField: (
+    value: string | string[],
+    cb?: (errorsRes: FormValidateError[]) => any,
+    event?: string | null,
+    options?: FormValidateOptions
+  ) => Promise<void>
   /**
    * 对整个表单进行重置，将所有字段值重置为初始值并移除校验结果
    */
-  resetFields: () => any
+  resetFields: () => void
   /**
    * 清空校验结果
+   * @param props 需要清空的 form-item 的 prop，不传则清空全部
    */
-  clearValidate: (props: any) => any
+  clearValidate: (props?: string | string[]) => void
 }
 
 declare interface _Form {

package/types/comps/list.d.ts

@@ -42,7 +42,7 @@ declare interface ListProps {
    */
   scrollable?: boolean
   /**
-   * 值应为某子元素id（id不能以数字开头）
+   * 滚动到指定位置，值为u-list-item的anchor，或item内某个子元素的id（id不能以数字开头）
    */
   scrollIntoView?: string
   /**

package/types/comps/listItem.d.ts

@@ -2,7 +2,7 @@ import { AllowedComponentProps, VNodeProps } from './_common'
 
 declare interface ListItemProps {
   /**
-   * 用于滚动到指定item
+   * item的锚点，将u-list的scroll-into-view设置为该值即可滚动到此item
    */
   anchor?: string | number
 }

package/types/comps/numberBox.d.ts

@@ -1,13 +1,40 @@
 import { AllowedComponentProps, VNodeProps } from './_common'
 
+/**
+ * focus/blur 的回调载荷（对象形式）
+ * - 除下列字段外，还会带上平台原生 event.detail 中的其他字段
+ */
+declare interface NumberBoxFocusPayload {
+  /** 输入框当前值 */
+  value: string | number
+  /** 步进器标识符，即 name 属性 */
+  name: string | number
+  [key: string]: any
+}
+
+/** change 的回调载荷（对象形式） */
+declare interface NumberBoxChangePayload {
+  /** 输入框当前值 */
+  value: string | number
+  /** 步进器标识符，即 name 属性 */
+  name: string | number
+  /** 本次变更来源：plus-点击加号，minus-点击减号，手动输入时为空字符串 */
+  type: 'plus' | 'minus' | ''
+}
+
 declare interface NumberBoxProps {
   /**
    * 步进器标识符，在change回调返回
    */
   name?: string | number
   /**
-   * 用于双向绑定的值，初始化时设置设为默认min值(最小值)
-   * @default 1
+   * 用于双向绑定的值（v-model），初始化时会被格式化到 min~max 之间
+   * @default 0
+   */
+  modelValue?: string | number
+  /**
+   * 用于双向绑定的值
+   * @deprecated 仅 Vue2 可用，Vue3 请使用 modelValue（即 v-model）
    */
   value?: string | number
   /**
@@ -62,28 +89,50 @@ declare interface NumberBoxProps {
   showPlus?: boolean
   /**
    * 显示的小数位数
+   * @default null
    */
-  decimalLength?: string | number
+  decimalLength?: string | number | null
   /**
    * 是否允许长按进行加减
    * @default true
    */
   longPress?: boolean
   /**
-   * 输入框文字和加减按钮图标的颜色
-   * @default "#323233"
+   * 输入框文字和加减按钮图标的颜色，留空则跟随主题变量
+   * @default ""
    */
   color?: string
+  /**
+   * 按钮宽度，单位px
+   * @default 30
+   */
+  buttonWidth?: string | number
   /**
    * 按钮大小，宽高等于此值，单位px，输入框高度和此值保持一致
    * @default 30
    */
   buttonSize?: string | number
   /**
-   * 输入框和按钮的背景颜色
-   * @default "#EBECEE"
+   * 按钮圆角
+   * @default "0px"
+   */
+  buttonRadius?: string
+  /**
+   * 输入框和按钮的背景颜色，留空则跟随主题变量
+   * @default ""
    */
   bgColor?: string
+  /**
+   * 按钮禁用时的背景颜色，留空则跟随主题变量
+   * @version 3.4.57
+   * @default ""
+   */
+  disabledBgColor?: string
+  /**
+   * 输入框独立背景颜色，留空则跟随 bgColor
+   * @default ""
+   */
+  inputBgColor?: string
   /**
    * 指定光标于键盘的距离，避免键盘遮挡输入框，单位px
    * @default 100
@@ -102,30 +151,45 @@ declare interface NumberBoxProps {
   /**
    * 加减按钮图标的样式
    */
-  iconStyle?: string
+  iconStyle?: string | Record<string, any>
+  /**
+   * 迷你模式，常用于外卖场景，值为0时只显示加号按钮
+   * @default false
+   */
+  miniMode?: boolean
   /**
-   * 输入框得到焦点触发(按钮可点击情况下)
-   * @param value 输入框当前值
-   * @param value 步进器标识符
+   * modelValue 变化时触发（v-model 内部使用）
+   * @param value 格式化后的最新值
    */
-  onFocus?: (value: any, name: any) => any
+  ['onUpdate:modelValue']?: (value: string | number) => any
   /**
-   * 输入框失去焦点时触发
-   * @param value 输入框当前值
-   * @param value 步进器标识符
+   * 输入框得到焦点触发(按钮可点击情况下)，回调参数为对象
+   * @param event 对象形式，包含 value(输入框当前值)、name(步进器标识符)
    */
-  onBlur?: (value: any, name: any) => any
+  onFocus?: (event: NumberBoxFocusPayload) => any
   /**
-   * 输入框内容发生变化时触发
-   * @param value 输入框当前值
-   * @param value 步进器标识符
+   * 输入框失去焦点时触发，回调参数为对象
+   * @param event 对象形式，包含 value(输入框当前值)、name(步进器标识符)
    */
-  onChange?: (value: any, name: any) => any
+  onBlur?: (event: NumberBoxFocusPayload) => any
+  /**
+   * 输入框内容发生变化时触发，回调参数为对象
+   * @param event 对象形式，包含 value(输入框当前值)、name(步进器标识符)、type(变更来源)
+   */
+  onChange?: (event: NumberBoxChangePayload) => any
   /**
    * 超过范围阈值时触发
-   * @type type 限制类型
+   * @param type 限制类型，minus-已达最小值，plus-已达最大值
    */
   onOverlimit?: (type: 'minus' | 'plus') => any
+  /**
+   * 点击增加按钮时触发（未超过阈值时）
+   */
+  onPlus?: () => any
+  /**
+   * 点击减少按钮时触发（未超过阈值时）
+   */
+  onMinus?: () => any
 }
 
 declare interface NumberBoxSlots {

package/types/comps/pagination.d.ts

@@ -0,0 +1,96 @@
+import { AllowedComponentProps, VNodeProps } from './_common'
+
+/** 每页条目数选择器的可选项 */
+declare type PaginationPageSize =
+  | number
+  | string
+  | {
+      /** 显示文案，默认为 `${value}条/页` */
+      label?: string
+      /** 每页条目数 */
+      value: number | string
+    }
+
+declare interface PaginationProps {
+  /**
+   * 当前页码，支持 v-model:currentPage 双向绑定
+   * @default 1
+   */
+  currentPage?: number
+  /**
+   * 每页条目数，支持 v-model:pageSize 双向绑定
+   * @default 10
+   */
+  pageSize?: number
+  /**
+   * 总数据条目数
+   * @default 0
+   */
+  total?: number
+  /**
+   * 上一页按钮自定义文本，留空时显示左箭头图标
+   * @default ""
+   */
+  prevText?: string
+  /**
+   * 下一页按钮自定义文本，留空时显示右箭头图标
+   * @default ""
+   */
+  nextText?: string
+  /**
+   * 分页按钮的背景颜色
+   * @default "#f5f7fa"
+   */
+  buttonBgColor?: string
+  /**
+   * 分页按钮的边框颜色
+   * @default "#dcdfe6"
+   */
+  buttonBorderColor?: string
+  /**
+   * 每页显示条目个数选择器的选项
+   * @default [10, 20, 30, 40, 50]
+   */
+  pageSizes?: PaginationPageSize[]
+  /**
+   * 组件布局，子组件名用逗号分隔
+   * - prev-上一页，pager-页码列表，next-下一页，total-总条数，sizes-每页条数选择器
+   * @default "prev, pager, next"
+   */
+  layout?: string
+  /**
+   * 是否在只有一页时隐藏分页器
+   * @default false
+   */
+  hideOnSinglePage?: boolean
+  /**
+   * 页码改变时触发（v-model:currentPage 内部使用）
+   * @param page 最新页码
+   */
+  ['onUpdate:currentPage']?: (page: number) => any
+  /**
+   * 每页条目数改变时触发（v-model:pageSize 内部使用）
+   * @param size 最新的每页条目数
+   */
+  ['onUpdate:pageSize']?: (size: number) => any
+  /**
+   * 页码改变时触发
+   * @param page 最新页码
+   */
+  onCurrentChange?: (page: number) => any
+  /**
+   * 每页条目数改变时触发
+   * @param size 最新的每页条目数
+   */
+  onSizeChange?: (size: number) => any
+}
+
+declare interface _Pagination {
+  new (): {
+    $props: AllowedComponentProps &
+      VNodeProps &
+      PaginationProps
+  }
+}
+
+export declare const Pagination: _Pagination

package/types/comps/swipeActionItem.d.ts

@@ -44,11 +44,10 @@ declare interface SwipeActionItemProps {
    */
   name?: string | number
   /**
-   * 按钮被点击时触发
-   * @param name props参数`name`的值
-   * @param index 第几个按钮被点击
+   * 按钮被点击时触发，回调参数为对象
+   * @param event 对象形式，包含 index(第几个按钮被点击)、name(props参数`name`的值)
    */
-  onClick?: (name: any, index: number) => any
+  onClick?: (event: { index: number; name?: string | number }) => any
   /**
    * scrolling 双向绑定更新
    */

package/types/comps/textarea.d.ts

@@ -15,10 +15,16 @@ declare interface TextareaProps {
    */
   height?: string | number
   /**
-   * 设置键盘右下角按钮的文字，仅微信小程序，App-vue和H5有效
-   * @default "done"
+   * 设置键盘右下角按钮的文字，仅微信小程序，App-vue和H5有效。
+   * 为 return 时回车换行，其余取值回车会触发 confirm 且不换行
+   * @default "return"
    */
-  confirmType?: string
+  confirmType?: 'return' | 'send' | 'search' | 'next' | 'go' | 'done'
+  /**
+   * 点击键盘右下角按钮时是否保持键盘不收起，confirmType 非 return 时有效
+   * @default false
+   */
+  confirmHold?: boolean
   /**
    * 是否禁用
    * @default false

package/types/comps.d.ts

@@ -88,6 +88,7 @@ interface UviewPlusComponents {
   ['up-steps']: typeof import('./comps/steps')['Steps']
   ['up-steps-item']: typeof import('./comps/stepsItem')['StepsItem']
   ['up-empty']: typeof import('./comps/empty')['Empty']
+  ['up-pagination']: typeof import('./comps/pagination')['Pagination']
 
   // 其他组件
   ['up-parse']: typeof import('./comps/parse')['Parse']

package/types/index.d.ts

@@ -203,6 +203,8 @@ declare module 'uview-plus' {
 	export type DividerProps = import('./comps/divider')['DividerProps']
 	export type EmptyProps = import('./comps/empty')['EmptyProps']
 	export type EmptySlots = import('./comps/empty')['EmptySlots']
+	export type FormValidateError = import('./comps/form')['FormValidateError']
+	export type FormValidateOptions = import('./comps/form')['FormValidateOptions']
 	export type FormProps = import('./comps/form')['FormProps']
 	export type FormRef = typeof import('./comps/form')['FormRef']
 	export type FormItemProps = import('./comps/formItem')['FormItemProps']
@@ -243,10 +245,13 @@ declare module 'uview-plus' {
 	export type NotifyProps = import('./comps/notify')['NotifyProps']
 	export type NotifySlots = import('./comps/notify')['NotifySlots']
 	export type NotifyRef = typeof import('./comps/notify')['NotifyRef']
+	export type NumberBoxFocusPayload = import('./comps/numberBox')['NumberBoxFocusPayload']
+	export type NumberBoxChangePayload = import('./comps/numberBox')['NumberBoxChangePayload']
 	export type NumberBoxProps = import('./comps/numberBox')['NumberBoxProps']
 	export type NumberBoxSlots = import('./comps/numberBox')['NumberBoxSlots']
 	export type OverlayProps = import('./comps/overlay')['OverlayProps']
 	export type OverlaySlots = import('./comps/overlay')['OverlaySlots']
+	export type PaginationProps = import('./comps/pagination')['PaginationProps']
 	export type ParseProps = import('./comps/parse')['ParseProps']
 	export type PickerProps = import('./comps/picker')['PickerProps']
 	export type PickerRef = typeof import('./comps/picker')['PickerRef']