@ray-js/adapter 1.7.79 → 1.7.80

package/cjs/hostComponents/NativeVideo/index.d.ts

@@ -1,38 +1,196 @@
 import * as React from 'react';
-import { BaseProps, DiffLayer } from '../../types/component.js';
+import { BaseEvent, BaseProps, DiffLayer } from '../../types/component';
+/** 视频播放进度事件数据 */
+export interface NativeVideoTimeUpdateDetail {
+    /** 当前播放进度，单位秒 */
+    currentTime: number;
+    /** 视频总时长，单位秒 */
+    duration: number;
+}
+/** 视频播放进度变化事件对象 */
+export interface NativeVideoTimeUpdateEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'timeupdate';
+    /** 事件数据 */
+    detail: NativeVideoTimeUpdateDetail;
+}
+/** 视频全屏状态变化事件数据 */
+export interface NativeVideoFullscreenChangeDetail {
+    /** 是否全屏 */
+    fullScreen: boolean;
+    /** 方向，有效值为 vertical 或 horizontal */
+    direction?: 'vertical' | 'horizontal';
+}
+/** 视频全屏状态变化事件对象 */
+export interface NativeVideoFullscreenChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'fullscreenchange';
+    /** 事件数据 */
+    detail: NativeVideoFullscreenChangeDetail;
+}
+/** 视频加载进度事件数据 */
+export interface NativeVideoProgressDetail {
+    /** 缓冲进度百分比 */
+    buffered: number;
+}
+/** 视频加载进度事件对象 */
+export interface NativeVideoProgressEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'progress';
+    /** 事件数据 */
+    detail: NativeVideoProgressDetail;
+}
+/** 视频元数据加载完成事件数据 */
+export interface NativeVideoLoadedMetadataDetail {
+    /** 视频宽度 */
+    width: number;
+    /** 视频高度 */
+    height: number;
+    /** 视频时长 */
+    duration: number;
+}
+/** 视频元数据加载完成事件对象 */
+export interface NativeVideoLoadedMetadataEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'loadedmetadata';
+    /** 事件数据 */
+    detail: NativeVideoLoadedMetadataDetail;
+}
+/** 控件显示切换事件数据 */
+export interface NativeVideoControlsToggleDetail {
+    /** 是否显示控件 */
+    show: boolean;
+}
+/** 控件显示切换事件对象 */
+export interface NativeVideoControlsToggleEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'controlstoggle';
+    /** 事件数据 */
+    detail: NativeVideoControlsToggleDetail;
+}
+/** 视频播放错误事件数据 */
+export interface NativeVideoErrorDetail {
+    /** 错误信息 */
+    errMsg?: string;
+}
+/** 视频播放错误事件对象 */
+export interface NativeVideoErrorEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'error';
+    /** 事件数据 */
+    detail: NativeVideoErrorDetail;
+}
+/** seek 完成事件数据（position 在 iOS 上单位为秒，Android 上为毫秒） */
+export interface NativeVideoSeekCompleteDetail {
+    /** 跳转后的播放位置 */
+    position: number;
+}
+/** seek 完成事件对象 */
+export interface NativeVideoSeekCompleteEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'seekcomplete';
+    /** 事件数据 */
+    detail: NativeVideoSeekCompleteDetail;
+}
+/**
+ * 原生视频播放组件。
+ *
+ * @public
+ * @alias NativeVideo
+ * @since @ray-js/ray 0.6.9
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide
+ * @example 播放配置与封面 ./demos/play-config-poster/index.tsx sandbox ide
+ * @example 自定义边框与事件 ./demos/custom-border-events/index.tsx sandbox ide
+ */
 export interface NativeVideoProps extends BaseProps, DiffLayer {
+    /** 要播放视频的资源地址，支持网络路径；注意分区部署情况下视频是否支持访问 */
     src: string;
+    /** 指定视频时长，单位秒 */
     duration?: number;
+    /** 是否显示默认播放控件（播放/暂停按钮、播放进度、时间） */
     controls?: boolean;
+    /** 是否自动播放 */
     autoplay?: boolean;
+    /** 是否循环播放 */
     loop?: boolean;
+    /** 是否静音播放 */
     muted?: boolean;
+    /** 指定视频初始播放位置 */
     initialTime?: number;
+    /** 是否显示全屏按钮 */
     showFullscreenBtn?: boolean;
+    /** 是否显示视频底部控制栏的播放按钮 */
     showPlayBtn?: boolean;
+    /** 是否显示视频中间的播放按钮 */
     showCenterPlayBtn?: boolean;
-    objectFit?: string;
+    /** 当视频大小与 video 容器大小不一致时，视频的表现形式 */
+    objectFit?: 'contain' | 'fill' | 'cover' | 'none';
+    /** 视频封面图资源地址 */
     poster?: string;
+    /** 是否显示静音按钮 */
     showMuteBtn?: boolean;
+    /** 边框的宽度，单位 px */
     borderWidth?: number;
-    borderStyle?: string;
+    /** 边框的样式，可选值 solid 和 dashed */
+    borderStyle?: 'solid' | 'dashed';
+    /** 边框的颜色，必须为十六进制格式 */
     borderColor?: string;
+    /** 边框的圆角，单位 px */
     borderRadius?: number;
+    /** 边框的左上角圆角大小，单位 px */
     borderRadiusTopLeft?: number;
+    /** 边框的右上角圆角大小，单位 px */
     borderRadiusTopRight?: number;
+    /** 边框的左下角圆角大小，单位 px */
     borderRadiusBottomLeft?: number;
+    /** 边框的右下角圆角大小，单位 px */
     borderRadiusBottomRight?: number;
+    /** 背景颜色，必须为十六进制格式 */
     backgroundColor?: string;
-    onPlay?: (event: any) => void;
-    onPause?: (event: any) => void;
-    onEnded?: (event: any) => void;
-    onTimeupdate?: (event: any) => void;
-    onFullscreenchange?: (event: any) => void;
-    onWaiting?: (event: any) => void;
-    onError?: (event: any) => void;
-    onProgress?: (event: any) => void;
-    onLoadedmetadata?: (event: any) => void;
-    onControlstoggle?: (event: any) => void;
-    onSeekcomplete?: (event: any) => void;
+    /** 当开始/继续播放时触发 */
+    onPlay?: (event: BaseEvent) => void;
+    /** 当暂停播放时触发 */
+    onPause?: (event: BaseEvent) => void;
+    /** 当播放到末尾时触发 */
+    onEnded?: (event: BaseEvent) => void;
+    /** 播放进度变化时触发 */
+    onTimeupdate?: (event: NativeVideoTimeUpdateEvent) => void;
+    /** 视频进入和退出全屏时触发 */
+    onFullscreenchange?: (event: NativeVideoFullscreenChangeEvent) => void;
+    /** 视频出现缓冲时触发 */
+    onWaiting?: (event: BaseEvent) => void;
+    /** 视频播放出错时触发 */
+    onError?: (event: NativeVideoErrorEvent) => void;
+    /** 加载进度变化时触发，只支持一段加载 */
+    onProgress?: (event: NativeVideoProgressEvent) => void;
+    /** 视频元数据加载完成时触发 */
+    onLoadedmetadata?: (event: NativeVideoLoadedMetadataEvent) => void;
+    /** 切换 controls 显示隐藏时触发 */
+    onControlstoggle?: (event: NativeVideoControlsToggleEvent) => void;
+    /** seek 完成时触发 */
+    onSeekcomplete?: (event: NativeVideoSeekCompleteEvent) => void;
 }
 export declare const NativeVideo: React.ComponentType<NativeVideoProps>;
+/**
+ * NativeVideo 组件默认值
+ *
+ * @belong NativeVideo
+ * @defaults
+ */
+export declare const nativeVideoDefaultProps: {
+    controls: boolean;
+    autoplay: boolean;
+    loop: boolean;
+    muted: boolean;
+    initialTime: number;
+    showFullscreenBtn: boolean;
+    showPlayBtn: boolean;
+    showCenterPlayBtn: boolean;
+    objectFit: string;
+    showMuteBtn: boolean;
+    borderWidth: number;
+    borderStyle: string;
+    borderColor: string;
+    borderRadius: number;
+    backgroundColor: string;
+};

package/cjs/hostComponents/NativeVideo/index.js

@@ -3,9 +3,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NativeVideo = void 0;
+exports.nativeVideoDefaultProps = exports.NativeVideo = void 0;
 const createHostComponent_js_1 = __importDefault(require("../createHostComponent.js"));
 exports.NativeVideo = (0, createHostComponent_js_1.default)('native-video');
+/**
+ * NativeVideo 组件默认值
+ *
+ * @belong NativeVideo
+ * @defaults
+ */
+exports.nativeVideoDefaultProps = {
+    controls: true,
+    autoplay: false,
+    loop: false,
+    muted: false,
+    initialTime: 0,
+    showFullscreenBtn: true,
+    showPlayBtn: true,
+    showCenterPlayBtn: true,
+    objectFit: 'contain',
+    showMuteBtn: false,
+    borderWidth: 0,
+    borderStyle: 'solid',
+    borderColor: '#ffffff',
+    borderRadius: 0,
+    backgroundColor: '#ffffff',
+};
 exports.NativeVideo.defaultProps = {
     controls: true,
     autoplay: false,

package/cjs/hostComponents/Navigator/index.d.ts

@@ -1,38 +1,142 @@
 import * as React from 'react';
-import { BaseProps, GenericEvent } from '../../types/component.js';
+import { BaseEvent, BaseProps } from '../../types/component';
+/** 跳转小程序回调事件数据 */
+export interface NavigatorMiniProgramResultDetail {
+    /** 调用结果信息 */
+    errMsg?: string;
+}
+/** 跳转小程序成功事件对象 */
+export interface NavigatorSuccessEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'success';
+    /** 事件数据 */
+    detail: NavigatorMiniProgramResultDetail;
+}
+/** 跳转小程序失败事件对象 */
+export interface NavigatorFailEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'fail';
+    /** 事件数据 */
+    detail: NavigatorMiniProgramResultDetail;
+}
+/** 跳转小程序结束事件对象（成功或失败之后都会触发） */
+export interface NavigatorCompleteEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'complete';
+    /** 事件数据 */
+    detail: NavigatorMiniProgramResultDetail;
+}
+/**
+ * 页面链接
+ *
+ * @internal
+ * @alias Navigator
+ */
 export interface NavigatorProps extends BaseProps {
-    /** (default: self) 在哪个目标上发生跳转，默认当前小程序 2.0.7 */
+    /**
+     * 在哪个目标上发生跳转，默认当前小程序
+     *
+     * @since 2.0.7
+     */
     target?: 'self' | 'miniProgram';
-    /** 当前小程序内的跳转链接 1.0.0 */
+    /**
+     * 当前小程序内的跳转链接
+     *
+     * @since 1.0.0
+     */
     url?: string;
-    /** (default: navigate) 跳转方式 1.0.0 */
+    /**
+     * 跳转方式
+     *
+     * @since 1.0.0
+     */
     openType?: 'navigate' | 'redirect' | 'switchTab' | 'reLaunch' | 'navigateBack' | 'exit';
-    /** (default: 1) 当 open-type 为 'navigateBack' 时有效，表示回退的层数 1.0.0 */
+    /**
+     * 当 open-type 为 navigateBack 时有效，表示回退的层数
+     *
+     * @since 1.0.0
+     */
     delta?: number;
-    /** 当target="miniProgram"时有效，要打开的小程序 appId 2.0.7 */
+    /**
+     * 当 target 为 miniProgram 时有效，要打开的小程序 appId
+     *
+     * @since 2.0.7
+     */
     appId?: string;
-    /** 当target="miniProgram"时有效，打开的页面路径，如果为空则打开首页 2.0.7 */
+    /**
+     * 当 target 为 miniProgram 时有效，打开的页面路径，如果为空则打开首页
+     *
+     * @since 2.0.7
+     */
     path?: string;
-    /** 当target="miniProgram"时有效，需要传递给目标小程序的数据，目标小程序可在 App.onLaunch()，App.onShow() 中获取到这份数据。详情 2.0.7 */
-    extraData?: any;
-    /** (default: release) 当target="miniProgram"时有效，要打开的小程序版本 2.0.7 */
+    /**
+     * 当 target 为 miniProgram 时有效，需要传递给目标小程序的数据
+     *
+     * @since 2.0.7
+     */
+    extraData?: Record<string, unknown>;
+    /**
+     * 当 target 为 miniProgram 时有效，要打开的小程序版本
+     *
+     * @since 2.0.7
+     */
     version?: 'develop' | 'trial' | 'release';
-    /** (default: navigator-hover) 指定点击时的样式类，当hover-class="none"时，没有点击态效果 1.0.0 */
+    /**
+     * 指定点击时的样式类，当 hover-class 为 none 时，没有点击态效果
+     *
+     * @since 1.0.0
+     */
     hoverClassName?: string;
-    /** (default: false) 指定是否阻止本节点的祖先节点出现点击态 1.5.0 */
+    /**
+     * 指定是否阻止本节点的祖先节点出现点击态
+     *
+     * @since 1.5.0
+     */
     hoverStopPropagation?: boolean;
-    /** (default: 50) 按住后多久出现点击态，单位毫秒 1.0.0 */
+    /**
+     * 按住后多久出现点击态，单位毫秒
+     *
+     * @since 1.0.0
+     */
     hoverStartTime?: number;
-    /** (default: 600) 手指松开后点击态保留时间，单位毫秒 1.0.0 */
+    /**
+     * 手指松开后点击态保留时间，单位毫秒
+     *
+     * @since 1.0.0
+     */
     hoverStayTime?: number;
-    /** 当target="miniProgram"时有效，跳转小程序成功 2.0.7 */
-    onSuccess?: (event: GenericEvent) => any;
-    /** 当target="miniProgram"时有效，跳转小程序失败 2.0.7 */
-    onFail?: (event: GenericEvent) => any;
-    /** 当target="miniProgram"时有效，跳转小程序完成 2.0.7 */
-    onComplete?: (event: GenericEvent) => any;
+    /**
+     * 当 target 为 miniProgram 时有效，跳转小程序成功
+     *
+     * @since 2.0.7
+     */
+    onSuccess?: (event: NavigatorSuccessEvent) => void;
+    /**
+     * 当 target 为 miniProgram 时有效，跳转小程序失败
+     *
+     * @since 2.0.7
+     */
+    onFail?: (event: NavigatorFailEvent) => void;
+    /**
+     * 当 target 为 miniProgram 时有效，跳转小程序完成
+     *
+     * @since 2.0.7
+     */
+    onComplete?: (event: NavigatorCompleteEvent) => void;
 }
+export declare const Navigator: React.ComponentType<NavigatorProps>;
 /**
- * https://developers.weixin.qq.com/miniprogram/dev/component/navigator.html
+ * Navigator 组件默认值
+ *
+ * @belong Navigator
+ * @defaults
  */
-export declare const Navigator: React.ComponentType<NavigatorProps>;
+export declare const navigatorDefaultProps: {
+    target: string;
+    openType: string;
+    delta: number;
+    hoverClassName: string;
+    hoverStopPropagation: boolean;
+    hoverStartTime: number;
+    hoverStayTime: number;
+};

package/cjs/hostComponents/Navigator/index.js

@@ -3,12 +3,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Navigator = void 0;
-const createHostComponent_js_1 = __importDefault(require("../createHostComponent.js"));
+exports.navigatorDefaultProps = exports.Navigator = void 0;
+const createHostComponent_1 = __importDefault(require("../createHostComponent"));
+exports.Navigator = (0, createHostComponent_1.default)('navigator');
 /**
- * https://developers.weixin.qq.com/miniprogram/dev/component/navigator.html
+ * Navigator 组件默认值
+ *
+ * @belong Navigator
+ * @defaults
  */
-exports.Navigator = (0, createHostComponent_js_1.default)('navigator');
+exports.navigatorDefaultProps = {
+    target: 'self',
+    openType: 'navigate',
+    delta: 1,
+    hoverClassName: 'navigator-hover',
+    hoverStopPropagation: false,
+    hoverStartTime: 50,
+    hoverStayTime: 600,
+};
 exports.Navigator.defaultProps = {
     target: 'self',
     openType: 'navigate',

package/cjs/hostComponents/Picker/index.d.ts

@@ -1,68 +1,123 @@
 import * as React from 'react';
-import { BaseProps, GenericEvent } from '../../types/component.js';
+import { BaseEvent, BaseProps } from '../../types/component';
+/** picker change 事件数据 */
+export interface PickerChangeDetail {
+    /** 当前选中的值 */
+    value: number | number[] | string | string[];
+}
+/** picker change 事件对象 */
+export interface PickerChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'change';
+    /** 事件数据 */
+    detail: PickerChangeDetail;
+    /** 当前选中的值 */
+    value: number | number[] | string | string[];
+}
+/** picker cancel 事件数据 */
+export interface PickerCancelDetail {
+    [key: string]: unknown;
+}
+/** picker cancel 事件对象 */
+export interface PickerCancelEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'cancel';
+    /** 事件数据 */
+    detail: PickerCancelDetail;
+}
+/** picker columnchange 事件数据 */
+export interface PickerColumnChangeDetail {
+    /** 变更的列序号 */
+    column: number;
+    /** 变更的列当前值 */
+    value: number;
+}
+/** picker columnchange 事件对象 */
+export interface PickerColumnChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'columnchange';
+    /** 事件数据 */
+    detail: PickerColumnChangeDetail;
+}
+/**
+ * 从底部弹起的滚动选择器，支持普通、多列、时间与日期四种模式。
+ *
+ * @public
+ * @alias Picker
+ * @since @ray-js/ray 0.5.10
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide e2e
+ *
+ * @example 时间选择器 ./demos/time-picker/index.tsx sandbox ide e2e
+ * @example 日期选择器 ./demos/date-picker/index.tsx sandbox ide e2e
+ * @example 多列选择器 ./demos/multi-column-picker/index.tsx sandbox ide e2e
+ */
 export interface PickerProps extends BaseProps {
+    /** 表单控件名称，提交表单时作为键名 */
     name?: string;
     /**
      * 选择器类型
      *
-     * selector	普通选择器
-     * multiSelector	多列选择器
-     * time	时间选择器
-     * date	日期选择器
-     * region	省市区选择器
-     */
-    mode?: 'selector' | 'multiSelector' | 'time' | 'date' | 'region';
-    /**
-     * 是否禁用
+     * selector：普通选择器；multiSelector：多列选择器；time：时间；date：日期
      */
+    mode?: 'selector' | 'multiSelector' | 'time' | 'date';
+    /** 是否禁用 */
     disabled?: boolean;
+    /** mode 为 selector 或 multiSelector 时有效，为单列或多列数据源 */
+    range?: (string | number | Record<string, unknown>)[] | (string | number | Record<string, unknown>)[][];
     /**
-     * 1.9.90
-     * 取消选择时触发
-     */
-    onCancel?: (event: GenericEvent) => any;
-    onChange?: (event: GenericEvent<{
-        value: any;
-    }>) => void;
-    /**
-     * 列改变时触发
-     */
-    onColumnChange?: (event: any) => void;
-    /**
-     * mode 为 selector 或 multiSelector 时，range 有效
+     * 当 range 为对象数组时，指定用于展示文本的对象字段名
      */
-    range?: any[];
+    rangeKey?: string;
     /**
-     * 当 range 是一个 Object Array 时，通过 range-key 来指定 Object 中 key 的值作为选择器显示内容
+     * 选中值：selector 为下标；multiSelector 为下标数组；time/date 为字符串，格式为"hh:mm"/"YYYY-MM-DD"；
      */
-    rangeKey?: string;
-    value?: any;
+    value?: number | number[] | string;
     /**
-     * mode = time
-     * 表示有效时间范围的开始，字符串格式为"hh:mm"
-     *
-     * mode = date
-     * 表示有效日期范围的开始，字符串格式为"YYYY-MM-DD"
+     * mode 为 time 时表示有效时间范围开始，格式 `hh:mm`；mode 为 date 时为 `YYYY-MM-DD`
      */
     start?: string;
     /**
-     * mode = time
-     * 表示有效时间范围的结束，字符串格式为"hh:mm"
-     *
-     * mode = date
-     * 表示有效日期范围的结束，字符串格式为"YYYY-MM-DD"
+     * mode 为 time 时表示有效时间范围结束，格式 `hh:mm`；mode 为 date 时为 `YYYY-MM-DD`
      */
     end?: string;
+    /** mode 为 date 时，粒度：年 / 月 / 日 */
+    fields?: 'year' | 'month' | 'day';
+    /** 取消按钮文案 */
+    cancelText?: string;
+    /** 确定按钮文案 */
+    confirmText?: string;
     /**
-     * 	有效值 year,month,day，表示选择器的粒度
+     * 取消选择时触发
+     *
+     * @since 1.9.90
      */
-    fields?: 'year' | 'month' | 'day';
+    onCancel?: (event: PickerCancelEvent) => void;
+    /** 滚动选择器变更时触发（确定选择后） */
+    onChange?: (event: PickerChangeEvent) => void;
+    /** 多列选择器某一列变更时触发 */
+    onColumnChange?: (event: PickerColumnChangeEvent) => void;
     /**
-     * mode = region
-     * 可为每一列的顶部添加一个自定义的项
+     * 为每一列的顶部添加一个自定义的项
+     * @internal
      */
     customItem?: string;
-    cancelText?: string;
-    confirmText?: string;
 }
 export declare const Picker: React.ComponentType<PickerProps>;
+/**
+ * Picker 组件默认值
+ *
+ * @belong Picker
+ * @defaults
+ */
+export declare const pickerDefaultProps: {
+    mode: string;
+    disabled: boolean;
+    confirmText: string;
+    cancelText: string;
+    range: any[];
+    rangeKey: string;
+    value: string;
+    start: string;
+    end: string;
+    fields: string;
+};

package/cjs/hostComponents/Picker/index.js

@@ -3,9 +3,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Picker = void 0;
+exports.pickerDefaultProps = exports.Picker = void 0;
 const createHostComponent_js_1 = __importDefault(require("../createHostComponent.js"));
 exports.Picker = (0, createHostComponent_js_1.default)('picker');
+/**
+ * Picker 组件默认值
+ *
+ * @belong Picker
+ * @defaults
+ */
+exports.pickerDefaultProps = {
+    mode: 'selector',
+    disabled: false,
+    confirmText: '确定',
+    cancelText: '取消',
+    range: [],
+    rangeKey: '',
+    value: '',
+    start: '',
+    end: '',
+    fields: 'day',
+};
 exports.Picker.defaultProps = {
     mode: 'selector',
     // disabled: false,