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

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

@@ -2,21 +2,85 @@ import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export type RangeValue = number | number[];
 export interface RangeProps extends BasicComponent {
-    value: RangeValue;
-    defaultValue: RangeValue;
-    range: boolean;
-    disabled: boolean;
-    min: number;
-    max: number;
-    step: number;
-    minDescription: ReactNode;
-    maxDescription: ReactNode;
-    button: ReactNode;
-    vertical: boolean;
-    marks: Record<string, unknown>;
-    currentDescription: ((value: RangeValue) => ReactNode) | null;
-    onChange: (value: RangeValue) => void;
-    onStart: () => void;
-    onEnd: (value: RangeValue) => void;
+    /**
+    * 当前进度百分比，受控
+    * @default 0
+    */
+    value: RangeValue
+    /**
+    * 默认进度百分比，非受控
+    * @default 0
+    */
+    defaultValue: RangeValue
+    /**
+    * 是否开启双滑块模式
+    * @default false
+    */
+    range: boolean
+    /**
+    * 是否禁用滑块  boolean
+    * @default 
+    */
+    disabled: boolean
+    /**
+    * 最小值
+    * @default 0
+    */
+    min: number
+    /**
+    * 最大值
+    * @default 100
+    */
+    max: number
+    /**
+    * 步长
+    * @default 1
+    */
+    step: number
+    /**
+    * 最小值描述，传 null 表示隐藏
+    * @default -
+    */
+    minDescription: ReactNode
+    /**
+    * 最大值描述，传 null 表示隐藏
+    * @default -
+    */
+    maxDescription: ReactNode
+    /**
+    * 自定义滑动按钮
+    * @default -
+    */
+    button: ReactNode
+    /**
+    * 是否竖向展示
+    * @default false
+    */
+    vertical: boolean
+    /**
+    * 刻度标示
+    * @default {}
+    */
+    marks: Record<string, unknown>
+    /**
+    * 当前值描述，传 null 表示隐藏
+    * @default null
+    */
+    currentDescription: ((value: RangeValue) => ReactNode) | null
+    /**
+    * 进度实时变化，通常在受控方式中与 value 一起使用
+    * @default -
+    */
+    onChange: (value: RangeValue) => void
+    /**
+    * 开始拖动时触发
+    * @default -
+    */
+    onStart: () => void
+    /**
+    * 结束拖动时触发
+    * @default -
+    */
+    onEnd: (value: RangeValue) => void
 }
 export declare const Range: FunctionComponent<Partial<RangeProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onClick' | 'onChange' | 'defaultValue'>>;

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

@@ -1,37 +1,92 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface SearchBarProps extends BasicComponent {
-    /** 文本值	 */
+    /**
+    * 当前输入的值
+    * @default -
+    */
     value?: number | string;
-    /** 输入框占位提示文字	 */
+    /**
+    * 输入框默认暗纹
+    * @default 请输入
+    */
     placeholder?: string;
-    /** 搜索框形状，可选值为 round	 */
+    /**
+    * 搜索框形状，可选值为 round
+    * @default square
+    */
     shape?: 'square' | 'round';
-    /** 是否禁用输入框	 */
+    /**
+    * 是否禁用输入框
+    * @default false
+    */
     disabled?: boolean;
-    /** 最大输入长度	 */
+    /**
+    * 最大输入长度
+    * @default 9999
+    */
     maxLength?: number;
-    /** 是否启用清除图标，点击清除图标后会清空输入框	 */
+    /**
+    * 是否展示清除按钮
+    * @default true
+    */
     clearable?: boolean;
-    /** 是否将输入框设为只读状态，只读状态下无法输入内容   */
+    /**
+    * 输入框只读
+    * @default false
+    */
     readOnly?: boolean;
-    /**  是否自动聚焦，iOS 系统不支持该属性	 */
+    /**
+    * 是否自动聚焦
+    * @default false
+    */
     autoFocus?: boolean;
-    left: React.ReactNode;
-    right: React.ReactNode;
-    leftIn: React.ReactNode;
-    rightIn: React.ReactNode;
-    /**  确定搜索时触发	 */
+    /**
+    * 搜索框左侧区域
+    * @default -
+    */
+    left: React.ReactNode
+    /**
+    * 搜搜框右侧区域
+    * @default -
+    */
+    right: React.ReactNode
+    /**
+    * 输入框内左侧区域
+    * @default <Search size="12" />
+    */
+    leftIn: React.ReactNode
+    /**
+    * 输入框内右侧区域
+    * @default -
+    */
+    rightIn: React.ReactNode
+    /**
+    * 确定搜索时触发
+    * @default 
+    */
     onSearch?: (val: string) => void;
-    /** 输入框内容变化时触发	 */
+    /**
+    * 输入内容时触发
+    * @default 
+    */
     onChange?: (value: string, event: Event) => void;
-    /** 输入框获得焦点时触发	 */
+    /**
+    * 聚焦时触发
+    * @default 
+    */
     onFocus?: (value: string, event: Event) => void;
-    /** 输入框失去焦点时触发	 */
+    /**
+    * 失焦时触发
+    * @default 
+    */
     onBlur?: (value: string, event: Event) => void;
     /** 点击清除按钮后触发	 */
     onClear?: (event: Event) => void;
-    /** 点击输入区域时触发	 */
+    /**
+    * 点击输入区域时触发
+    * @default 
+    */
     onClickInput?: (event: Event) => void;
 }
 export declare const SearchBar: FunctionComponent<Partial<SearchBarProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'onFocus' | 'onBlur'>>;

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

@@ -1,22 +1,90 @@
 import { FunctionComponent, ReactNode } from 'react';
 import { PopupProps } from '../../packages/popup/popup.taro';
 export interface ShortPasswordProps extends PopupProps {
-    value: string;
-    visible: boolean;
-    plain: boolean;
-    title: ReactNode;
-    description: ReactNode;
-    tips: ReactNode;
-    hideFooter: boolean;
-    length: number;
-    error: ReactNode;
-    autoFocus: boolean;
-    onFocus: () => void;
-    onChange: (value: string) => void;
-    onConfirm: (value: string) => void;
-    onCancel: () => void;
-    onClose: () => void;
-    onTips: () => void;
-    onComplete: (value: string) => void;
+    /**
+    * 密码字符串
+    * @default -
+    */
+    value: string
+    /**
+    * 是否展示短密码框
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 是否展示明文
+    * @default false
+    */
+    plain: boolean
+    /**
+    * 标题
+    * @default 请输入密码
+    */
+    title: ReactNode
+    /**
+    * 密码框描述
+    * @default 您使用了虚拟资产，请进行验证
+    */
+    description: ReactNode
+    /**
+    * 提示语
+    * @default 忘记密码
+    */
+    tips: ReactNode
+    /**
+    * 是否隐藏底部按钮
+    * @default true
+    */
+    hideFooter: boolean
+    /**
+    * 密码长度，取值为4~6
+    * @default 6
+    */
+    length: number
+    /**
+    * 错误信息提示
+    * @default -
+    */
+    error: ReactNode
+    /**
+    * 自动聚焦
+    * @default false
+    */
+    autoFocus: boolean
+    /**
+    * 输入框聚焦
+    * @default -
+    */
+    onFocus: () => void
+    /**
+    * 输入密码时触发事件
+    * @default -
+    */
+    onChange: (value: string) => void
+    /**
+    * 点击确认时触发事件
+    * @default -
+    */
+    onConfirm: (value: string) => void
+    /**
+    * 点击取消时触发事件
+    * @default -
+    */
+    onCancel: () => void
+    /**
+    * 点击关闭图标和遮罩时触发事件
+    * @default -
+    */
+    onClose: () => void
+    /**
+    * 点击忘记密码时触发事件
+    * @default -
+    */
+    onTips: () => void
+    /**
+    * 输入完成的回调
+    * @default -
+    */
+    onComplete: (value: string) => void
 }
 export declare const ShortPassword: FunctionComponent<Partial<ShortPasswordProps>>;

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

@@ -2,13 +2,41 @@ import { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 type avatarShape = 'round' | 'square';
 export interface SkeletonProps extends BasicComponent {
-    animated: boolean;
-    rows: number;
-    title: boolean;
-    avatar: boolean;
-    avatarSize: string;
-    visible: boolean;
-    avatarShape: avatarShape;
+    /**
+    * 是否开启骨架屏动画
+    * @default false
+    */
+    animated: boolean
+    /**
+    * 设置段落行数
+    * @default 1
+    */
+    rows: number
+    /**
+    * 是否显示段落标题
+    * @default true
+    */
+    title: boolean
+    /**
+    * 是否显示头像
+    * @default false
+    */
+    avatar: boolean
+    /**
+    * 头像大小
+    * @default 50px
+    */
+    avatarSize: string
+    /**
+    * 是否显示骨架屏(true不显示骨架屏，false显示骨架屏)
+    * @default true
+    */
+    visible: boolean
+    /**
+    * 头像形状：正方形/圆形
+    * @default round
+    */
+    avatarShape: avatarShape
 }
 export declare const Skeleton: FunctionComponent<Partial<SkeletonProps>>;
 export {};

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

@@ -1,9 +1,25 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface StepProps extends BasicComponent {
-    title: ReactNode;
-    description: ReactNode;
-    value: number;
-    icon: ReactNode;
+    /**
+    * 流程步骤的标题
+    * @default ''
+    */
+    title: ReactNode
+    /**
+    * 流程步骤的描述性文字
+    * @default ''
+    */
+    description: ReactNode
+    /**
+    * 流程步骤的索引
+    * @default 0
+    */
+    value: number
+    /**
+    * 图标(来自Icon组件的name属性)
+    * @default ''
+    */
+    icon: ReactNode
 }
 export declare const Step: FunctionComponent<Partial<StepProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'title'>>;

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

@@ -1,9 +1,21 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface StepsProps extends BasicComponent {
-    value: number;
-    direction: string;
-    dot: boolean;
+    /**
+    * 当前所在的步骤
+    * @default 0
+    */
+    value: number
+    /**
+    * 显示方向，horizontal,vertical
+    * @default horizontal
+    */
+    direction: string
+    /**
+    * 点状步骤条
+    * @default false
+    */
+    dot: boolean
     onStepClick: (index: number) => void;
 }
 export declare const Steps: FunctionComponent<Partial<StepsProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -1,10 +1,30 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface StickyProps extends BasicComponent {
-    container: React.RefObject<HTMLElement>;
-    position: 'top' | 'bottom';
-    threshold: number;
-    zIndex: number;
-    onChange: (val: boolean) => void;
+    /**
+    * 容器的 ref
+    * @default -
+    */
+    container: React.RefObject<HTMLElement>
+    /**
+    * 吸附位置（top、bottom）
+    * @default top
+    */
+    position: 'top' | 'bottom'
+    /**
+    * 距离，当 position 为 top 时，设置的是 top
+    * @default 0
+    */
+    threshold: number
+    /**
+    * 吸附时的层级
+    * @default 2000
+    */
+    zIndex: number
+    /**
+    * 吸附状态改变时触发
+    * @default -
+    */
+    onChange: (val: boolean) => void
 }
 export declare const Sticky: FunctionComponent<Partial<StickyProps>>;

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

@@ -9,31 +9,67 @@ export interface SwipeProps {
     className: string;
     /** 自定义样式 */
     style: React.CSSProperties;
-    /** 标识符，可以在事件参数中获取到 */
+    /**
+    * 标识符，可以在事件参数中获取到
+    * @default -
+    */
     name?: string | number;
-    /** 左侧滑动区域的内容 */
+    /**
+    * 左侧滑动区域的内容
+    * @default -
+    */
     leftAction?: React.ReactNode;
-    /** 右侧滑动区域的内容 */
+    /**
+    * 右侧滑动区域的内容
+    * @default -
+    */
     rightAction?: React.ReactNode;
-    /** 关闭前的回调函数，返回 false 可阻止关闭，支持返回 Promise */
+    /**
+    * 关闭前的回调函数，返回滑动区域所在方向 position
+    * @default -
+    */
     beforeClose?: (position: string) => void;
-    /** 是否禁用 */
+    /**
+    * 是否禁用滑动
+    * @default false
+    */
     disabled?: boolean;
-    /** 打开时触发 */
+    /**
+    * 打开单元格侧边栏
+    * @default -
+    */
     onOpen?: ({ name, position, }: {
         name: string | number;
         position: SwipeSide;
     }) => void;
-    /** 关闭时触发 */
+    /**
+    * 收起单元格侧边栏
+    * @default -
+    */
     onClose?: ({ name, position, }: {
         name: string | number;
         position: SwipeSide;
     }) => void;
-    /** 点击时触发 */
+    /**
+    * 点击左侧或者右侧时触发
+    * @default -
+    */
     onActionClick?: (event: Event, position: SwipeSide) => void;
-    onTouchStart?: (event: Event) => void;
-    onTouchEnd?: (event: Event) => void;
-    onTouchMove?: (event: Event) => void;
+    /**
+    * onTouchStart
+    * @default -
+    */
+    onTouchStart?: (event: Event) => void
+    /**
+    * onTouchEnd
+    * @default -
+    */
+    onTouchEnd?: (event: Event) => void
+    /**
+    * onTouchMove
+    * @default -
+    */
+    onTouchMove?: (event: Event) => void
     children?: React.ReactNode;
 }
 export declare const Swipe: React.ForwardRefExoticComponent<Partial<SwipeProps> & Omit<React.HTMLAttributes<HTMLDivElement>, "onTouchStart" | "onTouchMove" | "onTouchEnd"> & React.RefAttributes<SwipeInstance>>;

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

@@ -1,12 +1,40 @@
 import React, { ReactNode } from 'react';
 import { SwiperProps as TaroSwiperProps } from '@tarojs/components';
 export interface SwiperProps extends Omit<TaroSwiperProps, 'ref'> {
-    width: number;
-    height: number | string;
-    direction: 'horizontal' | 'vertical';
-    indicator: ReactNode;
-    autoPlay: boolean;
-    loop: boolean;
-    defaultValue: number;
+    /**
+    * 轮播卡片的宽度
+    * @default -
+    */
+    width: number
+    /**
+    * 轮播卡片的高度
+    * @default -
+    */
+    height: number | string
+    /**
+    * 轮播方向,可选值horizontal,vertical
+    * @default horizontal
+    */
+    direction: 'horizontal' | 'vertical'
+    /**
+    * 分页指示器是否展示
+    * @default false
+    */
+    indicator: ReactNode
+    /**
+    * 自动轮播时长，0表示不会自动轮播
+    * @default false
+    */
+    autoPlay: boolean
+    /**
+    * 是否循环轮播
+    * @default true
+    */
+    loop: boolean
+    /**
+    * 初始化索引值
+    * @default 0
+    */
+    defaultValue: number
 }
 export declare const Swiper: React.ForwardRefExoticComponent<Partial<SwiperProps> & React.RefAttributes<unknown>>;

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

@@ -1,11 +1,35 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface SwitchProps extends BasicComponent {
-    checked: boolean;
-    defaultChecked: boolean;
-    disabled: boolean;
-    activeText: string;
-    inactiveText: string;
-    onChange: (val: boolean, event: React.MouseEvent) => void;
+    /**
+    * 开关状态，受控
+    * @default false
+    */
+    checked: boolean
+    /**
+    * 开关状态，非受控
+    * @default false
+    */
+    defaultChecked: boolean
+    /**
+    * 禁用状态
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 打开时文字描述
+    * @default -
+    */
+    activeText: string
+    /**
+    * 关闭时文字描述
+    * @default -
+    */
+    inactiveText: string
+    /**
+    * 切换开关时触发
+    * @default -
+    */
+    onChange: (val: boolean, event: React.MouseEvent) => void
 }
 export declare const Switch: FunctionComponent<Partial<SwitchProps>>;

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

@@ -2,13 +2,41 @@ import { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 import TabbarItem from '../tabbaritem/index.taro';
 export interface TabbarProps extends BasicComponent {
-    defaultValue: number;
-    value?: number;
-    fixed: boolean;
-    inactiveColor: string;
-    activeColor: string;
-    safeArea: boolean;
-    onSwitch: (value: number) => void;
+    /**
+    * 默认选中的标签的索引值
+    * @default 0
+    */
+    defaultValue: number
+    /**
+    * 选中的标签的索引值
+    * @default -
+    */
+    value?: number
+    /**
+    * 是否固定在页面底部，为 true 时默认开启 safeArea
+    * @default false
+    */
+    fixed: boolean
+    /**
+    * icon未激活的颜色
+    * @default #7d7e80
+    */
+    inactiveColor: string
+    /**
+    * icon激活的颜色
+    * @default #1989fa
+    */
+    activeColor: string
+    /**
+    * 是否开启iphone系列全面屏底部安全区适配
+    * @default false
+    */
+    safeArea: boolean
+    /**
+    * 切换页签时触发事件
+    * @default -
+    */
+    onSwitch: (value: number) => void
 }
 export declare const Tabbar: FunctionComponent<Partial<TabbarProps>> & {
     Item: typeof TabbarItem;