@nutui/nutui-react 2.0.0-alpha.9 → 2.0.0-beta.1

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

@@ -0,0 +1,27 @@
+export declare class UploadOptions {
+    url: string;
+    name: string;
+    fileType?: string | undefined;
+    formData?: FormData;
+    sourceFile: any;
+    method: string;
+    xhrState: string | number;
+    timeout: number;
+    headers: {};
+    withCredentials: boolean;
+    onStart?: Function;
+    taroFilePath?: string;
+    onProgress?: Function;
+    onSuccess?: Function;
+    onFailure?: Function;
+    beforeXhrUpload?: Function;
+}
+export declare class Upload {
+    options: UploadOptions;
+    constructor(options: UploadOptions);
+    upload(): void;
+}
+export declare class UploaderTaro extends Upload {
+    constructor(options: UploadOptions);
+    uploadTaro(uploadFile: Function, env: string): void;
+}

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

@@ -0,0 +1,221 @@
+import React from 'react';
+import { UploadOptions } from './upload';
+import { BasicComponent } from '../../utils/typings';
+export type FileType<T> = {
+    [key: string]: T;
+};
+export type FileItemStatus = 'ready' | 'uploading' | 'success' | 'error' | 'removed';
+export interface UploaderProps extends BasicComponent {
+    /**
+    * 上传服务器的接口地址
+    * @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'
+    /**
+    * 上传区域<a href="#/zh-CN/icon">图标名称</a>
+    * @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;
+    /**
+    * 当上传非图片('image')格式的默认图片地址
+    * @default -
+    */
+    previewUrl?: string
+    style: React.CSSProperties;
+    /**
+    * 文件上传开始
+    * @default -
+    */
+    onStart?: (option: UploadOptions) => void
+    /**
+    * 文件删除之前的状态
+    * @default -
+    */
+    onDelete?: (file: FileItem, fileList: FileItem[]) => void
+    /**
+    * 上传成功
+    * @default -
+    */
+    onSuccess?: (param: {
+        responseText: XMLHttpRequest['responseText'];
+        option: UploadOptions;
+        fileList: FileItem[];
+    }) => void
+    /**
+    * 文件上传的进度
+    * @default -
+    */
+    onProgress?: (param: {
+        e: ProgressEvent<XMLHttpRequestEventTarget>;
+        option: UploadOptions;
+        percentage: string | number;
+    }) => void
+    /**
+    * 上传失败
+    * @default -
+    */
+    onFailure?: (param: {
+        responseText: XMLHttpRequest['responseText'];
+        option: UploadOptions;
+        fileList: FileItem[];
+    }) => void
+    onUpdate?: (fileList: FileItem[]) => void;
+    /**
+    * 文件大小超过限制时触发
+    * @default -
+    */
+    onOversize?: (file: File[]) => void
+    /**
+    * 上传文件改变时的状态
+    * @default -
+    */
+    onChange?: (param: {
+        fileList: FileItem[];
+        event: React.ChangeEvent<HTMLInputElement>;
+    }) => 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;
+    message: string;
+    uid: string;
+    name?: string;
+    url?: string;
+    type?: string;
+    path?: string;
+    percentage: string | number;
+    formData: FormData;
+}
+export declare const Uploader: React.ForwardRefExoticComponent<Partial<UploaderProps> & {
+    children?: React.ReactNode;
+} & React.RefAttributes<unknown>>;

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

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

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

@@ -0,0 +1,40 @@
+import React, { FunctionComponent } from 'react';
+import { BasicComponent } from '../../utils/typings';
+export interface VideoProps extends BasicComponent {
+    /**
+    * 视频地址和类型设置
+    * @default {type: {}, src: ''}
+    */
+    source: {
+        type: string;
+        src: string;
+    }
+    /**
+    * 控制视频播放属性
+    * @default -
+    */
+    options: {
+        controls?: boolean;
+        muted?: boolean;
+        autoplay?: boolean;
+        poster?: string;
+        playsinline?: boolean;
+        loop?: boolean;
+    }
+    /**
+    * 播放
+    * @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

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

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

@@ -0,0 +1,16 @@
+export type Data = any;
+export interface VirtualListState {
+    startOffset: number;
+    startIndex: number;
+    overStart: number;
+    endIndex: number;
+}
+export interface PositionType {
+    index: number;
+    top?: number;
+    height?: number;
+    bottom: number;
+    width?: number;
+    left?: number;
+    right: number;
+}

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

@@ -0,0 +1,16 @@
+import { PositionType, Data } from './type';
+declare const initPositinoCache: (reaItemSize: number, length?: number) => PositionType[];
+declare const getListTotalSize: (positions: Array<PositionType>, horizontal: true | false) => number;
+declare const binarySearch: (positionsList: Array<PositionType>, value: number | undefined, horizontal: true | false) => number;
+declare const getEndIndex: ({ list, startIndex, visibleCount, itemEqual, positions, offSetSize, overscan, sizeKey, }: {
+    list: Array<Data>;
+    startIndex: number;
+    visibleCount: number;
+    itemEqual?: boolean | undefined;
+    positions: PositionType[];
+    offSetSize: number;
+    overscan: number;
+    sizeKey?: "width" | "height" | undefined;
+}) => number;
+declare const updateItemSize: (positions: PositionType[], items: HTMLCollection, sizeKey: 'width' | 'height') => void;
+export { initPositinoCache, getListTotalSize, binarySearch, getEndIndex, updateItemSize, };

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

@@ -0,0 +1,51 @@
+import React, { FunctionComponent } from 'react';
+import type { Data } from './type';
+import { BasicComponent } from '../../utils/typings';
+export interface VirtualListProps extends BasicComponent {
+    /**
+    * 获取数据
+    * @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

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

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

@@ -0,0 +1,77 @@
+import React, { FunctionComponent } from 'react';
+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;
+    /**
+    * 水印文字字体
+    * @default -
+    */
+    fontFamily: string
+    fontWeight: string;
+    /**
+    * 文字大小
+    * @default 16
+    */
+    fontSize: string | number
+}
+export declare const WaterMark: FunctionComponent<Partial<WaterMarkProps> & React.HTMLAttributes<HTMLDivElement>>;

package/dist/types/utils/bound.d.ts

@@ -0,0 +1 @@
+export declare function bound(position: number, min: number | undefined, max: number | undefined): number;

package/dist/types/utils/can-use-dom.d.ts

@@ -0,0 +1 @@
+export declare const canUseDom: boolean;

package/dist/types/utils/date.d.ts

@@ -0,0 +1,49 @@
+declare const Utils: {
+    /**
+     * 是否为闫年
+     * @return {Boolse} true|false
+     */
+    isLeapYear(y: number): boolean;
+    /**
+     * 返回星期数
+     * @return {String}
+     */
+    getWhatDay(year: number, month: number, day: number): string;
+    /**
+     * 返回星期数
+     * @return {Number}
+     */
+    getMonthPreDay(year: number, month: number): number;
+    /**
+     * 返回月份天数
+     * @return {Number}
+     */
+    getMonthDays(year: string, month: string): number;
+    /**
+     * 补齐数字位数
+     * @return {string}
+     */
+    getNumTwoBit(n: number): string;
+    /**
+     * 日期对象转成字符串
+     * @return {string}
+     */
+    date2Str(date: Date, split?: string): string;
+    /**
+     * 返回日期格式字符串
+     * @param {Number} 0返回今天的日期、1返回明天的日期，2返回后天得日期，依次类推
+     * @return {string} '2014-12-31'
+     */
+    getDay(i: number): string;
+    /**
+     * 时间比较
+     * @return {Boolean}
+     */
+    compareDate(date1: string, date2: string): boolean;
+    /**
+     * 时间是否相等
+     * @return {Boolean}
+     */
+    isEqual(date1: string | undefined, date2: string): boolean;
+};
+export default Utils;

package/dist/types/utils/get-scroll-parent.d.ts

@@ -0,0 +1,3 @@
+type ScrollElement = HTMLElement | Window;
+export declare function getScrollParent(el: Element, root?: ScrollElement | null | undefined): Window | Element | null | undefined;
+export {};

package/dist/types/utils/index.d.ts

@@ -0,0 +1,4 @@
+export declare const isObject: (val: unknown) => val is Record<any, any>;
+export declare const isFunction: (val: unknown) => val is Function;
+export declare const isPromise: <T = any>(val: unknown) => val is Promise<T>;
+export declare const upperCaseFirst: (str: string) => string;

package/dist/types/utils/interceptor.d.ts

@@ -0,0 +1,6 @@
+export type Interceptor = (...args: any[]) => Promise<boolean> | boolean | undefined | void;
+export declare const funcInterceptor: (interceptor: Interceptor | undefined, { args, done, canceled, }: {
+    args?: unknown[] | undefined;
+    done: (val?: any) => void;
+    canceled?: (() => void) | undefined;
+}) => void;

package/dist/types/utils/is-forward-ref-component.d.ts

@@ -0,0 +1 @@
+export declare function isForwardRefComponent(component: any): any;

package/dist/types/utils/px-check.d.ts

@@ -0,0 +1 @@
+export declare const pxCheck: (value: string | number) => string;

package/dist/types/utils/raf.d.ts

@@ -0,0 +1,4 @@
+export declare const inBrowser: boolean;
+export declare function cancelRaf(id: number): void;
+declare const _default: any;
+export default _default;

package/dist/types/utils/render.d.ts

@@ -0,0 +1,9 @@
+import { ReactElement } from 'react';
+import type { Root } from 'react-dom/client';
+declare const MARK = "__nutui_react_root__";
+type ContainerType = (Element | DocumentFragment) & {
+    [MARK]?: Root;
+};
+export declare function render(node: ReactElement, container: ContainerType): void;
+export declare function unmount(container: ContainerType): boolean | Promise<void>;
+export {};

package/dist/types/utils/rubberband.d.ts

@@ -0,0 +1,2 @@
+export declare function rubberband(distance: number, dimension: number, constant: number): number;
+export declare function rubberbandIfOutOfBounds(position: number, min: number, max: number, dimension: number, constant?: number): number;

package/dist/types/utils/sleep.d.ts

@@ -0,0 +1 @@
+export declare const sleep: (time: number) => Promise<unknown>;

package/dist/types/utils/supports-passive.d.ts

@@ -0,0 +1 @@
+export declare let passiveSupported: boolean;

package/dist/types/utils/typings.d.ts

@@ -0,0 +1,10 @@
+import type { CSSProperties, ReactNode } from 'react';
+export interface BasicComponent {
+    className?: string;
+    style?: CSSProperties;
+    children?: ReactNode;
+}
+export declare const ComponentDefaults: {
+    className: string;
+    style: {};
+};

package/dist/types/utils/use-click-away.d.ts

@@ -0,0 +1,3 @@
+type TargetType = Function | HTMLElement | Element;
+export default function useClickAway(onClickAway: () => void, target: TargetType | TargetType[], eventName: string | undefined, useCapture: boolean, isListener?: boolean, outerVar?: boolean): void;
+export {};

package/dist/types/utils/use-client-rect.d.ts

@@ -0,0 +1,18 @@
+/**
+  获取元素的大小及其相对于视口的位置，等价于 Element.getBoundingClientRect。
+  width 宽度	number
+  height 高度	number
+  top	顶部与视图窗口左上角的距离	number
+  left	左侧与视图窗口左上角的距离	number
+  right	右侧与视图窗口左上角的距离	number
+  bottom	底部与视图窗口左上角的距离	number
+ */
+export declare const getRect: (elementRef: Element | Window | undefined) => DOMRect | {
+    top: number;
+    left: number;
+    right: number;
+    bottom: number;
+    width: number;
+    height: number;
+};
+export declare const getRectByTaro: (element: any) => Promise<any>;

package/dist/types/utils/use-force-update.d.ts

@@ -0,0 +1 @@
+export declare function useForceUpdate(): () => void;

package/dist/types/utils/use-props-value.d.ts

@@ -0,0 +1,8 @@
+interface UsePropsValue<T> {
+    value?: T;
+    defaultValue?: T;
+    finalValue?: T;
+    onChange?: (value: T) => void;
+}
+export declare function usePropsValue<T>({ value, defaultValue, finalValue, onChange, }: UsePropsValue<T>): [value: T, onChange: (value: T) => void];
+export {};

package/dist/types/utils/use-refs.d.ts

@@ -0,0 +1 @@
+export default function useRefs(): any[];

package/dist/types/utils/use-touch.d.ts

@@ -0,0 +1,18 @@
+type Direction = '' | 'vertical' | 'horizontal';
+export declare function useTouch(): {
+    move: EventListener;
+    start: EventListener;
+    reset: () => void;
+    startX: number;
+    startY: number;
+    moveX: number;
+    moveY: number;
+    deltaX: number;
+    deltaY: number;
+    offsetX: number;
+    offsetY: number;
+    direction: Direction;
+    isVertical: () => boolean;
+    isHorizontal: () => boolean;
+};
+export {};

package/dist/types/utils/use-watch.d.ts

@@ -0,0 +1,6 @@
+type Callback<T> = (prev: T | undefined) => void;
+type Config = {
+    immediate: boolean;
+};
+declare function useWatch<T>(dep: T, callback: Callback<T>, config?: Config): () => void;
+export default useWatch;

package/dist/types/vite-env.d.ts

@@ -0,0 +1,9 @@
+// eslint-disable-next-line react/no-typos
+import 'react'
+
+declare module 'react' {
+  interface CSSProperties {
+    // Allow any CSS Custom Properties
+    [index: `--${string}`]: any
+  }
+}