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

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

@@ -3,9 +3,21 @@ interface TabPanelInnerProps {
     autoHeightClassName: string;
 }
 export interface TabPaneProps {
-    title: string | number;
-    value: string | number;
-    disabled: boolean;
+    /**
+    * 标题
+    * @default -
+    */
+    title: string | number
+    /**
+    * 标签 Key , 匹配的标识符, 默认为索引值
+    * @default -
+    */
+    value: string | number
+    /**
+    * 是否禁用标签
+    * @default false
+    */
+    disabled: boolean
     className: string;
     children?: React.ReactNode;
 }

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

@@ -8,18 +8,66 @@ export type TabsTitle = {
     value: string | number;
 };
 export interface TabsProps extends BasicComponent {
-    tabStyle: React.CSSProperties;
-    value: string | number;
-    defaultValue: string | number;
-    activeColor: string;
-    direction: 'horizontal' | 'vertical';
-    activeType: 'line' | 'smile';
-    duration: number | string;
-    align: 'left' | 'right';
-    title: () => JSX.Element[];
-    onChange: (index: string | number) => void;
-    onClick: (index: string | number) => void;
-    autoHeight: boolean;
+    /**
+    * 标签栏样式
+    * @default {}
+    */
+    tabStyle: React.CSSProperties
+    /**
+    * 当前激活 tab 面板的值
+    * @default 0
+    */
+    value: string | number
+    /**
+    * 初始化激活 tab 的值
+    * @default 0
+    */
+    defaultValue: string | number
+    /**
+    * 标签选中色
+    * @default #1a1a1a
+    */
+    activeColor: string
+    /**
+    * 使用横纵方向 可选值 horizontal、vertical
+    * @default horizontal
+    */
+    direction: 'horizontal' | 'vertical'
+    /**
+    * 选中底部展示样式 可选值 line、smile
+    * @default line
+    */
+    activeType: 'line' | 'smile'
+    /**
+    * 切换动画时长,单位 ms 0 代表无动画
+    * @default 300
+    */
+    duration: number | string
+    /**
+    * 标题左对齐
+    * @default -
+    */
+    align: 'left' | 'right'
+    /**
+    * 自定义导航区域
+    * @default -
+    */
+    title: () => JSX.Element[]
+    /**
+    * 当前激活的标签改变时触发
+    * @default -
+    */
+    onChange: (index: string | number) => void
+    /**
+    * 点击标签时触发
+    * @default -
+    */
+    onClick: (index: string | number) => void
+    /**
+    * 自动高度。设置为 true 时，nut-tabs 和 nut-tabs\_\_content 会随着当前 nut-tabpane 的高度而发生变化。
+    * @default false
+    */
+    autoHeight: boolean
     children?: React.ReactNode;
 }
 export declare const Tabs: FunctionComponent<Partial<TabsProps>> & {

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

@@ -1,17 +1,65 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface TextAreaProps extends BasicComponent {
-    value: string;
-    defaultValue: string;
-    showCount: boolean;
-    maxLength: number;
-    rows: number;
-    placeholder: string;
-    readOnly: boolean;
-    disabled: boolean;
-    autoSize: boolean;
-    onChange: (value: string) => void;
-    onBlur: (event: Event) => void;
-    onFocus: (event: Event) => void;
+    /**
+    * 输入框内容，受控
+    * @default -
+    */
+    value: string
+    /**
+    * 初始默认值，非受控
+    * @default -
+    */
+    defaultValue: string
+    /**
+    * textarea 是否展示输入字符。须配合maxLength使用
+    * @default false
+    */
+    showCount: boolean
+    /**
+    * 限制最长输入字符，-1 表示无限制
+    * @default 140
+    */
+    maxLength: number
+    /**
+    * textarea 的行数
+    * @default 2
+    */
+    rows: number
+    /**
+    * 设置占位提示文字
+    * @default 请输入内容
+    */
+    placeholder: string
+    /**
+    * 只读属性
+    * @default false
+    */
+    readOnly: boolean
+    /**
+    * 禁用属性
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 高度是否可拉伸
+    * @default false
+    */
+    autoSize: boolean
+    /**
+    * 输入内容时触发
+    * @default -
+    */
+    onChange: (value: string) => void
+    /**
+    * 失焦时触发
+    * @default -
+    */
+    onBlur: (event: Event) => void
+    /**
+    * 聚焦时触发
+    * @default -
+    */
+    onFocus: (event: Event) => void
 }
 export declare const TextArea: FunctionComponent<Partial<TextAreaProps> & Omit<React.HTMLAttributes<HTMLTextAreaElement>, 'onChange' | 'onBlur' | 'onFocus'>>;

package/dist/types/packages/toast/Notification.d.ts

@@ -1,21 +1,16 @@
 import * as React from 'react';
-export interface NotificationProps {
+import { BasicComponent } from '../../utils/typings';
+export interface NotificationProps extends BasicComponent {
     id?: string;
-    style?: React.CSSProperties;
-    icon: React.ReactNode;
-    msg: string | React.ReactNode;
-    bottom: string;
+    icon: 'success' | 'fail' | 'loading' | 'warn' | React.ReactNode;
+    content: string | React.ReactNode;
     duration: number;
-    center: boolean;
-    type: string;
+    position?: 'top' | 'center' | 'bottom';
     title: string;
-    customClass: string;
     size: string | number;
-    textAlignCenter: boolean;
-    bgColor: string;
-    cover: boolean;
-    coverColor: string;
-    closeOnClickOverlay: boolean;
+    closeOnOverlayClick: boolean;
+    contentClassName?: string;
+    contentStyle?: React.CSSProperties;
     onClose: () => void;
 }
 export default class Notification extends React.PureComponent<NotificationProps> {
@@ -26,6 +21,7 @@ export default class Notification extends React.PureComponent<NotificationProps>
     startCloseTimer(): void;
     clearCloseTimer(): void;
     clickCover(): void;
+    renderIcon(): number | boolean | JSX.Element | React.ReactFragment | null | undefined;
     componentDidMount(): void;
     componentWillUnmount(): void;
     render(): JSX.Element;

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

@@ -1,2 +1,3 @@
 import Toast from './toast';
+export type { ToastProps, ToastIconType, ToastPositionType } from './toast';
 export default Toast;

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

@@ -1,32 +1,25 @@
 import * as React from 'react';
-export interface ToastProps {
+import { BasicComponent } from '../../utils/typings';
+export type ToastPositionType = 'top' | 'bottom' | 'center';
+export type ToastIconType = 'success' | 'fail' | 'loading' | 'warn' | React.ReactNode;
+export interface ToastProps extends BasicComponent {
     id?: string;
-    msg: string;
-    style?: React.CSSProperties;
-    duration: number;
-    center: boolean;
-    type: string;
-    title: string;
-    customClass?: string;
-    bottom: string;
-    size: string | number;
-    icon: string | null;
-    iconSize: string;
-    textAlignCenter: boolean;
-    loadingRotate: boolean;
-    bgColor: string;
-    onClose: () => void;
-    cover: boolean;
-    coverColor: string;
-    closeOnClickOverlay: boolean;
+    duration?: number;
+    position?: ToastPositionType;
+    title?: string;
+    closeOnOverlayClick?: boolean;
+    size?: string | number;
+    icon?: ToastIconType;
+    content?: React.ReactNode;
+    onClose?: () => void;
+    contentClassName?: string;
+    contentStyle?: React.CSSProperties;
 }
+declare function show(option: ToastProps | string): void;
+declare function config(config: Pick<ToastProps, 'duration' | 'position' | 'closeOnOverlayClick'>): void;
 declare const _default: {
-    text(msg: string | React.ReactNode, option?: {}): void;
-    success(msg: string | React.ReactNode, option?: {}): void;
-    fail(msg: string | React.ReactNode, option?: {}): void;
-    loading(msg: string | React.ReactNode, option?: {}): void;
-    warn(msg: string | React.ReactNode, option?: {}): void;
-    customIcon(msg: string | React.ReactNode, option?: {}): void;
-    hide(): void;
+    show: typeof show;
+    config: typeof config;
+    clear(): void;
 };
 export default _default;

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

@@ -1,18 +1,60 @@
 import React, { FunctionComponent } from 'react';
-export interface TrendArrowProps {
-    rate: number;
-    digits: number;
-    showSign: boolean;
-    showZero: boolean;
-    arrowLeft: boolean;
-    syncTextColor: boolean;
-    textColor: string;
-    riseColor: string;
-    dropColor: string;
-    iconSize: string;
-    upIcon: React.ReactNode;
-    downIcon: React.ReactNode;
-    className: string;
-    style: React.CSSProperties;
+import { BasicComponent } from '../../utils/typings';
+export interface TrendArrowProps extends BasicComponent {
+    /**
+    * 数值，大于0时箭头向上，小于0时箭头向下
+    * @default -
+    */
+    value: number
+    /**
+    * 小数位精度
+    * @default 2
+    */
+    digits: number
+    /**
+    * 是否显示加减号
+    * @default false
+    */
+    symbol: boolean
+    /**
+    * 是否显示 0
+    * @default false
+    */
+    zero: boolean
+    /**
+    * 是否在数字左侧显示箭头
+    * @default false
+    */
+    arrowLeft: boolean
+    /**
+    * 文字颜色是否与箭头同步
+    * @default true
+    */
+    syncColor: boolean
+    /**
+    * 文字颜色
+    * @default #333333
+    */
+    color: string
+    /**
+    * 向上箭头颜色
+    * @default #fa2c19
+    */
+    riseColor: string
+    /**
+    * 向下箭头颜色
+    * @default #64b578
+    */
+    dropColor: string
+    /**
+    * 自定义向上箭头icon
+    * @default <TriangleUp/>
+    */
+    riseIcon: React.ReactNode
+    /**
+    * 自定义向下箭头icon
+    * @default <TriangleDown/>
+    */
+    downIcon: React.ReactNode
 }
 export declare const TrendArrow: FunctionComponent<Partial<TrendArrowProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -6,60 +6,204 @@ export type FileType<T> = {
 };
 export type FileItemStatus = 'ready' | 'uploading' | 'success' | 'error' | 'removed';
 export interface UploaderProps extends BasicComponent {
-    url: string;
-    maxCount: string | number;
-    maxFileSize: number;
-    defaultValue?: FileType<React.ReactNode>[];
-    value?: FileType<string>[];
-    previewType: 'picture' | 'list';
-    imageFit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down';
-    uploadIcon?: React.ReactNode;
-    uploadLabel?: React.ReactNode;
-    name: string;
-    accept: string;
-    disabled: boolean;
-    autoUpload: boolean;
-    multiple: boolean;
-    timeout: number;
-    data: any;
-    method: string;
-    xhrState: number | string;
-    headers: any;
-    withCredentials: boolean;
-    clearInput: boolean;
-    preview: boolean;
-    deletable: boolean;
-    capture: boolean;
+    /**
+    * 上传服务器的接口地址
+    * @default -
+    */
+    url: string
+    /**
+    * 文件上传数量限制
+    * @default 1
+    */
+    maxCount: string | number
+    /**
+    * 可以设定最大上传文件的大小（字节）
+    * @default Number.MAX_VALUE
+    */
+    maxFileSize: number
+    /**
+    * 默认已经上传的文件列表
+    * @default []
+    */
+    defaultValue?: FileType<React.ReactNode>[]
+    /**
+    * 已经上传的文件列表
+    * @default []
+    */
+    value?: FileType<string>[]
+    /**
+    * 上传列表的内建样式，支持两种基本样式 picture、list
+    * @default 'picture'
+    */
+    previewType: 'picture' | 'list'
+    /**
+    * 图片填充模式
+    * @default 'cover'
+    */
+    imageFit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'
+    /**
+    * 上传区域[图标名称](#/zh-CN/icon)
+    * @default -
+    */
+    uploadIcon?: React.ReactNode
+    /**
+    * 上传区域图片下方文字
+    * @default -
+    */
+    uploadLabel?: React.ReactNode
+    /**
+    * input 标签 name 的名称，发到后台的文件参数名
+    * @default 'file'
+    */
+    name: string
+    /**
+    * 允许上传的文件类型，[详细说明](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B)
+    * @default *
+    */
+    accept: string
+    /**
+    * 是否禁用文件上传
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 是否在选取文件后立即进行上传，false 时需要手动执行 ref submit 方法进行上传
+    * @default true
+    */
+    autoUpload: boolean
+    /**
+    * 是否支持文件多选
+    * @default false
+    */
+    multiple: boolean
+    /**
+    * 超时时间，单位为毫秒
+    * @default 1000 * 30
+    */
+    timeout: number
+    /**
+    * 附加上传的信息 formData
+    * @default {}
+    */
+    data: any
+    /**
+    * 上传请求的 http method
+    * @default 'post'
+    */
+    method: string
+    /**
+    * 接口响应的成功状态（status）值
+    * @default 200
+    */
+    xhrState: number | string
+    /**
+    * 设置上传的请求头部
+    * @default {}
+    */
+    headers: any
+    /**
+    * 支持发送 cookie 凭证信息
+    * @default false
+    */
+    withCredentials: boolean
+    /**
+    * 是否需要清空input内容，设为true支持重复选择上传同一个文件
+    * @default true
+    */
+    clearInput: boolean
+    /**
+    * 是否上传成功后展示预览图
+    * @default true
+    */
+    preview: boolean
+    /**
+    * 是否展示删除按钮
+    * @default true
+    */
+    deletable: boolean
+    /**
+    * 图片[选取模式](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#htmlattrdefcapture)，直接调起摄像头
+    * @default false
+    */
+    capture: boolean
     className: string;
-    previewUrl?: string;
+    /**
+    * 当上传非图片('image')格式的默认图片地址
+    * @default ''
+    */
+    previewUrl?: string
     style: React.CSSProperties;
-    onStart?: (option: UploadOptions) => void;
-    onDelete?: (file: FileItem, fileList: FileItem[]) => void;
+    /**
+    * 文件上传开始
+    * @default 
+    */
+    onStart?: (option: UploadOptions) => void
+    /**
+    * 文件删除之前的状态
+    * @default 
+    */
+    onDelete?: (file: FileItem, fileList: FileItem[]) => void
+    /**
+    * 上传成功
+    * @default 
+    */
     onSuccess?: (param: {
         responseText: XMLHttpRequest['responseText'];
         option: UploadOptions;
         fileList: FileItem[];
-    }) => void;
+    }) => void
+    /**
+    * 文件上传的进度
+    * @default 
+    */
     onProgress?: (param: {
         e: ProgressEvent<XMLHttpRequestEventTarget>;
         option: UploadOptions;
         percentage: string | number;
-    }) => void;
+    }) => void
+    /**
+    * 上传失败
+    * @default 
+    */
     onFailure?: (param: {
         responseText: XMLHttpRequest['responseText'];
         option: UploadOptions;
         fileList: FileItem[];
-    }) => void;
+    }) => void
     onUpdate?: (fileList: FileItem[]) => void;
-    onOversize?: (file: File[]) => void;
+    /**
+    * 文件大小超过限制时触发
+    * @default 
+    */
+    onOversize?: (file: File[]) => void
+    /**
+    * 上传文件改变时的状态
+    * @default 
+    */
     onChange?: (param: {
         fileList: FileItem[];
         event: React.ChangeEvent<HTMLInputElement>;
-    }) => void;
-    beforeUpload?: (file: File[]) => Promise<File[] | boolean>;
-    beforeXhrUpload?: (xhr: XMLHttpRequest, options: any) => void;
-    beforeDelete?: (file: FileItem, files: FileItem[]) => boolean;
-    onFileItemClick?: (file: FileItem) => void;
+    }) => void
+    /**
+    * 上传前的函数需要返回一个Promise对象
+    * @default - 
+    */
+    beforeUpload?: (file: File[]) => Promise<File[] | boolean>
+    /**
+    * 执行 XHR 上传时，自定义方式
+    * @default -
+    */
+    beforeXhrUpload?: (xhr: XMLHttpRequest, options: any) => void
+    /**
+    * 除文件时的回调，返回值为 false 时不移除。支持返回一个 Promise 对象，Promise 对象 resolve(false) 或 reject 时不移除
+    * @default -
+    */
+    beforeDelete?: (file: FileItem, files: FileItem[]) => boolean
+    /**
+    * 文件上传成功后点击触发
+    * @default 
+    */
+    onFileItemClick?: (file: FileItem) => void
 }
 export declare class FileItem {
     status: FileItemStatus;

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

@@ -1,2 +1,3 @@
 import { Video } from './video';
+export type { VideoProps } from './video';
 export default Video;

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

@@ -1,9 +1,18 @@
 import React, { FunctionComponent } from 'react';
-export interface VideoProps {
+import { BasicComponent } from '../../utils/typings';
+export interface VideoProps extends BasicComponent {
+    /**
+    * 视频地址和类型设置
+    * @default {type: {}, src: ''}
+    */
     source: {
         type: string;
         src: string;
-    };
+    }
+    /**
+    * 控制视频播放属性
+    * @default -
+    */
     options: {
         controls?: boolean;
         muted?: boolean;
@@ -11,14 +20,21 @@ export interface VideoProps {
         poster?: string;
         playsinline?: boolean;
         loop?: boolean;
-    };
-    className: string;
-    style: React.CSSProperties;
-    play: (e: HTMLVideoElement) => void;
-    pause: (e: HTMLVideoElement) => void;
-    playend: (e: HTMLVideoElement) => void;
-    onPlay: (e: HTMLVideoElement) => void;
-    onPause: (e: HTMLVideoElement) => void;
-    onPlayEnd: (e: HTMLVideoElement) => void;
+    }
+    /**
+    * 播放
+    * @default -
+    */
+    onPlay: (element: HTMLVideoElement) => void
+    /**
+    * 暂停
+    * @default -
+    */
+    onPause: (element: HTMLVideoElement) => void
+    /**
+    * 播放完成回调
+    * @default -
+    */
+    onPlayEnd: (element: HTMLVideoElement) => void
 }
 export declare const Video: FunctionComponent<Partial<VideoProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onPause' | 'onPlay'>>;

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

@@ -1,2 +1,3 @@
 import { VirtualList } from './virtuallist';
+export type { VirtualListProps } from './virtuallist';
 export default VirtualList;

package/dist/types/packages/virtuallist/type.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 export type Data = any;
 export interface VirtualListState {
     startOffset: number;
@@ -15,20 +14,3 @@ export interface PositionType {
     left?: number;
     right: number;
 }
-export interface BasicVirtualListProps {
-    className?: string;
-    style?: React.CSSProperties;
-    sourceData: Array<Data>;
-    containerSize?: number;
-    ItemRender?: React.FC<any>;
-    itemSize?: number;
-    itemEqualSize?: boolean;
-    horizontal?: boolean;
-    overscan?: number;
-    handleScroll?: (...args: any[]) => any;
-    onScroll?: (...args: any[]) => any;
-    key?: string;
-    locale?: {
-        [key in string]: string;
-    };
-}