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

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

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

@@ -1,16 +1,60 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface PaginationProps extends BasicComponent {
-    value: number;
-    defaultValue: number;
-    mode: 'multi' | 'simple';
-    prev: ReactNode;
-    next: ReactNode;
-    total: number;
-    pageSize: number;
-    itemSize: number;
-    ellipse: boolean;
-    itemRender: (page: any) => ReactNode;
-    onChange: (currPage: number) => void;
+    /**
+    * 当前页码，受控值，与 onChange 搭配使用
+    * @default -
+    */
+    value: number
+    /**
+    * 默认页码，非受控
+    * @default 1
+    */
+    defaultValue: number
+    /**
+    * 显示模式,可选值为：multi，simple
+    * @default multi
+    */
+    mode: 'multi' | 'simple'
+    /**
+    * 自定义上一页按钮内容
+    * @default 上一页
+    */
+    prev: ReactNode
+    /**
+    * 自定义下一页按钮内容
+    * @default 下一页
+    */
+    next: ReactNode
+    /**
+    * 总记录数
+    * @default 50
+    */
+    total: number
+    /**
+    * 每页记录数
+    * @default 10
+    */
+    pageSize: number
+    /**
+    * 显示的页码个数
+    * @default 5
+    */
+    itemSize: number
+    /**
+    * 是否显示省略号
+    * @default false
+    */
+    ellipse: boolean
+    /**
+    * 用于自定义页码的结构
+    * @default -
+    */
+    itemRender: (page: any) => ReactNode
+    /**
+    * 页码改变时触发
+    * @default -
+    */
+    onChange: (currPage: number) => void
 }
 export declare const Pagination: FunctionComponent<Partial<PaginationProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange'>>;

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

@@ -2,17 +2,61 @@ import React, { RefObject } from 'react';
 import { PickerOption } from './types';
 import { BasicComponent } from '../../utils/typings';
 export interface PickerProps extends BasicComponent {
-    visible: boolean;
-    title?: string;
-    options: (PickerOption | PickerOption[])[];
-    value?: (number | string)[];
-    defaultValue?: (number | string)[];
-    threeDimensional?: boolean;
-    duration: number | string;
-    onConfirm?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void;
-    onClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void;
-    afterClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], pickerRef: RefObject<HTMLDivElement>) => void;
-    onChange?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], columnIndex: number) => void;
+    /**
+    * 是否可见
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 设置标题
+    * @default -
+    */
+    title?: string
+    /**
+    * 列表数据
+    * @default []
+    */
+    options: (PickerOption | PickerOption[])[]
+    /**
+    * 选中值，受控
+    * @default []
+    */
+    value?: (number | string)[]
+    /**
+    * 默认选中
+    * @default []
+    */
+    defaultValue?: (number | string)[]
+    /**
+    * 是否开启3D效果
+    * @default true
+    */
+    threeDimensional?: boolean
+    /**
+    * 快速滑动时惯性滚动的时长，单位 ms
+    * @default 1000
+    */
+    duration: number | string
+    /**
+    * 点击确认按钮时候回调
+    * @default -
+    */
+    onConfirm?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void
+    /**
+    * 关闭时触发
+    * @default -
+    */
+    onClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void
+    /**
+    * 联动时，关闭时回调
+    * @default -
+    */
+    afterClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], pickerRef: RefObject<HTMLDivElement>) => void
+    /**
+    * 每一列值变更时调用
+    * @default -
+    */
+    onChange?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], columnIndex: number) => void
 }
 declare const Picker: React.ForwardRefExoticComponent<Partial<PickerProps> & React.RefAttributes<unknown>>;
 export default Picker;

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

@@ -2,21 +2,81 @@ import React, { FunctionComponent, MouseEvent } from 'react';
 import { OverlayProps } from '../../packages/overlay/overlay';
 type Teleport = HTMLElement | (() => HTMLElement) | null;
 export interface PopupProps extends OverlayProps {
-    position: string;
-    transition: string;
-    overlayStyle: React.CSSProperties;
-    overlayClassName: string;
-    closeable: boolean;
-    closeIconPosition: string;
-    closeIcon: React.ReactNode;
-    destroyOnClose: boolean;
-    portal: Teleport;
-    overlay: boolean;
-    round: boolean;
-    onOpen: () => void;
-    onClose: () => void;
-    onClickOverlay: (e: MouseEvent) => boolean | void;
-    onClickCloseIcon: (e: MouseEvent) => boolean | void;
+    /**
+    * 弹出位置（top,bottom,left,right,center）
+    * @default center
+    */
+    position: string
+    /**
+    * 动画名
+    * @default -
+    */
+    transition: string
+    /**
+    * 自定义遮罩样式
+    * @default -
+    */
+    overlayStyle: React.CSSProperties
+    /**
+    * 自定义遮罩类名
+    * @default -
+    */
+    overlayClassName: string
+    /**
+    * 是否显示关闭按钮
+    * @default false
+    */
+    closeable: boolean
+    /**
+    * 关闭按钮位置（top-left,top-right,bottom-left,bottom-right）
+    * @default top-right
+    */
+    closeIconPosition: string
+    /**
+    * 自定义 Icon
+    * @default close
+    */
+    closeIcon: React.ReactNode
+    /**
+    * 组件不可见时，卸载内容
+    * @default false
+    */
+    destroyOnClose: boolean
+    /**
+    * 指定节点挂载
+    * @default null
+    */
+    portal: Teleport
+    /**
+    * 是否显示遮罩
+    * @default true
+    */
+    overlay: boolean
+    /**
+    * 是否显示圆角
+    * @default false
+    */
+    round: boolean
+    /**
+    * 打开弹框时触发
+    * @default -
+    */
+    onOpen: () => void
+    /**
+    * 关闭弹框时触发
+    * @default -
+    */
+    onClose: () => void
+    /**
+    * 点击遮罩触发
+    * @default -
+    */
+    onClickOverlay: (e: MouseEvent) => boolean | void
+    /**
+    * 点击关闭图标时触发
+    * @default -
+    */
+    onClickCloseIcon: (e: MouseEvent) => boolean | void
 }
 export declare const Popup: FunctionComponent<Partial<PopupProps> & React.HTMLAttributes<HTMLDivElement>>;
 export {};

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

@@ -1,12 +1,40 @@
 import { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface PriceProps extends BasicComponent {
-    price: number | string;
-    symbol: string;
-    digits: number;
-    thousands: boolean;
-    position: string;
-    size: string;
-    line: boolean;
+    /**
+    * 价格数量
+    * @default 0
+    */
+    price: number | string
+    /**
+    * 符号类型
+    * @default ¥
+    */
+    symbol: string
+    /**
+    * 小数位位数
+    * @default 2
+    */
+    digits: number
+    /**
+    * 是否按照千分号形式显示
+    * @default false
+    */
+    thousands: boolean
+    /**
+    * 符号显示在价格前或者后，before、after
+    * @default before
+    */
+    position: string
+    /**
+    * 价格尺寸，large、normal、small
+    * @default large
+    */
+    size: string
+    /**
+    * 是否划线价
+    * @default false
+    */
+    line: boolean
 }
 export declare const Price: FunctionComponent<Partial<PriceProps>>;

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

@@ -1,13 +1,45 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface ProgressProps extends BasicComponent {
-    percent: number;
-    background: string;
-    color: string;
-    strokeWidth: string;
-    showText: boolean;
-    animated: boolean;
-    lazy: boolean;
-    delay: number;
+    /**
+    * 百分比
+    * @default 0
+    */
+    percent: number
+    /**
+    * 进度条背景颜色
+    * @default #f3f3f3
+    */
+    background: string
+    /**
+    * 进度条线条颜色
+    * @default linear-gradient(135deg, #fa2c19 0%, #fa6419 100%)
+    */
+    color: string
+    /**
+    * 进度条宽度
+    * @default -
+    */
+    strokeWidth: string
+    /**
+    * 是否显示文字内容
+    * @default false
+    */
+    showText: boolean
+    /**
+    * 是否展示动画效果
+    * @default false
+    */
+    animated: boolean
+    /**
+    * 每次进入可视区展示进度条动画
+    * @default false
+    */
+    lazy: boolean
+    /**
+    * 延迟数据加载时长，单位 ms
+    * @default 0
+    */
+    delay: number
 }
 export declare const Progress: FunctionComponent<Partial<ProgressProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -2,15 +2,55 @@ import { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export type PullStatus = 'pulling' | 'canRelease' | 'refreshing' | 'complete';
 export interface PullToRefreshProps extends BasicComponent {
-    onRefresh: () => Promise<any>;
-    pullingText: ReactNode;
-    canReleaseText: ReactNode;
-    refreshingText: ReactNode;
-    completeText: ReactNode;
-    completeDelay: number;
-    headHeight: number;
-    threshold: number;
-    disabled: boolean;
-    renderText: (status: PullStatus) => ReactNode;
+    /**
+    * 触发刷新时的处理函数
+    * @default -
+    */
+    onRefresh: () => Promise<any>
+    /**
+    * 下拉的提示文案
+    * @default 下拉刷新
+    */
+    pullingText: ReactNode
+    /**
+    * 释放的提示文案
+    * @default 释放立即刷新
+    */
+    canReleaseText: ReactNode
+    /**
+    * 刷新时的提示文案
+    * @default 加载中……
+    */
+    refreshingText: ReactNode
+    /**
+    * 完成时的提示文案
+    * @default 刷新成功
+    */
+    completeText: ReactNode
+    /**
+    * 完成后延迟消失的时间，单位为 ms
+    * @default 500
+    */
+    completeDelay: number
+    /**
+    * 头部提示内容区的高度，单位为 px
+    * @default 40
+    */
+    headHeight: number
+    /**
+    * 触发刷新需要下拉多少距离，单位为 px
+    * @default 60
+    */
+    threshold: number
+    /**
+    * 是否禁用下拉刷新
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 根据下拉状态，自定义下拉提示文案
+    * @default -
+    */
+    renderText: (status: PullStatus) => ReactNode
 }
 export declare const PullToRefresh: FunctionComponent<Partial<PullToRefreshProps>>;