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

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

@@ -1,9 +1,25 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface EmptyProps extends BasicComponent {
-    image?: ReactNode;
-    imageSize: number | string;
-    description: ReactNode;
-    status: 'empty' | 'error' | 'network';
+    /**
+    * 图片,支持传入图片 URL
+    * @default -
+    */
+    image?: ReactNode
+    /**
+    * 图片大小，number 类型单位为 px
+    * @default ''
+    */
+    imageSize: number | string
+    /**
+    * 图片下方的描述文字
+    * @default ''
+    */
+    description: ReactNode
+    /**
+    * 默认图片错误类型
+    * @default 'empty'
+    */
+    status: 'empty' | 'error' | 'network'
 }
 export declare const Empty: FunctionComponent<Partial<EmptyProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -6,15 +6,55 @@ export type FixedNavPosition = {
     bottom?: string;
 };
 export interface FixedNavProps extends BasicComponent {
-    visible: boolean;
-    overlay: boolean;
-    list: Array<any>;
-    activeText: string;
-    inactiveText: string;
-    position: FixedNavPosition;
-    type: FixedNavDirection;
-    onChange: (item: any) => void;
-    onSelect: (item: any, event: MouseEvent) => void;
-    content: React.ReactNode;
+    /**
+    * 是否打开
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 展开时是否显示遮罩
+    * @default true
+    */
+    overlay: boolean
+    /**
+    * 悬浮列表内容数据
+    * @default []
+    */
+    list: Array<any>
+    /**
+    * 收起列表按钮文案
+    * @default 收起导航
+    */
+    activeText: string
+    /**
+    * 展开列表按钮文案
+    * @default 快速导航
+    */
+    inactiveText: string
+    /**
+    * fixed 垂直位置
+    * @default {top: 'auto', bottom: 'auto'}
+    */
+    position: FixedNavPosition
+    /**
+    * 导航方向,可选值 left right
+    * @default right
+    */
+    type: FixedNavDirection
+    /**
+    * 展开收起按钮回调
+    * @default 
+    */
+    onChange: (item: any) => void
+    /**
+    * 选择之后触发
+    * @default 
+    */
+    onSelect: (item: any, event: MouseEvent) => void
+    /**
+    * 自定义按钮
+    * @default -
+    */
+    content: React.ReactNode
 }
 export declare const FixedNav: FunctionComponent<Partial<FixedNavProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'onSelect' | 'content'>>;

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

@@ -2,15 +2,43 @@ import React, { CSSProperties, FunctionComponent } from 'react';
 import { GridItem, GridItemProps } from '../griditem/griditem';
 export type GridDirection = 'horizontal' | 'vertical';
 export interface GridProps {
-    columns: string | number;
-    gap: string | number;
-    center: boolean;
-    square: boolean;
-    reverse: boolean;
-    direction: GridDirection;
+    /**
+    * 列数
+    * @default 4
+    */
+    columns: string | number
+    /**
+    * 格子之间的间距，默认单位为px
+    * @default 0
+    */
+    gap: string | number
+    /**
+    * 是否将格子内容居中显示
+    * @default true
+    */
+    center: boolean
+    /**
+    * 是否将格子固定为正方形
+    * @default false
+    */
+    square: boolean
+    /**
+    * 内容翻转
+    * @default false
+    */
+    reverse: boolean
+    /**
+    * 格子内容排列的方向，可选值为 horizontal
+    * @default vertical
+    */
+    direction: GridDirection
     className?: string;
     style?: CSSProperties;
-    onClick: (item: GridItemProps, index: number) => void;
+    /**
+    * 宫格子项点击事件
+    * @default -
+    */
+    onClick: (item: GridItemProps, index: number) => void
 }
 export declare const Grid: FunctionComponent<Partial<GridProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onClick'>> & {
     Item: typeof GridItem;

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

@@ -2,7 +2,11 @@ import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 type GridDirection = 'horizontal' | 'vertical';
 export interface GridItemProps extends BasicComponent {
-    text: string | ReactNode;
+    /**
+    * 文字
+    * @default -
+    */
+    text: string | ReactNode
     index: number;
     columns: string | number;
     gap: string | number;

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

@@ -1,19 +1,71 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface ImageProps extends BasicComponent {
-    src: string;
-    fit: ImageFit;
-    position: ImagePosition;
-    alt: string;
-    width: string;
-    height: string;
-    radius: string | number;
-    error: boolean | ReactNode;
-    loading: boolean | ReactNode;
-    lazy: boolean;
-    onClick: (e: MouseEvent) => void;
-    onLoad: () => void;
-    onError: () => void;
+    /**
+    * 图片链接
+    * @default -
+    */
+    src: string
+    /**
+    * 图片填充模式，等同于原生的 object-fit 属性
+    * @default fill
+    */
+    fit: ImageFit
+    /**
+    * 图片位置，等同于原生的 object-position 属性
+    * @default center
+    */
+    position: ImagePosition
+    /**
+    * 替代文本
+    * @default -
+    */
+    alt: string
+    /**
+    * 宽度，默认单位px
+    * @default -
+    */
+    width: string
+    /**
+    * 高度，默认单位px
+    * @default -
+    */
+    height: string
+    /**
+    * 圆角大小
+    * @default -
+    */
+    radius: string | number
+    /**
+    * 是否展示图片加载失败
+    * @default true
+    */
+    error: boolean | ReactNode
+    /**
+    * 是否展示加载中图片
+    * @default true
+    */
+    loading: boolean | ReactNode
+    /**
+    * 是否为懒加载图片
+    * @default false
+    */
+    lazy: boolean
+    /**
+    * 点击图片时触发
+    * @default -
+    */
+    onClick: (e: MouseEvent) => void
+    /**
+    * 图片加载完后触发
+    * @default -
+    */
+    onLoad: () => void
+    /**
+    * 图片加载失败后触发
+    * @default -
+    */
+    onError: () => void
 }
 export type ImageFit = 'contain' | 'cover' | 'fill' | 'none' | 'scale-down' | string;
 export type ImagePosition = 'center' | 'top' | 'right' | 'bottom' | 'left' | string;

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>>;