@nutui/nutui-react 2.0.0-alpha.16 → 2.0.0-alpha.17

package/dist/style.mjs

@@ -1,5 +1,5 @@
 /*!
-* @nutui/nutui-react v2.0.0-alpha.16 Fri Jun 09 2023 18:29:59 GMT+0800 (China Standard Time)
+* @nutui/nutui-react v2.0.0-alpha.17 Wed Jun 14 2023 16:27:51 GMT+0800 (China Standard Time)
 * (c) 2023 @jdf2e.
 * Released under the MIT License.
 */

package/dist/types/packages/animate/animate.d.ts

@@ -4,12 +4,12 @@ import { BasicComponent } from '../../utils/typings';
 export interface AnimateProps extends BasicComponent {
     /**
     * 动画类型，见下方type值说明
-    * @default 'shake'
+    * @default shake
     */
     type: AnimateType
     /**
-    * 触发方式，'initial'--初始化执行;  'click'--点击执行
-    * @default 'initial'
+    * 触发方式，'initial'--初始化执行; 'click'--点击执行
+    * @default initial
     */
     action: AnimateAction
     /**

package/dist/types/packages/audio/audio.d.ts

@@ -22,12 +22,12 @@ export interface AudioProps extends BasicComponent {
     */
     loop: boolean
     /**
-    * 是否预加载语音 枚举值：'none'、'metadata'、'auto'、''
+    * 是否预加载语音
     * @default auto
     */
     preload: string
     /**
-    * 展示形式，可选值：controls 控制面板   progress 进度条  icon 图标 none 自定义
+    * 展示形式，可选值：controls 控制面板 progress 进度条 icon 图标 none 自定义
     * @default progress
     */
     type: string

package/dist/types/packages/avatar/avatar.d.ts

@@ -3,7 +3,7 @@ import { BasicComponent } from '../../utils/typings';
 export interface AvatarProps extends BasicComponent {
     /**
     * 设置头像的大小
-    * @default ''
+    * @default -
     */
     size: string
     /**
@@ -13,12 +13,12 @@ export interface AvatarProps extends BasicComponent {
     icon: React.ReactNode
     /**
     * 图片填充模式
-    * @default 'cover'
+    * @default -
     */
     fit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'
     /**
     * 设置头像的形状
-    * @default 'round'
+    * @default round
     */
     shape: AvatarShape
     /**
@@ -33,12 +33,12 @@ export interface AvatarProps extends BasicComponent {
     color: string
     /**
     * 设置图片类型头像的地址
-    * @default ''
+    * @default -
     */
     src: string
     /**
     * 设置图片类型头像无法显示时的替代文本
-    * @default ''
+    * @default -
     */
     alt: string
     /**

package/dist/types/packages/avatargroup/avatargroup.d.ts

@@ -3,12 +3,12 @@ import { BasicComponent } from '../../utils/typings';
 export interface AvatarGroupProps extends BasicComponent {
     /**
     * 头像数量超出时，会出现一个头像折叠元素。该元素内容可为...、more、+N。
-    * @default ''
+    * @default -
     */
     maxContent: string
     /**
     * 显示的最大头像个数
-    * @default ''
+    * @default -
     */
     max: string | number
     /**
@@ -23,12 +23,12 @@ export interface AvatarGroupProps extends BasicComponent {
     maxColor: string
     /**
     * 设置头像的大小，可选值为：large、normal、small，支持直接输入数字
-    * @default ''
+    * @default -
     */
     size: 'large' | 'normal' | 'small'
     /**
     * 设置头像的形状
-    * @default ''
+    * @default -
     */
     shape: 'round' | 'square'
     /**
@@ -38,7 +38,7 @@ export interface AvatarGroupProps extends BasicComponent {
     gap: string
     /**
     * 头像之间的层级关系，可选值为：left、right
-    * @default 'left'
+    * @default left
     */
     level: 'left' | 'right'
 }

package/dist/types/packages/badge/badge.d.ts

@@ -28,7 +28,7 @@ export interface BadgeProps extends BasicComponent {
     right: string
     /**
     * 徽标背景颜色,默认值为当前主题色
-    * @default 
+    * @default -
     */
     color: string
 }

package/dist/types/packages/button/button.d.ts

@@ -12,22 +12,22 @@ export interface ButtonProps extends BasicComponent {
     color: string
     /**
     * 按钮的形状
-    * @default 'round'
+    * @default round
     */
     shape: ButtonShape
     /**
     * 按钮的样式
-    * @default 'default'
+    * @default default
     */
     type: ButtonType
     /**
     * 按钮的尺寸
-    * @default 'normal'
+    * @default normal
     */
     size: ButtonSize
     /**
     * 填充模式
-    * @default 'solid'
+    * @default solid
     */
     fill: ButtonFill
     /**
@@ -51,6 +51,7 @@ export interface ButtonProps extends BasicComponent {
     */
     icon: React.ReactNode
     id: string;
+    nativeType: 'submit' | 'reset' | 'button';
     /**
     * 点击按钮时触发
     * @default false

package/dist/types/packages/cascader/cascader.d.ts

@@ -29,12 +29,12 @@ export interface CascaderProps extends BasicComponent {
     options: CascaderOption[]
     /**
     * 选中值，受控
-    * @default string)[]
+    * @default -
     */
     value?: CascaderValue
     /**
     * 默认选中值
-    * @default string)[]
+    * @default -
     */
     defaultValue?: CascaderValue
     /**
@@ -80,12 +80,12 @@ export interface CascaderProps extends BasicComponent {
     onClose?: () => void;
     /**
     * 选中值改变时触发
-    * @default 
+    * @default -
     */
     onChange: (value: CascaderValue, params?: any) => void
     /**
     * 选中项改变时触发
-    * @default 
+    * @default -
     */
     onPathChange: (value: CascaderValue, params: any) => void
 }

package/dist/types/packages/checkboxgroup/checkboxgroup.d.ts

@@ -20,11 +20,11 @@ export interface CheckboxGroupProps {
     defaultValue?: string[]
     /**
     * 限制最大可选数
-    * @default number
+    * @default -
     */
     max: number | undefined
     /**
-    * 文本所在的位置，可选值：left,right
+    * 文本所在的位置
     * @default right
     */
     labelPosition: CheckboxLabelPosition

package/dist/types/packages/circleprogress/circleprogress.d.ts

@@ -21,12 +21,12 @@ export interface CircleProgressProps extends BasicComponent {
     radius?: number | string
     /**
     * 圆环进度条端点形状
-    * @default 'round'
+    * @default round
     */
     strokeLinecap?: 'butt' | 'round' | 'square' | 'inherit'
     /**
     * 圆环进度条颜色，传入对象格式可以定义渐变色
-    * @default ''
+    * @default -
     */
     color?: object | string
     /**

package/dist/types/packages/divider/divider.d.ts

@@ -4,12 +4,12 @@ export type ContentPositionType = 'left' | 'center' | 'right';
 export type DirectionType = 'horizontal' | 'vertical';
 export interface DividerProps extends BasicComponent {
     /**
-    * 内容位置，可选值为 left right center
+    * 内容位置
     * @default center
     */
     contentPosition: ContentPositionType
     /**
-    * 水平还是垂直类型,可选值为 horizontal vertical
+    * 水平还是垂直类型
     * @default horizontal
     */
     direction?: DirectionType

package/dist/types/packages/drag/drag.d.ts

@@ -7,7 +7,7 @@ export interface DragProps extends BasicComponent {
     */
     attract: boolean
     /**
-    * 拖拽元素的拖拽方向限制，x、y、all三选一
+    * 拖拽元素的拖拽方向限制
     * @default all
     */
     direction: 'x' | 'y' | 'lock' | undefined

package/dist/types/packages/elevator/elevator.d.ts

@@ -37,7 +37,6 @@ export interface ElevatorProps extends BasicComponent {
     * @default true
     */
     showKeys: boolean
-    children: React.ReactNode;
     /**
     * 点击内容
     * @default false

package/dist/types/packages/empty/empty.d.ts

@@ -8,17 +8,17 @@ export interface EmptyProps extends BasicComponent {
     image?: ReactNode
     /**
     * 图片大小，number 类型单位为 px
-    * @default ''
+    * @default -
     */
     imageSize: number | string
     /**
     * 图片下方的描述文字
-    * @default ''
+    * @default -
     */
     description: ReactNode
     /**
     * 默认图片错误类型
-    * @default 'empty'
+    * @default empty
     */
     status: 'empty' | 'error' | 'network'
 }

package/dist/types/packages/fixednav/fixednav.d.ts

@@ -37,18 +37,18 @@ export interface FixedNavProps extends BasicComponent {
     */
     position: FixedNavPosition
     /**
-    * 导航方向,可选值 left right
+    * 导航方向
     * @default right
     */
     type: FixedNavDirection
     /**
     * 展开收起按钮回调
-    * @default 
+    * @default -
     */
     onChange: (item: any) => void
     /**
     * 选择之后触发
-    * @default 
+    * @default -
     */
     onSelect: (item: any, event: MouseEvent) => void
     /**

package/dist/types/packages/form/context.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+export declare const Context: import("react").Context<{
+    [key: string]: any;
+}>;

package/dist/types/packages/form/form.d.ts

@@ -1,9 +1,48 @@
-import React, { FunctionComponent } from 'react';
-import { useForm } from './useForm';
+import React, { FunctionComponent, ReactNode } from 'react';
+import { useForm } from './useform';
 import { BasicComponent } from '../../utils/typings';
 import { FormItem } from '../formitem/formitem';
-import { BaseForm } from './types';
-export interface FormProps extends BasicComponent, BaseForm {
+export interface FormProps extends BasicComponent {
+    /**
+    * 表单底部区域，一般放置确认和重置按钮
+    * @default null
+    */
+    footer: ReactNode
+    /**
+    * 表单初始值
+    * @default -
+    */
+    initialValues: any
+    /**
+    * 表单名称
+    * @default -
+    */
+    name: string
+    /**
+    * 经 Form.useForm() 创建的 form 控制实例，不提供时会自动创建
+    * @default -
+    */
+    form: any
+    /**
+    * 表单项 label 的位置
+    * @default right
+    */
+    labelPosition: 'top' | 'left' | 'right'
+    /**
+    * 必填表单项 label 的红色星标位置
+    * @default left
+    */
+    starPosition: 'left' | 'right'
+    /**
+    * 校验成功后触发
+    * @default -
+    */
+    onFinish: (values: any) => void
+    /**
+    * 任一表单项被校验失败后触发
+    * @default -
+    */
+    onFinishFailed: (values: any, errorFields: any) => void
 }
 export declare const Form: FunctionComponent<Partial<FormProps> & React.HTMLAttributes<HTMLFormElement>> & {
     Item: typeof FormItem;

package/dist/types/packages/form/index.d.ts

@@ -1,2 +1,3 @@
 import { Form } from './form';
+export type { FormItemRuleWithoutValidator, StoreValue, NamePath, FormInstance, FieldEntity, } from './types';
 export default Form;

package/dist/types/packages/form/types.d.ts

@@ -1,63 +1,18 @@
-export interface BaseForm {
-    /**
-     * 经 Form.useForm() 创建的 form 控制实例，不提供时会自动创建
-     */
-    form: any;
-    /**
-     * label的位置
-     * 可选值 top/left/right
-     */
-    labelPosition: string | number;
-    /**
-     * 表单分组名称
-     */
-    formGroupTitle: string;
-    starPositon: string;
-    /**
-     * 表单校验成功回调
-     */
-    onFinish: (obj: object) => void;
-    /**
-     * 表单校验失败回调
-     */
-    onFinishFailed: (value: []) => void;
-}
 export interface FormItemRuleWithoutValidator {
     [key: string]: any;
     regex?: RegExp;
     required?: boolean;
     message?: string;
 }
-export interface FormItemRule extends FormItemRuleWithoutValidator {
-    validator?: (value: any, ruleCfg: FormItemRuleWithoutValidator) => boolean | string | Promise<boolean | string>;
-}
-export interface BaseFormField {
-    /**
-     * 字段名
-     */
-    name: string;
-    /**
-     * label 标签的文本
-     */
-    label: string;
-    /**
-     * 校验规则，设置字段的校验逻辑
-     */
-    rules: FormItemRule[];
-    /**
-     * 是否禁用表单项
-     */
-    disabled: boolean;
-}
-export type StoreValue = string | number;
+export type StoreValue = any;
 export type NamePath = string | number;
 export interface Callbacks<Values = any> {
     onValuesChange?: (values: Values) => void;
     onFinish?: (values: Values) => void;
-    onFinishFailed?: (Values: Values) => void;
+    onFinishFailed?: (values: Values, errorFields: any) => void;
 }
 export interface Store {
-    [name: string]: StoreValue;
+    [name: string]: any;
 }
 export interface FormInstance<Values = any> {
     registerField: (entity: FieldEntity) => () => void;
@@ -68,7 +23,7 @@ export interface FormInstance<Values = any> {
     setCallback: (callbacks: Callbacks) => void;
 }
 export interface FieldEntity {
-    onStoreChange: () => void;
+    onStoreChange: (type?: string) => void;
     getNamePath: () => NamePath;
     props: {
         name: NamePath;
@@ -77,6 +32,3 @@ export interface FieldEntity {
         initialValue?: any;
     };
 }
-export interface IDescriptor {
-    [name: string]: string;
-}

package/dist/types/packages/formitem/formitem.d.ts

@@ -1,33 +1,62 @@
 import React from 'react';
 import { BaseFormField } from './types';
-import { FormItemContext } from './formitemcontext';
+import { Context } from '../form/context';
 import { BasicComponent } from '../../utils/typings';
 type TextAlign = 'start' | 'end' | 'left' | 'right' | 'center' | 'justify' | 'match-parent';
 export interface FormItemProps extends BasicComponent, BaseFormField {
-    labelWidth: string | number;
-    errorMessageAlign: TextAlign;
-    showErrorLine: boolean;
-    showErrorMessage: boolean;
-    initialValue: string;
+    /**
+    * 必填表单项 label 的红色星标,仅用于控制样式
+    * @default false
+    */
+    required: boolean
+    /**
+    * 设置子元素默认值
+    * @default -
+    */
+    initialValue: any
+    /**
+    * 设置收集字段值变更的时机
+    * @default -
+    */
+    trigger: string
+    /**
+    * 子节点的值的属性，如 Checkbox 的是 'checked'
+    * @default -
+    */
+    valuePropName: string
+    /**
+    * 设置如何将 event 的值转换成字段值
+    * @default -
+    */
+    getValueFromEvent: (...args: any) => any
+    /**
+    * 点击事件并收集子组件 Ref
+    * @default -
+    */
+    onClick: (event: React.MouseEvent, componentRef: React.MutableRefObject<any>) => void
+    /**
+    * 错误提示文案对齐方式
+    * @default left
+    */
+    errorMessageAlign: TextAlign
 }
 declare const defaultProps: FormItemProps;
 export type FieldProps = typeof defaultProps & Partial<BaseFormField>;
-export declare class FormItem extends React.Component<FieldProps> {
+export declare class FormItem extends React.Component<FieldProps, {
+    resetCount: number;
+}> {
     static defaultProps: FormItemProps;
     static contextType: any;
-    context: React.ContextType<typeof FormItemContext>;
+    context: React.ContextType<typeof Context>;
     private cancelRegister;
-    private isInitialValue;
+    private componentRef;
+    constructor(props: FieldProps);
     componentDidMount(): void;
     componentWillUnmount(): void;
-    getControlled: (children: React.ReactElement) => {
-        value: any;
-        defaultValue: any;
-        onChange: (event: React.ChangeEvent<HTMLInputElement> | number | string | string[]) => void;
-    };
-    onStoreChange: () => void;
+    getControlled: (children: React.ReactElement) => any;
+    refresh: () => void;
+    onStoreChange: (type?: string) => void;
     renderLayout: (childNode: React.ReactNode) => JSX.Element;
-    pxCheck: (value: string | number) => string;
     render(): JSX.Element;
 }
 export {};

package/dist/types/packages/formitem/index.d.ts

@@ -1,2 +1,3 @@
 import { FormItem } from './formitem';
+export type { FormItemRuleWithoutValidator, FormItemRule, FormInstance, } from './types';
 export default FormItem;

package/dist/types/packages/formitem/types.d.ts

@@ -1,27 +1,3 @@
-export interface BaseForm {
-    /**
-     * 经 Form.useForm() 创建的 form 控制实例，不提供时会自动创建
-     */
-    form: any;
-    /**
-     * label的位置
-     * 可选值 top/left/right
-     */
-    labelPosition: string | number;
-    /**
-     * 表单分组名称
-     */
-    formGroupTitle: string;
-    starPositon: string;
-    /**
-     * 表单校验成功回调
-     */
-    onFinish: (obj: object) => void;
-    /**
-     * 表单校验失败回调
-     */
-    onFinishFailed: (value: []) => void;
-}
 export interface FormItemRuleWithoutValidator {
     [key: string]: any;
     regex?: RegExp;
@@ -49,16 +25,13 @@ export interface BaseFormField {
      */
     disabled: boolean;
 }
-export type StoreValue = string | number;
+export type StoreValue = any;
 export type NamePath = string | number;
 export interface Callbacks<Values = any> {
     onValuesChange?: (values: Values) => void;
     onFinish?: (values: Values) => void;
     onFinishFailed?: (Values: Values) => void;
 }
-export interface Store {
-    [name: string]: StoreValue;
-}
 export interface FormInstance<Values = any> {
     registerField: (entity: FieldEntity) => () => void;
     getFieldValue: (name: NamePath) => StoreValue;
@@ -77,6 +50,3 @@ export interface FieldEntity {
         initialValue?: any;
     };
 }
-export interface IDescriptor {
-    [name: string]: string;
-}

package/dist/types/packages/grid/grid.d.ts

@@ -28,7 +28,7 @@ export interface GridProps {
     */
     reverse: boolean
     /**
-    * 格子内容排列的方向，可选值为 horizontal
+    * 格子内容排列的方向
     * @default vertical
     */
     direction: GridDirection

package/dist/types/packages/infiniteloading/infiniteloading.d.ts

@@ -13,7 +13,7 @@ export interface InfiniteLoadingProps extends BasicComponent {
     threshold: number
     /**
     * 获取监听的目标元素
-    * @default ''
+    * @default -
     */
     target: string
     /**

package/dist/types/packages/inputnumber/inputnumber.d.ts

@@ -20,7 +20,7 @@ export interface InputNumberProps extends BasicComponent {
     * 只读状态禁用输入框操作行为
     * @default false
     */
-    readonly: boolean
+    readOnly: boolean
     /**
     * 当前值，受控值
     * @default -

package/dist/types/packages/noticebar/noticebar.d.ts

@@ -53,17 +53,17 @@ export interface NoticeBarProps extends BasicComponent {
     click?: (event: any) => void;
     /**
     * 关闭通知栏时触发
-    * @default 
+    * @default -
     */
     onClose?: (event: any) => void
     /**
     * 外层点击事件回调
-    * @default 
+    * @default -
     */
     onClick?: (event: any) => void
     /**
     * 垂直滚动多条数据时，点击当前展示的信息时触发
-    * @default 
+    * @default -
     */
     onClickItem?: (event: any, value: any) => void
 }

package/dist/types/packages/overlay/overlay.d.ts

@@ -28,7 +28,7 @@ export interface OverlayProps extends BasicComponent {
     lockScroll: boolean
     /**
     * 点击时触发
-    * @default 
+    * @default -
     */
     onClick: (event: MouseEvent) => void
     /**

package/dist/types/packages/pagination/pagination.d.ts

@@ -12,7 +12,7 @@ export interface PaginationProps extends BasicComponent {
     */
     defaultValue: number
     /**
-    * 显示模式,可选值为：multi，simple
+    * 显示模式
     * @default multi
     */
     mode: 'multi' | 'simple'