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

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

@@ -1,64 +1,95 @@
 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';
-    /** 自定义class名	 */
-    className?: string;
-    /** 是否禁用输入框	 */
+    /**
+    * 是否禁用输入框
+    * @default false
+    */
     disabled?: boolean;
-    /** 最大输入长度	 */
+    /**
+    * 最大输入长度
+    * @default 9999
+    */
     maxLength?: number;
-    /** 是否启用清除图标，点击清除图标后会清空输入框	 */
+    /**
+    * 是否展示清除按钮
+    * @default true
+    */
     clearable?: boolean;
-    clearSize?: string | number;
-    /** 搜索框外部背景色	 */
-    background?: string;
-    /** 搜索框背景色	 */
-    inputBackground?: string;
-    /** 输入框内容对齐方式	 */
-    align?: string;
-    /** 是否将输入框设为只读状态，只读状态下无法输入内容   */
+    /**
+    * 输入框只读
+    * @default false
+    */
     readOnly?: boolean;
-    /**  是否自动聚焦，iOS 系统不支持该属性	 */
+    /**
+    * 是否自动聚焦
+    * @default false
+    */
     autoFocus?: boolean;
-    /** 搜索框左侧文本	 */
-    label?: React.ReactNode;
-    /** 输入框内 左icon   */
-    leftinIcon?: React.ReactNode;
-    /** 输入框内 右icon  */
-    rightinIcon?: React.ReactNode;
-    /** 输入框外 左icon  */
-    leftoutIcon?: React.ReactNode;
-    /** 输入框外 右icon  */
-    rightoutIcon?: React.ReactNode;
-    /** 取消按钮文字	 */
-    actionText?: 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;
-    /** 点击清除按钮后触发	 */
+    /**
+    * 点击清空时触发
+    * @default 
+    */
     onClear?: (event: Event) => void;
-    /** 点击取消按钮后触发	 */
-    onCancel?: () => void;
-    /** 点击输入区域时触发	 */
+    /**
+    * 点击输入区域时触发
+    * @default 
+    */
     onClickInput?: (event: Event) => void;
-    /** 点击输入框内左侧图标时触发	 */
-    onClickLeftinIcon?: (value: string, event: Event) => void;
-    /** 点击输入框外左侧图标时触发	 */
-    onClickLeftoutIcon?: (value: string, event: Event) => void;
-    /** 点击输入框内右侧图标时触发	 */
-    onClickRightinIcon?: (value: string, event: Event) => void;
-    /** 点击输入框外右侧图标时触发	 */
-    onClickRightoutIcon?: (value: string, event: Event) => void;
 }
 export declare const SearchBar: FunctionComponent<Partial<SearchBarProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'onFocus' | 'onBlur'>>;

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

@@ -1,2 +1,3 @@
 import { ShortPassword } from './shortpassword';
+export type { ShortPasswordProps } from './shortpassword';
 export default ShortPassword;

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

@@ -1,25 +1,90 @@
-import React, { CSSProperties, FunctionComponent } from 'react';
-import { BasicComponent } from '../../utils/typings';
-export interface ShortPasswordProps extends BasicComponent {
-    title: string;
-    description: string;
-    tips: string;
-    tipsIcon: React.ReactNode;
-    iconSize: string | number;
-    visible: boolean;
-    modelValue: string | number;
-    errorMsg: string;
-    noButton: boolean;
-    closeOnClickOverlay: boolean;
-    length: string | number;
-    className: string;
-    style?: CSSProperties;
-    autoFocus?: boolean;
-    onChange: (value: string | number) => void;
-    onOk: (value: string | number) => void;
-    onCancel: () => void;
-    onClose: () => void;
-    onTips: () => void;
-    onComplete: (value: string | number) => void;
+import { FunctionComponent, ReactNode } from 'react';
+import { PopupProps } from '../popup/popup';
+export interface ShortPasswordProps extends PopupProps {
+    /**
+    * 密码字符串
+    * @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> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange'>>;
+export declare const ShortPassword: FunctionComponent<Partial<ShortPasswordProps>>;

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

@@ -1,11 +1,31 @@
 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;
+    /**
+    * 容器的 ref
+    * @default -
+    */
+    container: React.RefObject<HTMLElement>
+    /**
+    * 吸附位置（top、bottom）
+    * @default top
+    */
+    position: 'top' | 'bottom'
+    /**
+    * 距离，当 position 为 top 时，设置的是 top
+    * @default 0
+    */
+    threshold: number
+    /**
+    * 吸附时的层级
+    * @default 2000
+    */
+    zIndex: number
     children: React.ReactNode;
-    onChange: (val: boolean) => void;
+    /**
+    * 吸附状态改变时触发
+    * @default -
+    */
+    onChange: (val: boolean) => void
 }
 export declare const Sticky: FunctionComponent<Partial<StickyProps>>;

package/dist/types/packages/swipe/swipe.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>, "onTouchEnd" | "onTouchMove" | "onTouchStart"> & React.RefAttributes<SwipeInstance>>;

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

@@ -6,18 +6,70 @@ export type SwiperRef = {
     prev: () => void;
 };
 export interface SwiperProps extends BasicComponent {
-    width: number | string;
-    height: number | string;
-    duration: number | string;
-    defaultValue: number | string;
-    autoPlay: number | string;
-    direction: 'horizontal' | 'vertical';
-    indicator: ReactNode;
-    loop: boolean;
-    touchable: boolean;
-    preventDefault: boolean;
-    stopPropagation: boolean;
-    center: boolean;
-    onChange?: (current: number) => void;
+    /**
+    * 轮播卡片的宽度
+    * @default window.innerWidth
+    */
+    width: number | string
+    /**
+    * 轮播卡片的高度
+    * @default 0
+    */
+    height: number | string
+    /**
+    * 动画时长（单位是ms）
+    * @default 500
+    */
+    duration: number | string
+    /**
+    * 初始化索引值
+    * @default 0
+    */
+    defaultValue: number | string
+    /**
+    * 自动轮播时长，0表示不会自动轮播
+    * @default 0
+    */
+    autoPlay: number | string
+    /**
+    * 轮播方向,可选值horizontal,vertical
+    * @default horizontal
+    */
+    direction: 'horizontal' | 'vertical'
+    /**
+    * 分页指示器是否展示，可传入自定义的 HTML 结构
+    * @default false
+    */
+    indicator: ReactNode
+    /**
+    * 是否循环轮播
+    * @default true
+    */
+    loop: boolean
+    /**
+    * 是否可触摸滑动
+    * @default true
+    */
+    touchable: boolean
+    /**
+    * 滑动过程中是否禁用默认事件
+    * @default true
+    */
+    preventDefault: boolean
+    /**
+    * 滑动过程中是否禁止冒泡
+    * @default true
+    */
+    stopPropagation: boolean
+    /**
+    * 是否居中展示，必须传对应的width 和 height
+    * @default false
+    */
+    center: boolean
+    /**
+    * 卡片切换后的回调
+    * @default -
+    */
+    onChange?: (current: number) => void
 }
 export declare const Swiper: React.ForwardRefExoticComponent<Partial<SwiperProps> & Omit<React.HTMLAttributes<HTMLDivElement>, "onChange"> & React.RefAttributes<SwiperRef>>;

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

@@ -2,13 +2,41 @@ import { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 import TabbarItem from '../tabbaritem';
 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;

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

@@ -1,8 +1,16 @@
 import { FunctionComponent, ReactNode } from 'react';
 import { BadgeProps } from '../badge/badge';
 export interface TabbarItemProps extends BadgeProps {
-    title: ReactNode;
-    icon: ReactNode;
+    /**
+    * 标签页的标题
+    * @default -
+    */
+    title: ReactNode
+    /**
+    * 自定义图标
+    * @default -
+    */
+    icon: ReactNode
     active: boolean;
     activeColor: string;
     inactiveColor: string;