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

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;

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

@@ -3,9 +3,21 @@ interface TabPanelInnerProps {
     autoHeightClassName: string;
 }
 export interface TabPaneProps {
-    title: string | number;
-    value: string | number;
-    disabled: boolean;
+    /**
+    * 标题
+    * @default -
+    */
+    title: string | number
+    /**
+    * 标签 Key , 匹配的标识符, 默认为索引值
+    * @default -
+    */
+    value: string | number
+    /**
+    * 是否禁用标签
+    * @default false
+    */
+    disabled: boolean
     className: string;
     children?: React.ReactNode;
 }

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

@@ -8,18 +8,66 @@ export type TabsTitle = {
     value: string | number;
 };
 export interface TabsProps extends BasicComponent {
-    tabStyle: React.CSSProperties;
-    value: string | number;
-    defaultValue: string | number;
-    activeColor: string;
-    direction: 'horizontal' | 'vertical';
-    activeType: 'line' | 'smile';
-    duration: number | string;
-    align: 'left' | 'right';
-    title: () => JSX.Element[];
-    onChange: (index: string | number) => void;
-    onClick: (index: string | number) => void;
-    autoHeight: boolean;
+    /**
+    * 标签栏样式
+    * @default {}
+    */
+    tabStyle: React.CSSProperties
+    /**
+    * 当前激活 tab 面板的值
+    * @default 0
+    */
+    value: string | number
+    /**
+    * 初始化激活 tab 的值
+    * @default 0
+    */
+    defaultValue: string | number
+    /**
+    * 标签选中色
+    * @default #1a1a1a
+    */
+    activeColor: string
+    /**
+    * 使用横纵方向 可选值 horizontal、vertical
+    * @default horizontal
+    */
+    direction: 'horizontal' | 'vertical'
+    /**
+    * 选中底部展示样式 可选值 line、smile
+    * @default line
+    */
+    activeType: 'line' | 'smile'
+    /**
+    * 切换动画时长,单位 ms 0 代表无动画
+    * @default 300
+    */
+    duration: number | string
+    /**
+    * 标题左对齐
+    * @default -
+    */
+    align: 'left' | 'right'
+    /**
+    * 自定义导航区域
+    * @default -
+    */
+    title: () => JSX.Element[]
+    /**
+    * 当前激活的标签改变时触发
+    * @default -
+    */
+    onChange: (index: string | number) => void
+    /**
+    * 点击标签时触发
+    * @default -
+    */
+    onClick: (index: string | number) => void
+    /**
+    * 自动高度。设置为 true 时，nut-tabs 和 nut-tabs\_\_content 会随着当前 nut-tabpane 的高度而发生变化。
+    * @default false
+    */
+    autoHeight: boolean
     children?: React.ReactNode;
 }
 export declare const Tabs: FunctionComponent<Partial<TabsProps>> & {

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

@@ -1,17 +1,65 @@
 import React, { FunctionComponent } from 'react';
 import { BasicComponent } from '../../utils/typings';
 export interface TextAreaProps extends BasicComponent {
-    value: string;
-    defaultValue: string;
-    showCount: boolean;
-    maxLength: number;
-    rows: number;
-    placeholder: string;
-    readOnly: boolean;
-    disabled: boolean;
-    autoSize: boolean;
-    onChange: (value: string) => void;
-    onBlur: (event: Event) => void;
-    onFocus: (event: Event) => void;
+    /**
+    * 输入框内容，受控
+    * @default -
+    */
+    value: string
+    /**
+    * 初始默认值，非受控
+    * @default -
+    */
+    defaultValue: string
+    /**
+    * textarea 是否展示输入字符。须配合maxLength使用
+    * @default false
+    */
+    showCount: boolean
+    /**
+    * 限制最长输入字符，-1 表示无限制
+    * @default 140
+    */
+    maxLength: number
+    /**
+    * textarea 的行数
+    * @default 2
+    */
+    rows: number
+    /**
+    * 设置占位提示文字
+    * @default 请输入内容
+    */
+    placeholder: string
+    /**
+    * 只读属性
+    * @default false
+    */
+    readOnly: boolean
+    /**
+    * 禁用属性
+    * @default false
+    */
+    disabled: boolean
+    /**
+    * 高度是否可拉伸
+    * @default false
+    */
+    autoSize: boolean
+    /**
+    * 输入内容时触发
+    * @default -
+    */
+    onChange: (value: string) => void
+    /**
+    * 失焦时触发
+    * @default -
+    */
+    onBlur: (event: Event) => void
+    /**
+    * 聚焦时触发
+    * @default -
+    */
+    onFocus: (event: Event) => void
 }
 export declare const TextArea: FunctionComponent<Partial<TextAreaProps> & Omit<React.HTMLAttributes<HTMLTextAreaElement>, 'onChange' | 'onBlur' | 'onFocus'>>;

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

@@ -1,18 +1,60 @@
 import React, { FunctionComponent } from 'react';
-export interface TrendArrowProps {
-    rate: number;
-    digits: number;
-    showSign: boolean;
-    showZero: boolean;
-    arrowLeft: boolean;
-    syncTextColor: boolean;
-    textColor: string;
-    riseColor: string;
-    dropColor: string;
-    iconSize: string;
-    upIcon: React.ReactNode;
-    downIcon: React.ReactNode;
-    className: string;
-    style: React.CSSProperties;
+import { BasicComponent } from '../../utils/typings';
+export interface TrendArrowProps extends BasicComponent {
+    /**
+    * 数值，大于0时箭头向上，小于0时箭头向下
+    * @default -
+    */
+    value: number
+    /**
+    * 小数位精度
+    * @default 2
+    */
+    digits: number
+    /**
+    * 是否显示加减号
+    * @default false
+    */
+    symbol: boolean
+    /**
+    * 是否显示 0
+    * @default false
+    */
+    zero: boolean
+    /**
+    * 是否在数字左侧显示箭头
+    * @default false
+    */
+    arrowLeft: boolean
+    /**
+    * 文字颜色是否与箭头同步
+    * @default true
+    */
+    syncColor: boolean
+    /**
+    * 文字颜色
+    * @default #333333
+    */
+    color: string
+    /**
+    * 向上箭头颜色
+    * @default #fa2c19
+    */
+    riseColor: string
+    /**
+    * 向下箭头颜色
+    * @default #64b578
+    */
+    dropColor: string
+    /**
+    * 自定义向上箭头icon
+    * @default <TriangleUp/>
+    */
+    riseIcon: React.ReactNode
+    /**
+    * 自定义向下箭头icon
+    * @default <TriangleDown/>
+    */
+    downIcon: React.ReactNode
 }
 export declare const TrendArrow: FunctionComponent<Partial<TrendArrowProps> & React.HTMLAttributes<HTMLDivElement>>;