@nutui/nutui-react 2.0.0-alpha.12 → 2.0.0-alpha.14

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

@@ -1,9 +1,17 @@
 import { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface ImagePreviewProps extends BasicComponent {
+    /**
+    * 预览图片数组
+    * @default []
+    */
     images: Array<{
         src: string;
-    }>;
+    }>
+    /**
+    * 预览的视频数组（视频自动放到图片之前）
+    * @default []
+    */
     videos: Array<{
         source: {
             src: string;
@@ -13,15 +21,47 @@ export interface ImagePreviewProps extends BasicComponent {
             muted: boolean;
             controls: boolean;
         };
-    }>;
-    visible: boolean;
-    autoPlay: number | string;
-    value?: number;
-    defaultValue: number;
-    closeOnContentClick: boolean;
-    indicator: boolean;
-    indicatorColor: string;
+    }>
+    /**
+    * 是否展示预览图片
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 自动轮播时长，0表示不会自动轮播
+    * @default 3000
+    */
+    autoPlay: number | string
+    /**
+    * 页码，受控
+    * @default 1
+    */
+    value?: number
+    /**
+    * 初始页码
+    * @default 1
+    */
+    defaultValue: number
+    /**
+    * 点击图片可以退出预览
+    * @default false
+    */
+    closeOnContentClick: boolean
+    /**
+    * 分页指示器是否展示
+    * @default false
+    */
+    indicator: boolean
+    /**
+    * 分页指示器选中的颜色
+    * @default #fff
+    */
+    indicatorColor: string
     onChange: (value: number) => void;
-    onClose: () => void;
+    /**
+    * 点击遮罩关闭图片预览时触发
+    * @default -
+    */
+    onClose: () => void
 }
 export declare const ImagePreview: FunctionComponent<Partial<ImagePreviewProps>>;

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

@@ -1,7 +1,19 @@
 import React, { FunctionComponent } from 'react';
 export interface IndicatorProps {
-    total: number;
-    current: number;
-    direction: string;
+    /**
+    * 步骤长度
+    * @default 3
+    */
+    total: number
+    /**
+    * 当前步骤
+    * @default 0
+    */
+    current: number
+    /**
+    * 展示方向，默认为水平方向
+    * @default horizontal
+    */
+    direction: string
 }
 export declare const Indicator: FunctionComponent<Partial<IndicatorProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -5,25 +5,105 @@ export type InputFormatTrigger = 'onChange' | 'onBlur';
 export type InputType = HTMLInputTypeAttribute;
 export type ConfirmTextType = 'send' | 'search' | 'next' | 'go' | 'done';
 export interface InputProps extends BasicComponent {
-    type: InputType;
-    name: string;
-    defaultValue?: string;
-    value?: string;
-    placeholder: string;
-    align: InputAlignType;
-    disabled: boolean;
-    readOnly: boolean;
-    maxLength: number;
-    clearable: boolean;
-    clearIcon: React.ReactNode;
-    formatTrigger: InputFormatTrigger;
-    autoFocus: boolean;
-    confirmType: ConfirmTextType;
-    formatter?: (value: string) => void;
-    onChange?: (value: string) => void;
-    onBlur?: (value: string) => void;
-    onFocus?: (value: string) => void;
-    onClear?: (value: string) => void;
-    onClick?: (value: MouseEvent<HTMLDivElement>) => void;
+    /**
+    * 输入框类型，支持原生 input 标签的所有 type 属性，另外还支持 number digit
+    * @default text
+    */
+    type: InputType
+    /**
+    * 组件名字，用于表单提交获取数据
+    * @default -
+    */
+    name: string
+    /**
+    * 初始默认值
+    * @default -
+    */
+    defaultValue?: string
+    /**
+    * 初始默认值
+    * @default -
+    */
+    value?: string
+    /**
+    * 输入框为空时占位符
+    * @default -
+    */
+    placeholder: string
+    /**
+    * 输入框内容对齐方式，可选值 left、center、right
+    * @default left
+    */
+    align: InputAlignType
+    /**
+    * 是否禁用
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 是否只读
+    * @default false
+    */
+    readOnly: boolean
+    /**
+    * 限制最长输入字符
+    * @default -
+    */
+    maxLength: number
+    /**
+    * 展示清除 Icon
+    * @default false
+    */
+    clearable: boolean
+    /**
+    * 清除图标 Icon <a href="#/icon">可参考 Icon </a>
+    * @default MaskClose
+    */
+    clearIcon: React.ReactNode
+    /**
+    * 格式化函数触发的时机，可选值为 onChange、onBlur
+    * @default -
+    */
+    formatTrigger: InputFormatTrigger
+    /**
+    * 是否自动获得焦点，iOS 系统不支持该属性
+    * @default false
+    */
+    autoFocus: boolean
+    /**
+    * 键盘右下角按钮的文字，仅在type='text'时生效,可选值 send：发送、search：搜索、next：下一个、go：前往、done：完成
+    * @default done
+    */
+    confirmType: ConfirmTextType
+    /**
+    * 输入内容格式化函数
+    * @default -
+    */
+    formatter?: (value: string) => void
+    /**
+    * 输入框内容变化时触发
+    * @default -
+    */
+    onChange?: (value: string) => void
+    /**
+    * 失去焦点后触发
+    * @default -
+    */
+    onBlur?: (value: string) => void
+    /**
+    * 获得焦点后触发
+    * @default -
+    */
+    onFocus?: (value: string) => void
+    /**
+    * 点击清空按钮时触发
+    * @default -
+    */
+    onClear?: (value: string) => void
+    /**
+    * 点击 input 容器触发
+    * @default -
+    */
+    onClick?: (value: MouseEvent<HTMLDivElement>) => void
 }
 export declare const Input: React.ForwardRefExoticComponent<Partial<InputProps> & Omit<React.HTMLAttributes<HTMLDivElement>, "onClick" | "onFocus" | "onBlur" | "onChange"> & React.RefAttributes<unknown>>;

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

@@ -1,22 +1,90 @@
 import React, { FunctionComponent, ChangeEvent, FocusEvent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface InputNumberProps extends BasicComponent {
-    disabled: boolean;
-    min: string | number;
-    max: string | number;
-    readonly: boolean;
-    value: string | number;
-    defaultValue: string | number;
-    allowEmpty: boolean;
-    step: string | number;
-    digits: string | number;
-    async: boolean;
-    formatter?: (displayValue: string | number) => string;
-    onPlus: (e: MouseEvent) => void;
-    onMinus: (e: MouseEvent) => void;
-    onOverlimit: (e: MouseEvent) => void;
-    onBlur: (e: ChangeEvent<HTMLInputElement>) => void;
-    onFocus: (e: FocusEvent<HTMLInputElement>) => void;
-    onChange: (param: string | number, e: MouseEvent | ChangeEvent<HTMLInputElement>) => void;
+    /**
+    * 禁用所有功能
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 最小值限制
+    * @default 1
+    */
+    min: string | number
+    /**
+    * 最大值限制
+    * @default 9999
+    */
+    max: string | number
+    /**
+    * 只读状态禁用输入框操作行为
+    * @default false
+    */
+    readonly: boolean
+    /**
+    * 当前值，受控值
+    * @default -
+    */
+    value: string | number
+    /**
+    * 默认值
+    * @default 0
+    */
+    defaultValue: string | number
+    /**
+    * 是否允许内容为空
+    * @default false
+    */
+    allowEmpty: boolean
+    /**
+    * 步长
+    * @default 1
+    */
+    step: string | number
+    /**
+    * 设置保留的小数位
+    * @default 0
+    */
+    digits: string | number
+    /**
+    * 支持异步修改
+    * @default false
+    */
+    async: boolean
+    /**
+    * 指定输入框展示值的格式
+    * @default -
+    */
+    formatter?: (displayValue: string | number) => string
+    /**
+    * 点击增加按钮时触发
+    * @default -
+    */
+    onPlus: (e: MouseEvent) => void
+    /**
+    * 点击减少按钮时触发
+    * @default -
+    */
+    onMinus: (e: MouseEvent) => void
+    /**
+    * 点击不可用的按钮时触发
+    * @default -
+    */
+    onOverlimit: (e: MouseEvent) => void
+    /**
+    * 输入框失去焦点时触发
+    * @default -
+    */
+    onBlur: (e: ChangeEvent<HTMLInputElement>) => void
+    /**
+    * 输入框获得焦点时触发
+    * @default -
+    */
+    onFocus: (e: FocusEvent<HTMLInputElement>) => void
+    /**
+    * 值改变时触发
+    * @default -
+    */
+    onChange: (param: string | number, e: MouseEvent | ChangeEvent<HTMLInputElement>) => void
 }
 export declare const InputNumber: FunctionComponent<Partial<InputNumberProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'onBlur'>>;

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

@@ -1,11 +1,31 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface MenuProps extends BasicComponent {
-    activeColor: string;
-    closeOnOverlayClick: boolean;
-    scrollFixed: boolean | string | number;
-    lockScroll: boolean;
-    icon: React.ReactNode;
+    /**
+    * 选项的选中态图标颜色
+    * @default #F2270C
+    */
+    activeColor: string
+    /**
+    * 是否在点击遮罩层后关闭菜单
+    * @default true
+    */
+    closeOnOverlayClick: boolean
+    /**
+    * 滚动后是否固定，可设置固定位置
+    * @default true
+    */
+    scrollFixed: boolean | string | number
+    /**
+    * 背景是否锁定
+    * @default true
+    */
+    lockScroll: boolean
+    /**
+    * 自定义标题图标
+    * @default -
+    */
+    icon: React.ReactNode
     children: React.ReactNode;
 }
 export declare const Menu: FunctionComponent<Partial<MenuProps>>;

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

@@ -5,17 +5,45 @@ export interface OptionItem {
     value: string | number;
 }
 export interface MenuItemProps extends BasicComponent {
-    title: React.ReactNode;
-    options: OptionItem[];
-    disabled: boolean;
-    columns: number;
-    icon: React.ReactNode;
+    /**
+    * 菜单项标题
+    * @default 当前选中项文字
+    */
+    title: React.ReactNode
+    /**
+    * 选项数组
+    * @default -
+    */
+    options: OptionItem[]
+    /**
+    * 是否禁用菜单
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 可以设置一行展示多少列 options
+    * @default 1
+    */
+    columns: number
+    /**
+    * 自定义选项图标
+    * @default Check
+    */
+    icon: React.ReactNode
     closeOnClickAway: boolean;
-    direction: string;
+    /**
+    * 菜单展开方向，可选值为up
+    * @default down
+    */
+    direction: string
     activeTitleClass: string;
     inactiveTitleClass: string;
     value: string | number;
-    onChange: (event: any) => void;
+    /**
+    * 选择 option 之后触发
+    * @default -
+    */
+    onChange: (event: any) => void
     children: React.ReactNode;
 }
 export declare const MenuItem: React.ForwardRefExoticComponent<Partial<MenuItemProps> & React.RefAttributes<unknown>>;

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

@@ -1,22 +1,70 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface NoticeBarProps extends BasicComponent {
-    direction: string;
+    /**
+    * 滚动的方向，可选 horizontal、vertical
+    * @default horizontal
+    */
+    direction: string
     list: any;
     duration: number;
     height: number;
-    content: string;
-    closeable: boolean;
-    wrap: boolean;
-    leftIcon: ReactNode;
-    rightIcon: ReactNode;
-    delay: string | number;
-    scrollable: boolean | null;
-    speed: number;
+    /**
+    * 提示的信息
+    * @default -
+    */
+    content: string
+    /**
+    * 是否启用关闭模式
+    * @default false
+    */
+    closeable: boolean
+    /**
+    * 是否开启文本换行
+    * @default false
+    */
+    wrap: boolean
+    /**
+    * 左边的 icon，closeable 模式下默认为空
+    * @default -
+    */
+    leftIcon: ReactNode
+    /**
+    * 右边的 icon，在 closeable 模式下默认为 <Close />
+    * @default -
+    */
+    rightIcon: ReactNode
+    /**
+    * 延时多少秒
+    * @default 1
+    */
+    delay: string | number
+    /**
+    * 是否可以滚动
+    * @default true
+    */
+    scrollable: boolean | null
+    /**
+    * 滚动速率 (px/s)
+    * @default 50
+    */
+    speed: number
     close?: (event: any) => void;
     click?: (event: any) => void;
-    onClose?: (event: any) => void;
-    onClick?: (event: any) => void;
-    onClickItem?: (event: any, value: any) => void;
+    /**
+    * 关闭通知栏时触发
+    * @default 
+    */
+    onClose?: (event: any) => void
+    /**
+    * 外层点击事件回调
+    * @default 
+    */
+    onClick?: (event: any) => void
+    /**
+    * 垂直滚动多条数据时，点击当前展示的信息时触发
+    * @default 
+    */
+    onClickItem?: (event: any, value: any) => void
 }
 export declare const NoticeBar: FunctionComponent<Partial<NoticeBarProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onClick'>>;

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

@@ -2,11 +2,31 @@ import * as React from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface NotifyProps extends BasicComponent {
     id: string;
-    duration: number;
-    type: string;
-    position: string;
-    onClick: () => void;
-    onClose: () => void;
+    /**
+    * 展示时长(ms)，值为 0 时，notify 不会消失
+    * @default 3000
+    */
+    duration: number
+    /**
+    * 提示的信息类型（primary，success ，danger，warning）
+    * @default danger
+    */
+    type: string
+    /**
+    * 自定义位置 (top, bottom)
+    * @default top
+    */
+    position: string
+    /**
+    * 点击事件回调
+    * @default -
+    */
+    onClick: () => void
+    /**
+    * 关闭事件回调
+    * @default -
+    */
+    onClose: () => void
 }
 declare const _default: {
     text(message: string | React.ReactNode, option?: {}): void;

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

@@ -1,15 +1,55 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { PopupProps } from '../../packages/popup/popup';
 export interface NumberKeyboardProps extends PopupProps {
-    visible: boolean;
-    title?: ReactNode;
-    confirmText?: string;
-    type: 'default' | 'rightColumn';
-    custom: Array<string>;
-    random: boolean;
-    onChange?: (value: string) => void;
-    onDelete?: () => void;
-    onClose: () => void;
-    onConfirm?: () => void;
+    /**
+    * 是否显示键盘
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 键盘标题
+    * @default -
+    */
+    title?: ReactNode
+    /**
+    * 自定义完成按钮文字，如"支付"，"下一步"，"提交"等
+    * @default 完成
+    */
+    confirmText?: string
+    /**
+    * 键盘模式, default：默认样式 rightColumn：带右侧栏
+    * @default default
+    */
+    type: 'default' | 'rightColumn'
+    /**
+    * 自定义键盘额外的键, 数组形式最多支持添加 2 个, 超出默认取前 2 项
+    * @default -
+    */
+    custom: Array<string>
+    /**
+    * 随机数
+    * @default false
+    */
+    random: boolean
+    /**
+    * 点击按键时触发
+    * @default -
+    */
+    onChange?: (value: string) => void
+    /**
+    * 点击删除键时触发
+    * @default -
+    */
+    onDelete?: () => void
+    /**
+    * 点击关闭按钮或非键盘区域时触发
+    * @default -
+    */
+    onClose: () => void
+    /**
+    * 点击确定按钮时触发
+    * @default -
+    */
+    onConfirm?: () => void
 }
 export declare const NumberKeyboard: FunctionComponent<Partial<NumberKeyboardProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'onClick' | 'title'>>;

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

@@ -1,14 +1,46 @@
 import React, { FunctionComponent, MouseEvent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface OverlayProps extends BasicComponent {
-    zIndex: number;
-    duration: number;
-    closeOnOverlayClick: boolean;
-    visible: boolean;
-    lockScroll: boolean;
-    onClick: (event: MouseEvent) => void;
-    afterShow: () => void;
-    afterClose: () => void;
+    /**
+    * 遮罩层级
+    * @default 2000
+    */
+    zIndex: number
+    /**
+    * 动画时长，单位秒
+    * @default 0.3
+    */
+    duration: number
+    /**
+    * 是否点击遮罩关闭
+    * @default true
+    */
+    closeOnOverlayClick: boolean
+    /**
+    * 当前组件是否显示
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 背景是否锁定
+    * @default true
+    */
+    lockScroll: boolean
+    /**
+    * 点击时触发
+    * @default 
+    */
+    onClick: (event: MouseEvent) => void
+    /**
+    * 完全展示后触发
+    * @default -
+    */
+    afterShow: () => void
+    /**
+    * 完全关闭后触发
+    * @default -
+    */
+    afterClose: () => void
 }
 export declare const defaultOverlayProps: OverlayProps;
 export declare const Overlay: FunctionComponent<Partial<OverlayProps> & React.HTMLAttributes<HTMLDivElement>>;