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

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/virtuallist.d.ts

@@ -2,14 +2,50 @@ import React, { FunctionComponent } from 'react';
 import type { Data } from './type';
 import { BasicComponent } from '../../utils/typings';
 export interface VirtualListProps extends BasicComponent {
-    list: Array<Data>;
-    containerHeight: number;
-    ItemRender: React.FC<any>;
-    itemHeight: number;
-    itemEqual: boolean;
-    direction: 'vertical' | 'horizontal';
-    overscan: number;
-    onScroll: () => void;
-    key: string;
+    /**
+    * 获取数据
+    * @default -
+    */
+    list: Array<Data>
+    /**
+    * 容器高度
+    * @default 获取元素的 offsetWidth 或 offsetHeight，需要 css 给出
+    */
+    containerHeight: number
+    /**
+    * virtual 列表父节点渲染的函数
+    * @default -
+    */
+    ItemRender: React.FC<any>
+    /**
+    * item 高度，如果不定高，则为首屏单个最大 height
+    * @default 66
+    */
+    itemHeight: number
+    /**
+    * item 高度是否一致
+    * @default true
+    */
+    itemEqual: boolean
+    /**
+    * vertical、horizontal
+    * @default vertical
+    */
+    direction: 'vertical' | 'horizontal'
+    /**
+    * 除了视窗里面默认的元素, 还需要额外渲染的 item 个数
+    * @default 2
+    */
+    overscan: number
+    /**
+    * 滑动到底(右)的事件，可以实现无限滚动
+    * @default -
+    */
+    onScroll: () => void
+    /**
+    * 用于指定 list 数据每一项的唯一 key 的字段名，默认取下标
+    * @default -
+    */
+    key: string
 }
 export declare const VirtualList: FunctionComponent<Partial<VirtualListProps>>;

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

@@ -1,2 +1,3 @@
 import { WaterMark } from './watermark';
+export type { WaterMarkProps } from './watermark';
 export default WaterMark;

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

@@ -1,22 +1,77 @@
 import React, { FunctionComponent } from 'react';
-export interface WaterMarkProps {
-    content: string;
-    fullPage: boolean;
-    zIndex: number;
-    className: string;
-    gapX: number;
-    gapY: number;
-    width: number;
-    height: number;
-    image: string;
-    imageWidth: number;
-    imageHeight: number;
-    rotate: number;
-    fontColor: string;
+import { BasicComponent } from '../../utils/typings';
+export interface WaterMarkProps extends BasicComponent {
+    /**
+    * 水印文字内容
+    * @default -
+    */
+    content: string
+    /**
+    * 是否覆盖整个页面
+    * @default true
+    */
+    fullPage: boolean
+    /**
+    * 追加的水印元素的 z-index
+    * @default 2000
+    */
+    zIndex: number
+    /**
+    * 水印之间的水平间距
+    * @default 24
+    */
+    gapX: number
+    /**
+    * 水印之间的垂直间距
+    * @default 48
+    */
+    gapY: number
+    /**
+    * 水印的宽度
+    * @default 120
+    */
+    width: number
+    /**
+    * 水印的高度
+    * @default 64
+    */
+    height: number
+    /**
+    * 图片源，建议导出 2 倍或 3 倍图，优先使用图片渲染水印
+    * @default -
+    */
+    image: string
+    /**
+    * 图片宽度
+    * @default 120
+    */
+    imageWidth: number
+    /**
+    * 图片高度
+    * @default 64
+    */
+    imageHeight: number
+    /**
+    * 水印绘制时，旋转的角度
+    * @default -22
+    */
+    rotate: number
+    /**
+    * 水印文字颜色
+    * @default rgba(0, 0, 0, .15)
+    */
+    color: string
     fontStyle: string;
-    fontFamily: string;
+    /**
+    * 水印文字字体
+    * @default -
+    */
+    fontFamily: string
     fontWeight: string;
-    fontSize: string | number;
-    style: React.CSSProperties;
+    /**
+    * 文字大小
+    * @default 16
+    */
+    fontSize: string | number
 }
 export declare const WaterMark: FunctionComponent<Partial<WaterMarkProps> & React.HTMLAttributes<HTMLDivElement>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nutui/nutui-react",
-  "version": "2.0.0-alpha.12",
+  "version": "2.0.0-alpha.13",
   "style": "dist/style.css",
   "main": "dist/nutui.react.umd.js",
   "module": "dist/esm/nutui-react.es.js",