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

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

@@ -1,23 +1,109 @@
-import React, { CSSProperties, FunctionComponent } from 'react';
-import { ITouchEvent } from '@tarojs/components';
+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 | ITouchEvent) => 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.taro.d.ts

@@ -3,21 +3,81 @@ import { ITouchEvent } from '@tarojs/components';
 import { OverlayProps } from '../../packages/overlay/overlay.taro';
 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: ITouchEvent) => boolean | void;
-    onClickCloseIcon: (e: ITouchEvent) => 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: ITouchEvent) => boolean | void
+    /**
+    * 点击关闭图标时触发
+    * @default -
+    */
+    onClickCloseIcon: (e: ITouchEvent) => boolean | void
 }
 export declare const Popup: FunctionComponent<Partial<PopupProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'onClick'>>;
 export {};

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

@@ -1,12 +1,40 @@
 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;
-    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
+    /**
+    * 延迟数据加载时长，单位 ms
+    * @default 0
+    */
+    delay: number
 }
 export declare const Progress: FunctionComponent<Partial<ProgressProps> & React.HTMLAttributes<HTMLDivElement>>;

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

@@ -2,16 +2,60 @@ 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;
-    scrollTop: number;
-    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
+    /**
+    * 可滚动的父元素的 scrollTop
+    * @default 0
+    */
+    scrollTop: number
+    /**
+    * 根据下拉状态，自定义下拉提示文案
+    * @default -
+    */
+    renderText: (status: PullStatus) => ReactNode
 }
 export declare const PullToRefresh: FunctionComponent<Partial<PullToRefreshProps>>;

package/dist/types/packages/radio/radio.taro.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.taro.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.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'>>;