@ray-js/components 0.3.31 → 0.4.2

package/lib/ScrollView/props.d.ts

@@ -3,23 +3,78 @@ import { NativeScrollEvent, NativeSyntheticEvent } from 'react-native';
 import { GenericEvent as WxScrollEvent } from '@remax/wechat';
 export interface ScrollViewProps extends BaseProps {
     /** (default: false) 允许横向滚动 1.0.0 */
+    /**
+     * @description.en Allow horizontal scrolling
+     * @description.zh 允许横向滚动
+     * @default false
+     */
     scrollX?: boolean;
     /** (default: false) 允许纵向滚动 1.0.0 */
+    /**
+     * @description.en Allow longitudinal roll
+     * @description.zh 允许纵向滚动
+     * @default false
+     */
     scrollY?: boolean;
     /** 设置竖向滚动条位置 1.0.0 */
+    /**
+     * @description.en Sets the vertical scroll bar position
+     * @description.zh 设置竖向滚动条位置
+     * @default undefined
+     */
     scrollTop?: number;
     /** 设置横向滚动条位置 1.0.0 */
+    /**
+     * @description.en Sets the horizontal scroll bar position
+     * @description.zh 设置横向滚动条位置
+     * @default undefined
+     */
     scrollLeft?: number;
-    /** (default: 50) 距顶部/左边多远时，触发 onScrollToUpper 事件 1.0.0 */
+    /** (default: 50)  */
+    /**
+     * @description.en How far from the top/left is the on Scroll To Upper event 1.0.0 triggered
+     * @description.zh 距顶部/左边多远时，触发 onScrollToUpper 事件 1.0.0
+     * @default 50
+     */
     upperThreshold?: number;
     /** (default: 50) 距底部/右边多远时，触发 onScrollToLower 事件 1.0.0 */
+    /**
+     * @description.en The on Scroll To Lower event 1.0.0 is triggered when it is far from the bottom/right
+     * @description.zh 距底部/右边多远时，触发 onScrollToLower 事件 1.0.0
+     * @default 50
+     */
     lowerThreshold?: number;
     /** (default: false) 在设置滚动条位置时使用动画过渡 1.0.0 */
+    /**
+     * @description.en Animate transition 1.0.0 when setting the scrollbar position
+     * @description.zh 在设置滚动条位置时使用动画过渡 1.0.0
+     * @default false
+     */
     scrollWithAnimation?: boolean;
     /** 滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY} 1.0.0 */
+    /**
+     * @description.en onScroll
+     * @description.zh 滚动时触发
+     * @default undefined
+     */
     onScroll?: (event: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: 'scroll';
+        /**
+         * @description.en Horizontal scroll bar position
+         * @description.zh 横向滚动条位置
+         * @default undefined
+         */
         scrollLeft: number;
+        /**
+         * @description.en Vertical scroll bar position
+         * @description.zh 竖向滚动条位置
+         * @default undefined
+         */
         scrollTop: number;
         scrollHeight: number;
         scrollWidth: number;
@@ -27,14 +82,32 @@ export interface ScrollViewProps extends BaseProps {
         deltaY: number;
         origin: NativeSyntheticEvent<NativeScrollEvent> | WxScrollEvent;
     }) => any;
-    /** 滚动到顶部/左边时触发 1.0.0 */
+    /**
+     * @description.en Trigger 1.0.0 when scrolling to the top/left
+     * @description.zh 滚动到顶部/左边时触发 1.0.0
+     * @default undefined
+     */
     onScrollToUpper?: (event: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: 'scrolltoupper';
         direction: 'top' | 'left';
         origin: NativeSyntheticEvent<NativeScrollEvent> | WxScrollEvent | Event;
     }) => any;
-    /** 滚动到底部/右边时触发 1.0.0 */
+    /**
+     * @description.en Triggered when scrolling to the bottom/right
+     * @description.zh 滚动到底部/右边时触发
+     * @default undefined
+     */
     onScrollToLower?: (event: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: 'scrolltolower';
         direction: 'bottom' | 'right';
         origin: NativeSyntheticEvent<NativeScrollEvent> | WxScrollEvent | Event;

package/lib/Slider/props.d.ts

@@ -1,22 +1,102 @@
 import { BaseProps } from '../types';
 export interface SliderProps extends BaseProps {
+    /**
+     * @description.en min
+     * @description.zh 最小值
+     * @default 0
+     */
     min?: number;
+    /**
+     * @description.en max
+     * @description.zh 最大值
+     * @default 100
+     */
     max?: number;
+    /**
+     * @description.en The value must be greater than 0 and divisible by (max-min)
+     * @description.zh 步长，取值必须大于 0，并且可被(max - min)整除
+     * @default 1
+     */
     step?: number;
+    /**
+     * @description.en disabled
+     * @description.zh 是否禁用
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * @description.en value
+     * @description.zh 当前取值
+     * @default 0
+     */
     value?: number;
+    /**
+     * @description.en activeColor
+     * @description.zh 已选择的颜色
+     * @default #007aff
+     */
     activeColor?: string;
+    /**
+     * @description.en backgroundColor
+     * @description.zh 背景条的颜色
+     * @default rgba(0,0,0,.2)
+     */
     backgroundColor?: string;
+    /**
+     * @description.en blockSize
+     * @description.zh 滑块的大小，取值范围为 12 - 28
+     * @default 28
+     */
     blockSize?: number;
+    /**
+     * @description.en blockColor
+     * @description.zh 滑块的颜色
+     * @default #ffffff
+     */
     blockColor?: string;
+    /**
+     * @description.en showValue
+     * @description.zh 是否显示当前 value
+     * @default false
+     */
     showValue?: boolean;
+    /**
+     * @description.en onChange
+     * @description.zh 完成一次拖动后触发的事件，event.detail = {value}
+     * @default undefined
+     */
     onChange?: (event: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: string;
+        /**
+         * @description.en value
+         * @description.zh value
+         * @default undefined
+         */
         value: number;
         origin: any;
     }) => void;
+    /**
+     * @description.en onChanging
+     * @description.zh 拖动过程中触发的事件，event.detail = {value}
+     * @default undefined
+     */
     onChanging?: (event: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: string;
+        /**
+         * @description.en value
+         * @description.zh 价值
+         * @default undefined
+         */
         value: number;
         origin: any;
     }) => void;

package/lib/Swiper/props.d.ts

@@ -2,23 +2,59 @@ import * as React from 'react';
 import { BaseProps } from '../types';
 import { GenericEvent as WxEvent } from '@remax/wechat';
 export declare type SwiperProps<I> = BaseProps & {
-    /** (default: false) 是否显示面板指示点 */
+    /**
+     * @description.en Whether to display panel points
+     * @description.zh 是否显示面板指示点
+     * @default false
+     */
     dots?: boolean;
-    /** (default: rgba(0, 0, 0, .3)) 指示点颜色 */
+    /**
+     * @description.en Indicator point color
+     * @description.zh 指示点颜色
+     * @default rgba(0, 0, 0, .3)
+     */
     dotColor?: string;
-    /** (default: #000000) 当前选中的指示点颜色 */
+    /**
+     * @description.en The color of the currently selected indicator point
+     * @description.zh 当前选中的指示点颜色
+     * @default #000000
+     */
     dotActiveColor?: string;
-    /** (default: false) 是否自动切换 */
+    /**
+     * @description.en Automatic switch or not
+     * @description.zh 是否自动切换
+     * @default false
+     */
     autoplay?: boolean;
-    /** (default: 0) 当前所在滑块的 index */
+    /**
+     * @description.en Index of the current slider
+     * @description.zh 当前所在滑块的 index
+     * @default 0
+     */
     current?: number;
-    /** (default: 5000) 自动切换时间间隔 */
+    /**
+     * @description.en Automatically switch the time interval
+     * @description.zh 自动切换时间间隔
+     * @default 5000
+     */
     interval?: number;
-    /** (default: 500) 滑动动画时长 */
+    /**
+     * @description.en Sliding animation duration
+     * @description.zh 滑动动画时长
+     * @default 500
+     */
     duration?: number;
-    /** (default: false) 是否采用衔接滑动 */
+    /**
+     * @description.en Whether to use cohesive sliding
+     * @description.zh 是否采用衔接滑动
+     * @default false
+     */
     circular?: boolean;
-    /** (default: false) 滑动方向是否为纵向 */
+    /**
+     * @description.en Whether the sliding direction is longitudinal
+     * @description.zh 滑动方向是否为纵向
+     * @default false
+     */
     vertical?: boolean;
     /** 前边距，可用于露出前一项的一小部分 */
     /** 后边距，可用于露出后一项的一小部分 */

package/lib/Switch/props.d.ts

@@ -2,15 +2,55 @@
 import { StyleProp, ViewStyle } from 'react-native';
 import { BaseProps } from '../types';
 export interface SwitchProps extends BaseProps {
+    /**
+     * @description.en onChange
+     * @description.zh checked 改变时触发 change 事件，event.detail={ value}
+     * @default undefined
+     */
     onChange?: (event: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: 'change';
+        /**
+         * @description.en value
+         * @description.zh 价值
+         * @default undefined
+         */
         value: boolean;
         origin: any;
     }) => void;
+    /**
+     * @description.en checked
+     * @description.zh 当前是否选中
+     * @default false
+     */
     checked?: boolean;
+    /**
+     * @description.en disabled
+     * @description.zh 是否禁用
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * @description.en color
+     * @description.zh Switch 的颜色，同 css 的 color
+     * @default #007AFF
+     */
     color?: string;
+    /**
+     * @description.en type
+     * @description.zh 可选值 switch checkbox
+     * @default switch
+     */
     type?: 'switch' | 'checkbox';
+    /**
+     * @description.en style
+     * @description.zh 风格
+     * @default undefined
+     */
     style?: React.CSSProperties | StyleProp<ViewStyle>;
 }
 export declare const defaultSwitchProps: {

package/lib/Text/props.d.ts

@@ -1,10 +1,24 @@
 /// <reference types="react" />
 import { BaseProps } from '../types';
 export interface TextProps extends BaseProps {
-    /** 文本是否可选 */
+    /**
+     * @description.en selectable
+     * @description.zh 文本是否可选
+     * @default false
+     */
     selectable?: boolean;
     children?: React.ReactNode;
+    /**
+     * @description.en onClick
+     * @description.zh 点击事件
+     * @default false
+     */
     onClick?: (event: {
+        /**
+         * @description.en type
+         * @description.zh 类型
+         * @default undefined
+         */
         type: string;
         timeStamp: number;
         pageX: number;

package/lib/Textarea/index.md

@@ -17,7 +17,7 @@ group:
 ## 导入
 
 ```js
-import { Textarea } from '@ray-js/components';
+import { Textarea } from '@ray-js/components'
 ```
 
 ## 代码演示

package/lib/Textarea/props.d.ts

@@ -4,18 +4,76 @@ export declare type TextareaEvent = FormEvent<{
     value: string;
 }>;
 export interface TextareaProps extends BaseProps {
+    /**
+     * @description.en id
+     * @description.zh 组件的 id
+     * @default null
+     */
     name?: string;
+    /**
+     * @description.en content
+     * @description.zh 输入框的内容
+     * @default null
+     */
     value?: string;
+    /**
+     * @description.en Placeholder when the input box is empty
+     * @description.zh 输入框为空时占位符
+     * @default null
+     */
     placeholder?: string;
+    /**
+     * @description.en Specify placeholder styles that currently only support Color,font Size, and font Weight
+     * @description.zh 指定 placeholder 的样式，目前仅支持 color,fontSize 和 fontWeight
+     * @default null
+     */
     placeholderStyle?: React.CSSProperties;
+    /**
+     * @description.en If the Account is Disabled
+     * @description.zh 是否禁用
+     * @default null
+     */
     disabled?: boolean;
-    /** 最大输入长度，设置为 -1 的时候不限制最大长度 */
+    /**
+     * @description.en Maximum length. If the value is set to -1, the maximum length is not limited
+     * @description.zh 最大输入长度，设置为 -1 的时候不限制最大长度
+     * @default null
+     */
     maxLength?: number;
+    /**
+     * @description.en Get focus
+     * @description.zh 获取焦点
+     * @default null
+     */
     focus?: boolean;
-    /** 是否自动增高，设置auto-height时，style.height不生效 */
+    /**
+     * @description.en Automatic increase or not
+     * @description.zh 是否自动增高
+     * @default null
+     */
     autoHeight?: boolean;
+    /**
+     * @description.en Triggered when the keyboard is typed
+     * @description.zh 当键盘输入时，触发
+     * @default null
+     */
     onInput?: (event: TextareaEvent) => any;
+    /**
+     * @description.en Triggered when the input box is in focus
+     * @description.zh 输入框聚焦时触发
+     * @default null
+     */
     onFocus?: (event: any) => void;
+    /**
+     * @description.en Triggered when the input box loses focus
+     * @description.zh 输入框失去焦点时触发
+     * @default null
+     */
     onBlur?: (event: any) => void;
+    /**
+     * @description.en Click Finish when triggered
+     * @description.zh 点击完成时， 触发
+     * @default null
+     */
     onConfirm?: (event: any) => void;
 }

package/lib/TimePicker/index.md

@@ -18,6 +18,8 @@ import { TimePicker } from '@ray-js/components'
 
 ## 代码演示
 
+> picker 相关组件效果请使用手机模式下查看
+
 <code src="./demos/basic.tsx" title="基本用法" background="#f2f4f6" />
 <code src="./demos/startend.tsx" title="起止时间" background="#f2f4f6" />
 

package/lib/TimePicker/props.d.ts

@@ -1,25 +1,78 @@
-/// <reference types="react" />
 import { BaseProps } from '../types';
 import { TouchEventHandler } from '@ray-js/framework-shared';
 declare type ChangeEvent = (e: {
+    /**
+     * @description.en type
+     * @description.zh 类型
+     * @default undefined
+     */
     type: string;
+    /**
+     * @description.en value
+     * @description.zh 价值
+     * @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 TimePickerProps extends BaseProps, TouchEventHandler {
+    /**
+     * @description.en disabled
+     * @description.zh 是否禁用
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * @description.en value
+     * @description.zh 当前选择的时间
+     * @default undefined
+     */
     value?: string;
+    /**
+     * @description.en start
+     * @description.zh 表示有效时间范围的开始，字符串格式为"hh:mm"
+     * @default undefined
+     */
     start?: string;
+    /**
+     * @description.en end
+     * @description.zh 表示有效时间范围的结束，字符串格式为"hh:mm"
+     * @default undefined
+     */
     end?: string;
+    /**
+     * @description.en onCancel
+     * @description.zh 取消选择时触发
+     * @default undefined
+     */
     onCancel?: CancelEvent;
+    /**
+     * @description.en onChange
+     * @description.zh 选择时触发
+     * @default undefined
+     */
     onChange?: ChangeEvent;
+    /**
+     * @description.en confirmText
+     * @description.zh 确认文本
+     * @default 确认
+     */
     confirmText?: string;
+    /**
+     * @description.en cancelText
+     * @description.zh 取消文本
+     * @default 取消
+     */
     cancelText?: string;
-    children?: React.ReactNode | string;
 }
 export declare const IDefaultTimePickerProps: {
     cancelText: string;

package/lib/View/props.d.ts

@@ -2,9 +2,29 @@ import * as React from 'react';
 import { ViewProps as ViewBaseProps, StyleProp } from 'react-native';
 import { BaseProps } from '../types';
 export interface ViewProps extends BaseProps {
+    /**
+     * @description.en hoverClassName
+     * @description.zh hover 样式
+     * @default undefined
+     */
     hoverClassName?: string;
+    /**
+     * @description.en hoverStyle
+     * @description.zh hover 样式名
+     * @default undefined
+     */
     hoverStyle?: StyleProp<ViewBaseProps>;
+    /**
+     * @description.en How long after the click appears in ms
+     * @description.zh 按住后多久出现点击态 单位 ms
+     * @default 20
+     */
     hoverStartTime?: number;
+    /**
+     * @description.en Click retention time ms after finger release
+     * @description.zh 手指松开后点击态保留时间 ms
+     * @default 70
+     */
     hoverStayTime?: number;
     children?: React.ReactNode | string;
 }

package/lib/types/index.d.ts

@@ -1,15 +1,42 @@
 import * as React from 'react';
 export interface BaseProps {
+    /**
+     * @description.en id
+     * @description.zh ID
+     * @default undefined
+     */
     id?: string;
+    /**
+     * @description.en className
+     * @description.zh css 类名
+     * @default undefined
+     */
     className?: string;
+    /**
+     * @description.en style
+     * @description.zh 样式
+     * @default undefined
+     */
     style?: React.CSSProperties;
 }
 export interface HoverableProps {
-    /** 指定按钮按下去的样式类。当 hover-class="none" 时，没有点击态效果 */
+    /**
+     * @description.en Specifies the style class on which the button is pressed. Hover -class=" None ", no click effect
+     * @description.zh 指定按钮按下去的样式类。当 hover-class="none" 时，没有点击态效果
+     * @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;
 }
 interface TouchObj {
@@ -27,11 +54,41 @@ interface TouchEvent {
  * 多端通用事件
  */
 export interface TouchEventHandler {
+    /**
+     * @description.en onClick
+     * @description.zh 点击回调
+     * @default undefined
+     */
     onClick?: (e: TouchEvent) => any;
+    /**
+     * @description.en Long press the trigger
+     * @description.zh 长按触发
+     * @default undefined
+     */
     onLongClick?: (e: TouchEvent) => any;
+    /**
+     * @description.en onTouchStart
+     * @description.zh 开始触摸事件回调
+     * @default undefined
+     */
     onTouchStart?: (e: TouchEvent) => any;
+    /**
+     * @description.en onTouchMove
+     * @description.zh 触摸移动事件回调
+     * @default undefined
+     */
     onTouchMove?: (e: TouchEvent) => any;
+    /**
+     * @description.en onTouchEnd
+     * @description.zh 触摸结束事件回调
+     * @default undefined
+     */
     onTouchEnd?: (e: TouchEvent) => any;
+    /**
+     * @description.en onTouchCancel
+     * @description.zh 触摸取消事件回调
+     * @default undefined
+     */
     onTouchCancel?: (e: TouchEvent) => any;
 }
 /**