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

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

@@ -4,15 +4,51 @@ import { BasicComponent } from '../../utils/typings';
 export type RadioShape = 'button' | 'round';
 export type RadioPosition = 'right' | 'left';
 export interface RadioProps extends BasicComponent {
-    disabled: boolean;
-    checked: boolean;
-    defaultChecked: boolean;
-    shape: RadioShape;
-    labelPosition: RadioPosition;
-    icon: React.ReactNode;
-    activeIcon: React.ReactNode;
-    value: string | number;
-    onChange: (checked: boolean) => void;
+    /**
+    * 是否禁用选择
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 指定当前是否选中
+    * @default -
+    */
+    checked: boolean
+    /**
+    * 初始是否选中
+    * @default -
+    */
+    defaultChecked: boolean
+    /**
+    * 形状
+    * @default round
+    */
+    shape: RadioShape
+    /**
+    * 文本所在的位置
+    * @default right
+    */
+    labelPosition: RadioPosition
+    /**
+    * [图标名称](#/icon)，选中前(建议和activeIcon一起修改)
+    * @default 'CheckNormal'
+    */
+    icon: React.ReactNode
+    /**
+    * [图标名称](#/icon)，选中后(建议和icon一起修改)
+    * @default 'CheckChecked'
+    */
+    activeIcon: React.ReactNode
+    /**
+    * 携带的标识值，用于 Group 模式
+    * @default -
+    */
+    value: string | number
+    /**
+    * 选中态变化时触发
+    * @default -
+    */
+    onChange: (checked: boolean) => void
 }
 export declare const Radio: FunctionComponent<Partial<RadioProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange'>> & {
     Group: typeof RadioGroup;

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

@@ -3,13 +3,37 @@ import { RadioGroupOptionType } from './type';
 type Position = 'left' | 'right';
 type Direction = 'horizontal' | 'vertical';
 export interface RadioGroupProps {
-    value?: string | number;
+    /**
+    * 当前选中项的标识符
+    * @default -
+    */
+    value?: string | number
     defaultValue?: string | number;
-    labelPosition: Position;
-    direction: Direction;
-    disabled?: boolean;
-    options: RadioGroupOptionType[];
-    onChange: (value: string | number) => void;
+    /**
+    * 文本所在的位置
+    * @default right
+    */
+    labelPosition: Position
+    /**
+    * 使用横纵方向
+    * @default vertical
+    */
+    direction: Direction
+    /**
+    * 是否禁用
+    * @default false
+    */
+    disabled?: boolean
+    /**
+    * 配置 options 渲染单选按钮
+    * @default -
+    */
+    options: RadioGroupOptionType[]
+    /**
+    * 值变化时触发
+    * @default -
+    */
+    onChange: (value: string | number) => void
 }
 export declare const RadioGroup: React.ForwardRefExoticComponent<Partial<RadioGroupProps> & Omit<React.HTMLAttributes<HTMLDivElement>, "onChange"> & React.RefAttributes<unknown>>;
 export {};

package/dist/types/packages/range/range.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
+    /**
+    * 是否禁用滑块
+    * @default false
+    */
+    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 -
+    */
+    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/rate/rate.d.ts

@@ -1,15 +1,55 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface RateProps extends BasicComponent {
-    count: number;
-    value: number;
-    defaultValue: number;
-    min: number;
-    checkedIcon: React.ReactNode;
-    uncheckedIcon: React.ReactNode;
-    disabled: boolean;
-    readOnly: boolean;
-    allowHalf: boolean;
-    onChange: (value: number) => void;
+    /**
+    * star 总数
+    * @default 5
+    */
+    count: number
+    /**
+    * 受控的 star 数值
+    * @default 0
+    */
+    value: number
+    /**
+    * 非受控的 star 默认值
+    * @default 0
+    */
+    defaultValue: number
+    /**
+    * 最少选中star数量
+    * @default 0
+    */
+    min: number
+    /**
+    * 使用图标(选中)
+    * @default star-n
+    */
+    checkedIcon: React.ReactNode
+    /**
+    * 使用图标(未选中)
+    * @default star-n
+    */
+    uncheckedIcon: React.ReactNode
+    /**
+    * 是否禁用
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 是否只读
+    * @default false
+    */
+    readOnly: boolean
+    /**
+    * 是否半星
+    * @default false
+    */
+    allowHalf: boolean
+    /**
+    * 当前 star 数修改时触发
+    * @default -
+    */
+    onChange: (value: number) => void
 }
 export declare const Rate: FunctionComponent<Partial<RateProps>>;

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

@@ -1,37 +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';
-    /** 是否禁用输入框	 */
+    /**
+    * 是否禁用输入框
+    * @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;
-    /** 点击清除按钮后触发	 */
+    /**
+    * 点击清空时触发
+    * @default 
+    */
     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.d.ts

@@ -1,22 +1,90 @@
 import { FunctionComponent, ReactNode } from 'react';
 import { PopupProps } from '../popup/popup';
 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.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>>;