@ray-js/components 0.3.31 → 0.4.2

package/lib/Button/props.d.ts

@@ -1,19 +1,79 @@
 /// <reference types="react" />
 import { BaseProps } from '../types';
 export interface ButtonProps extends BaseProps {
-    disabled?: boolean;
+    /**
+     * @description.en disabled
+     * @description.zh 是否禁用
+     * @default undefined
+     */
+    disabled?: false;
+    /**
+     * @description.en loading
+     * @description.zh 是否加载中
+     * @default undefined
+     */
     loading?: boolean;
+    /**
+     * @description.en Button size
+     * @description.zh 按钮的大小
+     * @default default
+     */
     size?: 'default' | 'mini';
+    /**
+     * @description.en The style type of the button
+     * @description.zh 按钮的样式类型
+     * @default default
+     */
     type?: 'default' | 'primary' | 'warn';
+    /**
+     * @description.en Whether the button hollow, transparent background color
+     * @description.zh 按钮是否镂空，背景色透明
+     * @default undefined
+     */
     plain?: boolean;
+    /**
+     * @description.en Press down on the style
+     * @description.zh 按下去的样式
+     * @default undefined
+     */
     hoverStyle?: any;
+    /**
+     * @description.en Press down class on the style
+     * @description.zh 按下去的样式class
+     * @default undefined
+     */
     hoverClassName?: string;
+    /**
+     * @description.en How long does it take for the click state to appear after holding, in milliseconds
+     * @description.zh 按住后多久出现点击态，单位毫秒
+     * @default undefined
+     */
     hoverStartTime?: number;
+    /**
+     * @description.en Click retention time after finger release, in milliseconds
+     * @description.zh 手指松开后点击态保留时间，单位毫秒
+     * @default undefined
+     */
     hoverStayTime?: number;
+    /**
+     * @description.en onClick
+     * @description.zh 点击回调
+     * @default undefined
+     */
     onClick?: (params: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: 'click';
     }) => void;
     children?: React.ReactNode;
+    /**
+     * @description.en For the Form component, clicking on each of the Form component's Submit /reset events triggers it
+     * @description.zh 用于 form 组件，点击分别会触发 form 组件的 submit/reset 事件
+     * @default undefined
+     */
     formType?: 'submit' | 'reset';
 }
 export declare const defaultButtonProps: ButtonProps;

package/lib/Checkbox/props.d.ts

@@ -1,7 +1,27 @@
 import { BaseProps, TouchEventHandler } from '../types';
 export interface CheckboxProps extends BaseProps, TouchEventHandler {
+    /**
+     * @description.en If this parameter is selected, the change event of the checkbox-group is triggered and the value of the checkbox is carried
+     * @description.zh checkbox标识，选中时触发checkbox-group的 change 事件，并携带 checkbox 的 value
+     * @default undefined
+     */
     value?: string;
+    /**
+     * @description.en Whether it is currently selected can be set to default
+     * @description.zh 当前是否选中，可用来设置默认选中
+     * @default undefined
+     */
     checked?: boolean;
+    /**
+     * @description.en is disabled
+     * @description.zh 是否禁用
+     * @default undefined
+     */
     disabled?: boolean;
+    /**
+     * @description.en color
+     * @description.zh 颜色
+     * @default undefined
+     */
     color?: string;
 }

package/lib/CheckboxGroup/props.d.ts

@@ -4,8 +4,23 @@ export declare type CheckboxGroupOption = CheckboxProps & {
     label: string;
 };
 export interface CheckboxGroupProps extends BaseProps, TouchEventHandler {
+    /**
+     * @description.en options
+     * @description.zh 群组项 (Web 端非必填)
+     * @default null
+     */
     options?: CheckboxGroupOption[];
+    /**
+     * @description.en disabled
+     * @description.zh 是否禁用
+     * @default null
+     */
     disabled?: boolean;
+    /**
+     * @description.en Triggered when the selected item is changed
+     * @description.zh 选中项发生改变时触发 change 事件
+     * @default null
+     */
     onChange?: (event: {
         type: string;
         value: string[];

package/lib/DatePicker/index.md

@@ -18,6 +18,8 @@ import { DatePicker } from '@ray-js/components'
 
 ## 示例代码
 
+> picker 相关组件效果请使用手机模式下查看
+
 <code src="./demos/basic.tsx" title="基本使用" background="#f2f4f6"/>
 <code src="./demos/disabled.tsx" title="禁用" background="#f2f4f6"/>
 <code src="./demos/month.tsx" title="选择月份" background="#f2f4f6"/>

package/lib/DatePicker/props.d.ts

@@ -1,32 +1,100 @@
-/// <reference types="react" />
 import { BaseProps } from '../types';
 import { TouchEventHandler } from '@ray-js/framework-shared';
 declare type changeValue = (e: {
+    /**
+     * @description.en type
+     * @description.zh 类型
+     * @default undefined
+     */
     type: string;
+    /**
+     * @description.en value
+     * @description.zh value
+     * @default undefined
+     */
     value: string;
     origin?: any;
 }) => void;
 declare type CancelEvent = (e: {
+    /**
+     * @description.en type
+     * @description.zh 类型
+     * @default undefined
+     */
     type: string;
     origin: any;
 }) => void;
 export interface DatePickerProps extends BaseProps, TouchEventHandler {
+    /**
+     * @description.en disabled
+     * @description.zh 是否禁用
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * @description.en The currently selected date
+     * @description.zh 当前选择的日期
+     * @default undefined
+     */
     value?: string;
+    /**
+     * @description.en Indicates the beginning of the valid date range in the format of "YYYY-MM-DD"
+     * @description.zh 表示有效日期范围的开始，字符串格式为"YYYY-MM-DD"
+     * @default undefined
+     */
     start?: string;
+    /**
+     * @description.en Indicates the end of the valid date range in the format of "YYYY-MM-DD"
+     * @description.zh 表示有效日期范围的结束，字符串格式为"YYYY-MM-DD"
+     * @default undefined
+     */
     end?: string;
+    /**
+     * @description.en Valid values year,month,day indicate the granularity of the selector
+     * @description.zh 有效值 year,month,day，表示选择器的粒度
+     * @default undefined
+     */
     fields?: 'year' | 'month' | 'day';
+    /**
+     * @description.en onChange
+     * @description.zh 选择时触发
+     * @default undefined
+     */
     onChange?: changeValue;
+    /**
+     * @description.en onCancel
+     * @description.zh 取消选择时触发
+     * @default undefined
+     */
     onCancel?: CancelEvent;
+    /**
+     * @description.en confirmText
+     * @description.zh 确认文本
+     * @default undefined
+     */
     confirmText?: string;
+    /**
+     * @description.en cancelText
+     * @description.zh 取消文本
+     * @default undefined
+     */
     cancelText?: string;
-    children?: React.ReactNode | string;
 }
 export declare const defaultProps: DatePickerProps;
 export interface IState {
     visible: boolean;
+    /**
+     * @description.en value
+     * @description.zh value
+     * @default undefined
+     */
     value: number | number[];
     changeValue: number | number[];
+    /**
+     * @description.en range
+     * @description.zh 范围
+     * @default undefined
+     */
     range: any[];
     dateListArr: any[];
 }

package/lib/Form/props.d.ts

@@ -1,10 +1,20 @@
 import { BaseProps } from '../types';
 export declare type FormProps = BaseProps & {
+    /**
+     * @description.en Trigger the Submit event with the data in the form
+     * @description.zh 携带 form 中的数据触发 submit 事件
+     * @default null
+     */
     onSubmit?(event: {
         type: 'form';
         origin: any;
         value: any;
     }): void;
+    /**
+     * @description.en Triggered when the form is reset
+     * @description.zh 表单重置时会触发
+     * @default null
+     */
     onReset?(event: {
         type: 'form';
         origin: any;