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

package/dist/types/packages/countdown/countdown.taro.d.ts

@@ -1,18 +1,71 @@
-import React, { CSSProperties, ReactNode } from 'react';
-export interface CountDownProps {
-    className?: string;
-    style?: CSSProperties;
-    paused: boolean;
-    startTime: number;
-    endTime: number;
-    millisecond: boolean;
-    format: string;
-    autoStart: boolean;
-    time: number;
-    onEnd: () => void;
-    onPaused: (restTime: number) => void;
-    onRestart: (restTime: number) => void;
-    onUpdate: (restTime: any) => void;
+import React, { ReactNode } from 'react';
+import { BasicComponent } from '../../utils/typings';
+export interface CountDownProps extends BasicComponent {
+    /**
+    * 是否暂停
+    * @default false
+    */
+    paused: boolean
+    /**
+    * 开始时间
+    * @default Date.now()
+    */
+    startTime: number
+    /**
+    * 结束时间
+    * @default Date.now()
+    */
+    endTime: number
+    /**
+    * 剩余时间，单位是毫秒
+    * @default 0
+    */
+    remainingTime: number
+    /**
+    * 是否开启毫秒级渲染
+    * @default false
+    */
+    millisecond: boolean
+    /**
+    * 时间格式
+    * @default HH:mm:ss
+    */
+    format: string
+    /**
+    * 是否自动开始倒计时
+    * @default true
+    */
+    autoStart: boolean
+    /**
+    * 倒计时显示时间，单位是毫秒。autoStart 为 false 时生效
+    * @default 0
+    */
+    time: number
+    /**
+    * 销毁实例
+    * @default false
+    */
+    destroy: boolean
+    /**
+    * 倒计时结束时回调函数
+    * @default -
+    */
+    onEnd: () => void
+    /**
+    * 暂停倒计时回调函数
+    * @default -
+    */
+    onPaused: (restTime: number) => void
+    /**
+    * 重新开始倒计时回调函数
+    * @default -
+    */
+    onRestart: (restTime: number) => void
+    /**
+    * 自定义展示内容时，实时更新倒计时数据回调函数
+    * @default -
+    */
+    onUpdate: (restTime: any) => void
     children: ReactNode;
 }
 export declare const CountDown: React.ForwardRefExoticComponent<Partial<CountDownProps> & React.RefAttributes<unknown>>;

package/dist/types/packages/countdown/index.taro.d.ts

@@ -1,2 +1,3 @@
 import { CountDown } from './countdown.taro';
+export type { CountDownProps } from './countdown.taro';
 export default CountDown;

package/dist/types/packages/divider/divider.taro.d.ts

@@ -3,7 +3,15 @@ import { BasicComponent } from '../../utils/typings';
 export type ContentPositionType = 'left' | 'center' | 'right';
 export type DirectionType = 'horizontal' | 'vertical';
 export interface DividerProps extends BasicComponent {
-    contentPosition: ContentPositionType;
-    direction?: DirectionType;
+    /**
+    * 内容位置，可选值为 left right center
+    * @default center
+    */
+    contentPosition: ContentPositionType
+    /**
+    * 水平还是垂直类型,可选值为 horizontal vertical
+    * @default horizontal
+    */
+    direction?: DirectionType
 }
 export declare const Divider: FunctionComponent<Partial<DividerProps> & React.HTMLAttributes<HTMLDivElement>>;

package/dist/types/packages/drag/drag.taro.d.ts

@@ -1,13 +1,25 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface DragProps extends BasicComponent {
-    attract: boolean;
-    direction: 'x' | 'y' | 'lock' | undefined;
+    /**
+    * 是否开启自动吸边
+    * @default false
+    */
+    attract: boolean
+    /**
+    * 拖拽元素的拖拽方向限制，x、y、all三选一
+    * @default all
+    */
+    direction: 'x' | 'y' | 'lock' | undefined
+    /**
+    * 拖拽元素的拖拽边界
+    * @default {top: 0, left: 0, right: 0, bottom: 0}
+    */
     boundary: {
         top: number;
         left: number;
         right: number;
         bottom: number;
-    };
+    }
 }
 export declare const Drag: FunctionComponent<Partial<DragProps> & React.HTMLAttributes<HTMLDivElement>>;

package/dist/types/packages/elevator/elevator.taro.d.ts

@@ -2,16 +2,52 @@ import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export declare const elevatorContext: React.Context<ElevatorData>;
 export interface ElevatorProps extends BasicComponent {
-    height: number | string;
-    floorKey: string;
-    list: any[];
-    sticky: boolean;
-    spaceHeight: number;
-    titleHeight: number;
-    showKeys: boolean;
+    /**
+    * 电梯区域的高度
+    * @default 200px
+    */
+    height: number | string
+    /**
+    * 索引 key 值
+    * @default title
+    */
+    floorKey: string
+    /**
+    * 索引列表
+    * @default [{id: 0, name: ''}]
+    */
+    list: any[]
+    /**
+    * 索引是否吸顶
+    * @default false
+    */
+    sticky: boolean
+    /**
+    * 右侧锚点的上下间距
+    * @default 23
+    */
+    spaceHeight: number
+    /**
+    * 左侧索引的高度
+    * @default 35
+    */
+    titleHeight: number
+    /**
+    * 展示右侧导航
+    * @default true
+    */
+    showKeys: boolean
     children: React.ReactNode;
-    onClickItem: (key: string, item: ElevatorData) => void;
-    onClickIndex: (key: string) => void;
+    /**
+    * 点击内容
+    * @default false
+    */
+    onClickItem: (key: string, item: ElevatorData) => void
+    /**
+    * 点击索引
+    * @default false
+    */
+    onClickIndex: (key: string) => void
 }
 interface ElevatorData {
     name: string;

package/dist/types/packages/ellipsis/ellipsis.taro.d.ts

@@ -2,14 +2,51 @@ import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export type EllipsisDirection = 'start' | 'end' | 'middle';
 export interface EllipsisProps extends BasicComponent {
-    content: string;
-    direction: EllipsisDirection;
-    rows: number | string;
-    expandText: string;
-    collapseText: string;
-    symbol: string;
-    lineHeight: number | string;
-    onClick: () => void;
-    onChange: (type: string) => void;
+    /**
+    * 文本内容
+    * @default -
+    */
+    content: string
+    /**
+    * 省略位置
+    * @default end
+    */
+    direction: EllipsisDirection
+    /**
+    * 展示几行
+    * @default 1
+    */
+    rows: number | string
+    /**
+    * 展开操作的文案
+    * @default -
+    */
+    expandText: string
+    /**
+    * 收起操作的文案
+    * @default -
+    */
+    collapseText: string
+    /**
+    * 省略的符号
+    * @default ...
+    */
+    symbol: string
+    /**
+    * 容器的行高
+    * @default 20
+    */
+    lineHeight: number | string
+    width: number | string;
+    /**
+    * 文本点击是触发
+    * @default -
+    */
+    onClick: () => void
+    /**
+    * 点击展开收起时触发
+    * @default -
+    */
+    onChange: (type: string) => void
 }
 export declare const Ellipsis: FunctionComponent<Partial<EllipsisProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onClick' | 'onChange'>>;

package/dist/types/packages/empty/empty.taro.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.taro.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.taro.d.ts

@@ -2,15 +2,43 @@ import React, { CSSProperties, FunctionComponent } from 'react';
 import { GridItem, GridItemProps } from '../griditem/griditem.taro';
 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.taro.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/imagepreview/imagepreview.taro.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: boolean;
-    value?: number;
-    defaultValue: number;
-    closeOnContentClick: boolean;
-    indicator: boolean;
-    indicatorColor: string;
+    }>
+    /**
+    * 是否展示预览图片
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 自动轮播时长，0表示不会自动轮播
+    * @default 3000
+    */
+    autoPlay: boolean
+    /**
+    * 页码，受控
+    * @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.taro.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.taro.d.ts

@@ -5,25 +5,105 @@ export type InputAlignType = 'left' | 'center' | 'right';
 export type InputFormatTrigger = 'onChange' | 'onBlur';
 export type ConfirmTextType = 'send' | 'search' | 'next' | 'go' | 'done';
 export interface InputProps extends BasicComponent {
-    type: keyof TaroInputProps.Type | HTMLInputTypeAttribute;
-    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?: (e: ITouchEvent) => void;
+    /**
+    * 输入框类型，支持原生 input 标签的所有 type 属性，另外还支持 number digit
+    * @default text
+    */
+    type: keyof TaroInputProps.Type | HTMLInputTypeAttribute
+    /**
+    * 组件名字，用于表单提交获取数据
+    * @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?: (e: ITouchEvent) => void
 }
 export declare const Input: React.ForwardRefExoticComponent<Partial<InputProps> & Partial<Omit<TaroInputProps, "type" | "ref" | "onFocus" | "onBlur">> & React.RefAttributes<unknown>>;