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

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

@@ -1,13 +1,45 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface AvatarGroupProps extends BasicComponent {
-    maxContent: string;
-    max: string | number;
-    maxBackground: string;
-    maxColor: string;
-    size: 'large' | 'normal' | 'small';
-    shape: 'round' | 'square';
-    gap: string;
-    level: 'left' | 'right';
+    /**
+    * 头像数量超出时，会出现一个头像折叠元素。该元素内容可为...、more、+N。
+    * @default ''
+    */
+    maxContent: string
+    /**
+    * 显示的最大头像个数
+    * @default ''
+    */
+    max: string | number
+    /**
+    * 设置 Icon、字符类型头像的背景色
+    * @default #eee
+    */
+    maxBackground: string
+    /**
+    * 设置 Icon、字符类型头像的颜色
+    * @default #666
+    */
+    maxColor: string
+    /**
+    * 设置头像的大小，可选值为：large、normal、small，支持直接输入数字
+    * @default ''
+    */
+    size: 'large' | 'normal' | 'small'
+    /**
+    * 设置头像的形状
+    * @default ''
+    */
+    shape: 'round' | 'square'
+    /**
+    * 设置头像之间的间距
+    * @default -8
+    */
+    gap: string
+    /**
+    * 头像之间的层级关系，可选值为：left、right
+    * @default 'left'
+    */
+    level: 'left' | 'right'
 }
 export declare const AvatarGroup: FunctionComponent<Partial<AvatarGroupProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -1,10 +1,30 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface BackTopProps extends BasicComponent {
-    target: string;
-    threshold: number;
-    zIndex: number;
-    duration: number;
-    onClick?: (event: MouseEvent) => void;
+    /**
+    * 获取监听的目标元素
+    * @default -
+    */
+    target: string
+    /**
+    * 页面垂直滚动多高后出现
+    * @default 200
+    */
+    threshold: number
+    /**
+    * 设置组件页面层级
+    * @default 10
+    */
+    zIndex: number
+    /**
+    * 设置动画持续时间，为 0 时表示无动画
+    * @default 1000
+    */
+    duration: number
+    /**
+    * 按钮点击时触发事件
+    * @default -
+    */
+    onClick?: (event: MouseEvent) => void
 }
 export declare const BackTop: FunctionComponent<Partial<BackTopProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onClick'>>;

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

@@ -1,11 +1,35 @@
 import { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface BadgeProps extends BasicComponent {
-    value: ReactNode;
-    dot: boolean;
-    max: number;
-    top: string;
-    right: string;
-    color: string;
+    /**
+    * 显示的内容，支持数字、字符和自定义内容
+    * @default -
+    */
+    value: ReactNode
+    /**
+    * 是否为小点
+    * @default false
+    */
+    dot: boolean
+    /**
+    * value 为数值时，最大值
+    * @default 99
+    */
+    max: number
+    /**
+    * 上下偏移量，支持单位设置，可设置为：5 等
+    * @default 0
+    */
+    top: string
+    /**
+    * 左右偏移量，支持单位设置，可设置为：5 等
+    * @default 0
+    */
+    right: string
+    /**
+    * 徽标背景颜色,默认值为当前主题色
+    * @default 
+    */
+    color: string
 }
 export declare const Badge: FunctionComponent<Partial<BadgeProps>>;

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

@@ -5,15 +5,55 @@ export type ButtonSize = 'large' | 'normal' | 'small';
 export type ButtonShape = 'square' | 'round';
 export type ButtonFill = 'solid' | 'outline' | 'none';
 export interface ButtonProps extends BasicComponent {
-    color: string;
-    shape: ButtonShape;
-    type: ButtonType;
-    size: ButtonSize;
-    fill: ButtonFill;
-    block: boolean;
-    loading: boolean;
-    disabled: boolean;
-    icon: React.ReactNode;
-    onClick: (e: MouseEvent) => void;
+    /**
+    * 按钮颜色，支持传入 linear-gradient 渐变色
+    * @default -
+    */
+    color: string
+    /**
+    * 按钮的形状
+    * @default 'round'
+    */
+    shape: ButtonShape
+    /**
+    * 按钮的样式
+    * @default 'default'
+    */
+    type: ButtonType
+    /**
+    * 按钮的尺寸
+    * @default 'normal'
+    */
+    size: ButtonSize
+    /**
+    * 填充模式
+    * @default 'solid'
+    */
+    fill: ButtonFill
+    /**
+    * 是否为块级元素
+    * @default false
+    */
+    block: boolean
+    /**
+    * 按钮loading状态
+    * @default false
+    */
+    loading: boolean
+    /**
+    * 是否禁用按钮
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 按钮图标
+    * @default -
+    */
+    icon: React.ReactNode
+    /**
+    * 点击按钮时触发
+    * @default false
+    */
+    onClick: (e: MouseEvent) => void
 }
 export declare const Button: React.ForwardRefExoticComponent<Partial<ButtonProps> & React.RefAttributes<HTMLButtonElement>>;

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

@@ -2,24 +2,92 @@ import React from 'react';
 import { CascaderOption, CascaderValue, CascaderOptionKey } from './types';
 import { BasicComponent } from '../../utils/typings';
 export interface CascaderProps extends BasicComponent {
-    popup: boolean;
-    visible: boolean;
-    activeColor: string;
-    activeIcon: string;
-    options: CascaderOption[];
-    value?: CascaderValue;
-    defaultValue?: CascaderValue;
-    title: string;
-    optionKey: CascaderOptionKey;
-    format: Record<string, string | number | null>;
-    closeable: boolean;
-    closeIconPosition: string;
-    closeIcon: string;
-    lazy: boolean;
-    onLoad: (node: any, resolve: any) => void;
+    /**
+    * 是否弹窗状态展示
+    * @default true
+    */
+    popup: boolean
+    /**
+    * 级联显示隐藏状态
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 选中激活颜色
+    * @default -
+    */
+    activeColor: string
+    /**
+    * 标记选中的Icon
+    * @default ReactNode
+    */
+    activeIcon: string
+    /**
+    * 级联数据
+    * @default -
+    */
+    options: CascaderOption[]
+    /**
+    * 选中值，受控
+    * @default string)[]
+    */
+    value?: CascaderValue
+    /**
+    * 默认选中值
+    * @default string)[]
+    */
+    defaultValue?: CascaderValue
+    /**
+    * 标题
+    * @default -
+    */
+    title: string
+    /**
+    * 自定义options结构中，包含 textKey、valueKey、childrenKey
+    * @default -
+    */
+    optionKey: CascaderOptionKey
+    /**
+    * 当options为可转换为树形结构的扁平结构时，配置转换规则
+    * @default -
+    */
+    format: Record<string, string | number | null>
+    /**
+    * 是否显示关闭按钮，继承 Popup 组件
+    * @default true
+    */
+    closeable: boolean
+    /**
+    * 取消按钮位置，继承 Popup 组件
+    * @default top-right
+    */
+    closeIconPosition: string
+    /**
+    * 自定义关闭按钮，继承 Popup 组件
+    * @default close
+    */
+    closeIcon: string
+    /**
+    * 是否开启动态加载
+    * @default false
+    */
+    lazy: boolean
+    /**
+    * 动态加载回调，开启动态加载时生效
+    * @default -
+    */
+    onLoad: (node: any, resolve: any) => void
     onClose?: () => void;
-    onChange: (value: CascaderValue, params?: any) => void;
-    onPathChange: (value: CascaderValue, params: any) => void;
+    /**
+    * 选中值改变时触发
+    * @default 
+    */
+    onChange: (value: CascaderValue, params?: any) => void
+    /**
+    * 选中项改变时触发
+    * @default 
+    */
+    onPathChange: (value: CascaderValue, params: any) => void
 }
 export declare const Cascader: React.ForwardRefExoticComponent<Partial<CascaderProps> & {
     children?: React.ReactNode;

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

@@ -1,11 +1,35 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface CellProps extends BasicComponent {
-    title: ReactNode;
-    description: ReactNode;
-    extra: ReactNode;
-    radius: string | number;
-    align: string;
-    onClick: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+    /**
+    * 标题
+    * @default -
+    */
+    title: ReactNode
+    /**
+    * 描述
+    * @default -
+    */
+    description: ReactNode
+    /**
+    * 右侧描述
+    * @default -
+    */
+    extra: ReactNode
+    /**
+    * 圆角半径
+    * @default 6px
+    */
+    radius: string | number
+    /**
+    * 纵轴方向上的对齐方式，可选值为：flex-start、center、flex-end
+    * @default flex-start
+    */
+    align: string
+    /**
+    * 点击事件
+    * @default false
+    */
+    onClick: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => void
 }
 export declare const Cell: FunctionComponent<Partial<CellProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'title'>>;

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

@@ -1,9 +1,21 @@
 import { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface CellGroupProps extends BasicComponent {
-    title: ReactNode;
-    description: ReactNode;
+    /**
+    * 分组标题
+    * @default -
+    */
+    title: ReactNode
+    /**
+    * 分组描述
+    * @default -
+    */
+    description: ReactNode
     children?: ReactNode;
-    divider: boolean;
+    /**
+    * 单元格之间是否有分割线
+    * @default true
+    */
+    divider: boolean
 }
 export declare const CellGroup: FunctionComponent<Partial<CellGroupProps>>;

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

@@ -3,13 +3,45 @@ import { RadioGroupOptionType } from '../../packages/radiogroup/type';
 export type CheckboxLabelPosition = 'left' | 'right';
 export type CheckboxDirection = 'horizontal' | 'vertical';
 export interface CheckboxGroupProps {
-    disabled?: boolean;
-    value?: string[];
-    defaultValue?: string[];
-    max: number | undefined;
-    labelPosition: CheckboxLabelPosition;
-    direction: CheckboxDirection;
-    options: RadioGroupOptionType[];
-    onChange: (value: string[]) => void;
+    /**
+    * 是否禁用选择,将用于其下的全部复选框
+    * @default false
+    */
+    disabled?: boolean
+    /**
+    * 当前选中项的标识符
+    * @default -
+    */
+    value?: string[]
+    /**
+    * 初始选中项的标识符
+    * @default -
+    */
+    defaultValue?: string[]
+    /**
+    * 限制最大可选数
+    * @default number
+    */
+    max: number | undefined
+    /**
+    * 文本所在的位置，可选值：left,right
+    * @default right
+    */
+    labelPosition: CheckboxLabelPosition
+    /**
+    * 使用横纵方向 可选值 horizontal、vertical
+    * @default vertical
+    */
+    direction: CheckboxDirection
+    /**
+    * 配置 options 渲染复选按钮
+    * @default -
+    */
+    options: RadioGroupOptionType[]
+    /**
+    * 值变化时触发
+    * @default -
+    */
+    onChange: (value: string[]) => void
 }
 export declare const CheckboxGroup: React.ForwardRefExoticComponent<Partial<CheckboxGroupProps> & Omit<React.HTMLAttributes<HTMLDivElement>, "onChange"> & React.RefAttributes<unknown>>;

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

@@ -4,12 +4,40 @@ export interface Color {
     [key: string]: string;
 }
 export interface CircleProgressProps extends BasicComponent {
-    percent: string | number;
-    strokeWidth?: string | number;
-    radius?: number | string;
-    strokeLinecap?: 'butt' | 'round' | 'square' | 'inherit';
-    color?: object | string;
-    background?: string;
-    clockwise?: boolean;
+    /**
+    * 百分比
+    * @default 必传项，无默认值
+    */
+    percent: string | number
+    /**
+    * 圆弧的宽度
+    * @default 5
+    */
+    strokeWidth?: string | number
+    /**
+    * 半径
+    * @default 50
+    */
+    radius?: number | string
+    /**
+    * 圆环进度条端点形状
+    * @default 'round'
+    */
+    strokeLinecap?: 'butt' | 'round' | 'square' | 'inherit'
+    /**
+    * 圆环进度条颜色，传入对象格式可以定义渐变色
+    * @default ''
+    */
+    color?: object | string
+    /**
+    * 圆环轨道颜色
+    * @default #d9d9d9
+    */
+    background?: string
+    /**
+    * 是否顺时针展示
+    * @default true
+    */
+    clockwise?: boolean
 }
 export declare const CircleProgress: FunctionComponent<CircleProgressProps & Omit<React.HTMLAttributes<HTMLDivElement>, 'color'>>;

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

@@ -2,9 +2,21 @@ import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export type ColEventType = 'row' | 'col';
 export interface ColProps extends BasicComponent {
-    span: string | number;
-    offset: string | number;
+    /**
+    * 列元素宽度（共分为24份，例如设置一行3个，那么span值为8）
+    * @default 24
+    */
+    span: string | number
+    /**
+    * 列元素偏移距离
+    * @default 0
+    */
+    offset: string | number
     gutter: string | number;
-    onClick: (e: any, type: ColEventType) => void;
+    /**
+    * 点击时触发
+    * @default -
+    */
+    onClick: (e: any, type: ColEventType) => void
 }
 export declare const Col: FunctionComponent<Partial<ColProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onClick'>>;

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

@@ -3,11 +3,31 @@ import { BasicComponent } from '../../utils/typings';
 import CollapseItem from '../collapseitem';
 type keyType = Array<string> | string;
 export interface CollapseProps extends BasicComponent {
-    activeName: keyType;
-    defaultActiveName: keyType;
-    accordion: boolean;
-    expandIcon: ReactNode;
-    rotate: number;
+    /**
+    * 当前展开面板的 name，受控
+    * @default -
+    */
+    activeName: keyType
+    /**
+    * 默认展开面板的 name，非受控
+    * @default -
+    */
+    defaultActiveName: keyType
+    /**
+    * 是否开启手风琴模式
+    * @default false
+    */
+    accordion: boolean
+    /**
+    * 自定义展开图标
+    * @default -
+    */
+    expandIcon: ReactNode
+    /**
+    * 点击折叠和展开的旋转角度,在自定义图标模式下生效
+    * @default 180
+    */
+    rotate: number
     onChange: (activeName: keyType, name: string, isOpen: boolean) => void;
 }
 export declare const Collapse: FunctionComponent<Partial<CollapseProps>> & {

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

@@ -1,12 +1,28 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface CollapseItemProps extends BasicComponent {
-    title: ReactNode;
-    name: string;
+    /**
+    * 标题栏左侧内容
+    * @default -
+    */
+    title: ReactNode
+    /**
+    * 唯一标识符，必填
+    * @default -
+    */
+    name: string
     isOpen: boolean;
     expandIcon: ReactNode;
-    disabled: boolean;
+    /**
+    * 标题栏是否禁用
+    * @default false
+    */
+    disabled: boolean
     rotate: number;
-    extra: ReactNode;
+    /**
+    * 标题栏副标题
+    * @default -
+    */
+    extra: ReactNode
 }
 export declare const CollapseItem: FunctionComponent<Partial<CollapseItemProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'title'>>;

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

@@ -1,8 +1,17 @@
 import React, { FunctionComponent } from 'react';
 import { BaseLang } from '../../locales/base';
+import type { NutCSSVariables } from './types';
 export interface ConfigProviderProps {
-    locale: BaseLang;
-    theme?: Record<string, string>;
+    /**
+    * 设置多语言包
+    * @default zhCN
+    */
+    locale: BaseLang
+    /**
+    * 设置主题
+    * @default -
+    */
+    theme?: Record<string | NutCSSVariables, string>
     [key: string]: any;
 }
 export declare const defaultConfigRef: {

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

@@ -1,4 +1,5 @@
 import { ConfigProvider, useConfig, setDefaultConfig, getDefaultConfig } from './configprovider';
 export type { ConfigProviderProps } from './configprovider';
+export type { NutCSSVariables } from './types';
 export { useConfig, setDefaultConfig, getDefaultConfig };
 export default ConfigProvider;