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

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

@@ -1,16 +1,60 @@
 import React, { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface PaginationProps extends BasicComponent {
-    value: number;
-    defaultValue: number;
-    mode: 'multi' | 'simple';
-    prev: ReactNode;
-    next: ReactNode;
-    total: number;
-    pageSize: number;
-    itemSize: number;
-    ellipse: boolean;
-    itemRender: (page: any) => ReactNode;
-    onChange: (currPage: number) => void;
+    /**
+    * 当前页码，受控值，与 onChange 搭配使用
+    * @default -
+    */
+    value: number
+    /**
+    * 默认页码，非受控
+    * @default 1
+    */
+    defaultValue: number
+    /**
+    * 显示模式,可选值为：multi，simple
+    * @default multi
+    */
+    mode: 'multi' | 'simple'
+    /**
+    * 自定义上一页按钮内容
+    * @default 上一页
+    */
+    prev: ReactNode
+    /**
+    * 自定义下一页按钮内容
+    * @default 下一页
+    */
+    next: ReactNode
+    /**
+    * 总记录数
+    * @default 50
+    */
+    total: number
+    /**
+    * 每页记录数
+    * @default 10
+    */
+    pageSize: number
+    /**
+    * 显示的页码个数
+    * @default 5
+    */
+    itemSize: number
+    /**
+    * 是否显示省略号
+    * @default false
+    */
+    ellipse: boolean
+    /**
+    * 用于自定义页码的结构
+    * @default -
+    */
+    itemRender: (page: any) => ReactNode
+    /**
+    * 页码改变时触发
+    * @default -
+    */
+    onChange: (currPage: number) => void
 }
 export declare const Pagination: FunctionComponent<Partial<PaginationProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange'>>;

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

@@ -2,17 +2,61 @@ import React, { RefObject } from 'react';
 import { PickerOption } from './types';
 import { BasicComponent } from '../../utils/typings';
 export interface PickerProps extends BasicComponent {
-    visible: boolean;
-    title?: string;
-    options: (PickerOption | PickerOption[])[];
-    value?: (number | string)[];
-    defaultValue?: (number | string)[];
-    threeDimensional?: boolean;
-    duration: number | string;
-    onConfirm?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void;
-    onClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void;
-    afterClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], pickerRef: RefObject<HTMLDivElement>) => void;
-    onChange?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], columnIndex: number) => void;
+    /**
+    * 是否可见
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 设置标题
+    * @default -
+    */
+    title?: string
+    /**
+    * 列表数据
+    * @default []
+    */
+    options: (PickerOption | PickerOption[])[]
+    /**
+    * 选中值，受控
+    * @default []
+    */
+    value?: (number | string)[]
+    /**
+    * 默认选中
+    * @default []
+    */
+    defaultValue?: (number | string)[]
+    /**
+    * 是否开启3D效果
+    * @default true
+    */
+    threeDimensional?: boolean
+    /**
+    * 快速滑动时惯性滚动的时长，单位 ms
+    * @default 1000
+    */
+    duration: number | string
+    /**
+    * 点击确认按钮时候回调
+    * @default -
+    */
+    onConfirm?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void
+    /**
+    * 关闭时触发
+    * @default -
+    */
+    onClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[]) => void
+    /**
+    * 联动时，关闭时回调
+    * @default -
+    */
+    afterClose?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], pickerRef: RefObject<HTMLDivElement>) => void
+    /**
+    * 每一列值变更时调用
+    * @default -
+    */
+    onChange?: (selectedOptions: PickerOption[], selectedValue: (string | number)[], columnIndex: number) => void
 }
 declare const Picker: React.ForwardRefExoticComponent<Partial<PickerProps> & React.RefAttributes<unknown>>;
 export default Picker;

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

@@ -1,2 +1,3 @@
 import { Popover } from './popover';
+export type { PopoverLocation, PopoverProps, List } from './popover';
 export default Popover;

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

@@ -1,22 +1,109 @@
-import React, { CSSProperties, FunctionComponent } from 'react';
+import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
-export type PopoverTheme = 'light' | 'dark';
 export type PopoverLocation = 'bottom' | 'top' | 'left' | 'right' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end' | 'right-start' | 'right-end';
 export interface List {
+    key?: string;
     name: string;
     icon?: React.ReactNode;
     disabled?: boolean;
+    className?: string;
 }
 export interface PopoverProps extends BasicComponent {
-    list: List[];
-    theme: PopoverTheme;
-    location: PopoverLocation | string;
-    visible: boolean;
-    offset: string | number;
-    className: string;
-    style?: CSSProperties;
+    /**
+    * 选项列表
+    * @default []
+    */
+    list: List[]
+    /**
+    * 弹出位置，里面具体的参数值可以参考上面的位置自定义例子
+    * @default bottom
+    */
+    location: PopoverLocation | string
+    /**
+    * 是否展示气泡弹出层
+    * @default false
+    */
+    visible: boolean
+    /**
+    * 出现位置的偏移量
+    * @default [0, 12]
+    */
+    offset: string[] | number[]
+    /**
+    * 自定义目标元素 id
+    * @default -
+    */
+    targetId: string
+    /**
+    * 自定义背景色
+    * @default -
+    */
+    background: string
+    /**
+    * 自定义选项文字颜色
+    * @default -
+    */
+    color: string
+    /**
+    * 是否显示小箭头
+    * @default true
+    */
+    showArrow: boolean
+    /**
+    * 动画时长，单位秒
+    * @default 0.3
+    */
+    duration: string | number
+    /**
+    * 是否显示遮罩层
+    * @default false
+    */
+    overlay: boolean
+    /**
+    * 自定义遮罩层类名
+    * @default ''
+    */
+    overlayClassName: string
+    /**
+    * 自定义遮罩层样式
+    * @default {}
+    */
+    overlayStyle: React.CSSProperties
+    /**
+    * 是否在点击外部元素后关闭菜单
+    * @default true
+    */
+    closeOnClickOutside: boolean
+    /**
+    * 是否在点击选项后关闭
+    * @default true
+    */
+    closeOnClickAction: boolean
+    /**
+    * 是否在点击遮罩层后关闭菜单
+    * @default true
+    */
+    closeOnOverlayClick: boolean
     children?: React.ReactNode;
-    onClick: (e: React.MouseEvent) => void;
-    onChoose: (item: List, index: number) => void;
+    /**
+    * 点击切换 popover 展示状态
+    * @default () => {}
+    */
+    onClick: () => void
+    /**
+    * 点击菜单时触发
+    * @default () => {}
+    */
+    onOpen: () => void
+    /**
+    * 关闭菜单时触发
+    * @default () => {}
+    */
+    onClose: () => void
+    /**
+    * 点击选项时触发
+    * @default (item, index) => {}
+    */
+    onSelect: (item: List, index: number) => void
 }
-export declare const Popover: FunctionComponent<Partial<PopoverProps> & React.HTMLAttributes<HTMLDivElement>>;
+export declare const Popover: FunctionComponent<Partial<PopoverProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onSelect'>>;

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

@@ -2,21 +2,81 @@ import React, { FunctionComponent, MouseEvent } from 'react';
 import { OverlayProps } from '../../packages/overlay/overlay';
 type Teleport = HTMLElement | (() => HTMLElement) | null;
 export interface PopupProps extends OverlayProps {
-    position: string;
-    transition: string;
-    overlayStyle: React.CSSProperties;
-    overlayClassName: string;
-    closeable: boolean;
-    closeIconPosition: string;
-    closeIcon: React.ReactNode;
-    destroyOnClose: boolean;
-    portal: Teleport;
-    overlay: boolean;
-    round: boolean;
-    onOpen: () => void;
-    onClose: () => void;
-    onClickOverlay: (e: MouseEvent) => boolean | void;
-    onClickCloseIcon: (e: MouseEvent) => boolean | void;
+    /**
+    * 弹出位置（top,bottom,left,right,center）
+    * @default center
+    */
+    position: string
+    /**
+    * 动画名
+    * @default -
+    */
+    transition: string
+    /**
+    * 自定义遮罩样式
+    * @default -
+    */
+    overlayStyle: React.CSSProperties
+    /**
+    * 自定义遮罩类名
+    * @default -
+    */
+    overlayClassName: string
+    /**
+    * 是否显示关闭按钮
+    * @default false
+    */
+    closeable: boolean
+    /**
+    * 关闭按钮位置（top-left,top-right,bottom-left,bottom-right）
+    * @default top-right
+    */
+    closeIconPosition: string
+    /**
+    * 自定义 Icon
+    * @default close
+    */
+    closeIcon: React.ReactNode
+    /**
+    * 组件不可见时，卸载内容
+    * @default false
+    */
+    destroyOnClose: boolean
+    /**
+    * 指定节点挂载
+    * @default null
+    */
+    portal: Teleport
+    /**
+    * 是否显示遮罩
+    * @default true
+    */
+    overlay: boolean
+    /**
+    * 是否显示圆角
+    * @default false
+    */
+    round: boolean
+    /**
+    * 打开弹框时触发
+    * @default -
+    */
+    onOpen: () => void
+    /**
+    * 关闭弹框时触发
+    * @default -
+    */
+    onClose: () => void
+    /**
+    * 点击遮罩触发
+    * @default -
+    */
+    onClickOverlay: (e: MouseEvent) => boolean | void
+    /**
+    * 点击关闭图标时触发
+    * @default -
+    */
+    onClickCloseIcon: (e: MouseEvent) => boolean | void
 }
 export declare const Popup: FunctionComponent<Partial<PopupProps> & React.HTMLAttributes<HTMLDivElement>>;
 export {};

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

@@ -1,12 +1,40 @@
 import { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface PriceProps extends BasicComponent {
-    price: number | string;
-    symbol: string;
-    digits: number;
-    thousands: boolean;
-    position: string;
-    size: string;
-    line: boolean;
+    /**
+    * 价格数量
+    * @default 0
+    */
+    price: number | string
+    /**
+    * 符号类型
+    * @default ¥
+    */
+    symbol: string
+    /**
+    * 小数位位数
+    * @default 2
+    */
+    digits: number
+    /**
+    * 是否按照千分号形式显示
+    * @default false
+    */
+    thousands: boolean
+    /**
+    * 符号显示在价格前或者后，before、after
+    * @default before
+    */
+    position: string
+    /**
+    * 价格尺寸，large、normal、small
+    * @default large
+    */
+    size: string
+    /**
+    * 是否划线价
+    * @default false
+    */
+    line: boolean
 }
 export declare const Price: FunctionComponent<Partial<PriceProps>>;

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

@@ -1,13 +1,45 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface ProgressProps extends BasicComponent {
-    percent: number;
-    background: string;
-    color: string;
-    strokeWidth: string;
-    showText: boolean;
-    animated: boolean;
-    lazy: boolean;
-    delay: number;
+    /**
+    * 百分比
+    * @default 0
+    */
+    percent: number
+    /**
+    * 进度条背景颜色
+    * @default #f3f3f3
+    */
+    background: string
+    /**
+    * 进度条线条颜色
+    * @default linear-gradient(135deg, #fa2c19 0%, #fa6419 100%)
+    */
+    color: string
+    /**
+    * 进度条宽度
+    * @default -
+    */
+    strokeWidth: string
+    /**
+    * 是否显示文字内容
+    * @default false
+    */
+    showText: boolean
+    /**
+    * 是否展示动画效果
+    * @default false
+    */
+    animated: boolean
+    /**
+    * 每次进入可视区展示进度条动画
+    * @default false
+    */
+    lazy: boolean
+    /**
+    * 延迟数据加载时长，单位 ms
+    * @default 0
+    */
+    delay: number
 }
 export declare const Progress: FunctionComponent<Partial<ProgressProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -2,15 +2,55 @@ import { FunctionComponent, ReactNode } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export type PullStatus = 'pulling' | 'canRelease' | 'refreshing' | 'complete';
 export interface PullToRefreshProps extends BasicComponent {
-    onRefresh: () => Promise<any>;
-    pullingText: ReactNode;
-    canReleaseText: ReactNode;
-    refreshingText: ReactNode;
-    completeText: ReactNode;
-    completeDelay: number;
-    headHeight: number;
-    threshold: number;
-    disabled: boolean;
-    renderText: (status: PullStatus) => ReactNode;
+    /**
+    * 触发刷新时的处理函数
+    * @default -
+    */
+    onRefresh: () => Promise<any>
+    /**
+    * 下拉的提示文案
+    * @default 下拉刷新
+    */
+    pullingText: ReactNode
+    /**
+    * 释放的提示文案
+    * @default 释放立即刷新
+    */
+    canReleaseText: ReactNode
+    /**
+    * 刷新时的提示文案
+    * @default 加载中……
+    */
+    refreshingText: ReactNode
+    /**
+    * 完成时的提示文案
+    * @default 刷新成功
+    */
+    completeText: ReactNode
+    /**
+    * 完成后延迟消失的时间，单位为 ms
+    * @default 500
+    */
+    completeDelay: number
+    /**
+    * 头部提示内容区的高度，单位为 px
+    * @default 40
+    */
+    headHeight: number
+    /**
+    * 触发刷新需要下拉多少距离，单位为 px
+    * @default 60
+    */
+    threshold: number
+    /**
+    * 是否禁用下拉刷新
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 根据下拉状态，自定义下拉提示文案
+    * @default -
+    */
+    renderText: (status: PullStatus) => ReactNode
 }
 export declare const PullToRefresh: FunctionComponent<Partial<PullToRefreshProps>>;

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 {};