@ray-js/adapter 1.7.79 → 1.7.80

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

@@ -1,7 +1,92 @@
 import * as React from 'react';
 import { BaseProps } from '../../types/component.js';
+/**
+ * 滑块视图容器子项，仅可放置在 Swiper 组件中，宽高自动设置为 100%。
+ *
+ * @public
+ * @alias SwiperItem
+ * @since @ray-js/ray 0.5.10
+ * @example 基础用法
+ * ```tsx | sandbox previewTitle="基础用法" ide
+ * import React, { useState } from 'react';
+ * import { Swiper, SwiperItem, View, Text } from '@ray-js/ray';
+ *
+ * export default function BasicSwiperItem() {
+ *   const [current, setCurrent] = useState(0);
+ *   const colors = ['#1890ff', '#52c41a', '#faad14'];
+ *
+ *   return (
+ *     <Swiper
+ *       style={{ width: '702rpx', height: '200rpx' }}
+ *       autoplay
+ *       interval={2500}
+ *       dots
+ *       current={current}
+ *       onChange={(e) => setCurrent(e.current)}
+ *     >
+ *       {colors.map((color, index) => (
+ *         <SwiperItem key={index}>
+ *           <View
+ *             style={{
+ *               width: '100%',
+ *               height: '100%',
+ *               backgroundColor: color,
+ *               display: 'flex',
+ *               alignItems: 'center',
+ *               justifyContent: 'center',
+ *             }}
+ *           >
+ *             <Text style={{ color: '#fff' }}>第 {index + 1} 页</Text>
+ *           </View>
+ *         </SwiperItem>
+ *       ))}
+ *     </Swiper>
+ *   );
+ * }
+ * ```
+ * @example 纵向轮播
+ * ```tsx | sandbox previewTitle="纵向轮播" ide
+ * import React, { useState } from 'react';
+ * import { Swiper, SwiperItem, View, Text } from '@ray-js/ray';
+ *
+ * export default function VerticalSwiper() {
+ *   const [current, setCurrent] = useState(0);
+ *   const items = ['第一屏', '第二屏', '第三屏'];
+ *
+ *   return (
+ *     <Swiper
+ *       style={{ width: '100%', height: '400rpx' }}
+ *       vertical
+ *       dots
+ *       current={current}
+ *       onChange={(e) => setCurrent(e.current)}
+ *     >
+ *       {items.map((label, index) => (
+ *         <SwiperItem key={index}>
+ *           <View
+ *             style={{
+ *               width: '100%',
+ *               height: '100%',
+ *               display: 'flex',
+ *               alignItems: 'center',
+ *               justifyContent: 'center',
+ *               backgroundColor: index % 2 === 0 ? '#e6f7ff' : '#f6ffed',
+ *             }}
+ *           >
+ *             <Text style={{ fontSize: '36rpx' }}>{label}</Text>
+ *           </View>
+ *         </SwiperItem>
+ *       ))}
+ *     </Swiper>
+ *   );
+ * }
+ * ```
+ */
 export interface SwiperItemProps extends BaseProps {
-    /** 该 swiper-item 的标识符 */
+    /**
+     *  该 swiper-item 的标识符
+     * @internal
+     */
     itemId?: string;
 }
 export declare const SwiperItem: React.ComponentType<SwiperItemProps>;

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

@@ -1,50 +1,198 @@
 import * as React from 'react';
-type Danmu = {
+import { BaseEvent, BaseProps } from '../../types/component';
+/** 弹幕项 */
+export interface VideoDanmuItem {
+    /** 弹幕文本 */
     text: string;
-    color: string;
+    /** 弹幕颜色 */
+    color?: string;
+    /** 弹幕出现时间，单位秒 */
     time: number;
-};
-export interface VideoProps {
-    id?: string;
-    className?: string;
-    style?: React.CSSProperties;
+}
+/** 播放进度变化事件详情 */
+export interface VideoTimeupdateDetail {
+    /** 当前播放时间 */
+    currentTime: number;
+    /** 视频总时长 */
+    duration: number;
+}
+/** 播放进度变化事件 */
+export interface VideoTimeupdateEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'timeupdate';
+    detail: VideoTimeupdateDetail;
+}
+/** 加载进度变化事件详情 */
+export interface VideoProgressDetail {
+    /** 缓冲百分比 */
+    buffered: number;
+}
+/** 加载进度变化事件 */
+export interface VideoProgressEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'progress';
+    detail: VideoProgressDetail;
+}
+/** 视频元数据加载完成事件详情 */
+export interface VideoLoadedmetadataDetail {
+    /** 视频宽度 */
+    width: number;
+    /** 视频高度 */
+    height: number;
+    /** 视频时长 */
+    duration: number;
+}
+/** 视频元数据加载完成事件 */
+export interface VideoLoadedmetadataEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'loadedmetadata';
+    detail: VideoLoadedmetadataDetail;
+}
+/** 视频播放错误事件详情 */
+export interface VideoErrorDetail {
+    /** 错误信息 */
+    errMsg: string;
+}
+/** 视频播放错误事件 */
+export interface VideoErrorEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'error';
+    detail: VideoErrorDetail;
+}
+/** seek 完成事件详情 */
+export interface VideoSeekCompleteDetail {
+    /** 播放位置（iOS 单位为秒，Android 为毫秒，具体以端为准） */
+    position?: number;
+}
+/** seek 完成事件 */
+export interface VideoSeekCompleteEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'seekcomplete';
+    detail: VideoSeekCompleteDetail;
+}
+/**
+ * 视频组件，支持播放控件、弹幕与全屏。
+ *
+ * @public
+ * @alias Video
+ * @since @ray-js/ray 1.4.24
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide e2e
+ * @example 播放配置 ./demos/play-config/index.tsx sandbox ide e2e
+ * @example 弹幕与事件 ./demos/danmu-events/index.tsx sandbox ide e2e
+ */
+export interface VideoProps extends BaseProps {
+    /** 要播放视频的资源地址，支持网络路径 */
     src: string;
+    /** 指定视频时长 */
     duration?: number;
+    /** 是否显示默认播放控件（播放/暂停按钮、播放进度、时间） */
     controls?: boolean;
-    danmuList?: Array<Danmu>;
+    /** 弹幕列表 */
+    danmuList?: VideoDanmuItem[];
+    /** 是否显示弹幕按钮，只在初始化时有效，不能动态变更 */
     danmuBtn?: boolean;
+    /** 是否展示弹幕，只在初始化时有效，不能动态变更 */
     enableDanmu?: 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;
-    onPlay?: (event: any) => void;
-    onPause?: (event: any) => void;
-    onEnded?: (event: any) => void;
-    onTimeUpdate?: (event: any) => void;
-    onTimeupdate?: (event: any) => void;
-    onWaiting?: (event: any) => void;
-    onError?: (event: any) => void;
-    onProgress?: (event: any) => void;
-    onLoadedMetadata?: (event: any) => void;
-    onLoadedmetadata?: (event: any) => void;
-    onCanplay?: (event: any) => void;
-    onCanplayThrough?: (event: any) => void;
-    onPlaying?: (event: any) => void;
-    onRateChange?: (event: any) => void;
-    onVolumeChange?: (event: any) => void;
-    onSeekComplete?: (event: any) => void;
-    onSeekcomplete?: (event: any) => void;
     /** 非可视区域是否自动暂停 */
     autoPause?: boolean;
-    /** 指定视频 border-radius */
+    /**
+     * 指定视频圆角半径（px）
+     * @internal
+     */
     borderRadius?: number;
+    /** 当开始/继续播放时触发 */
+    onPlay?: (event: BaseEvent) => void;
+    /** 当暂停播放时触发 */
+    onPause?: (event: BaseEvent) => void;
+    /** 当播放到末尾时触发 */
+    onEnded?: (event: BaseEvent) => void;
+    /**
+     * 播放进度变化时触发
+     * @internal
+     * @deprecated 请使用 onTimeupdate
+     */
+    onTimeUpdate?: (event: VideoTimeupdateEvent) => void;
+    /**
+     * 播放进度变化时触发
+     * @internal
+     * @deprecated 请使用 onTimeupdate
+     */
+    onTimeupdate?: (event: VideoTimeupdateEvent) => void;
+    /** 视频出现缓冲时触发 */
+    onWaiting?: (event: BaseEvent) => void;
+    /** 视频播放出错时触发 */
+    onError?: (event: VideoErrorEvent) => void;
+    /** 加载进度变化时触发，只支持一段加载 */
+    onProgress?: (event: VideoProgressEvent) => void;
+    /**
+     * 视频元数据加载完成时触发
+     * @internal
+     * @deprecated 请使用 onLoadedmetadata
+     */
+    onLoadedMetadata?: (event: VideoLoadedmetadataEvent) => void;
+    /** 视频元数据加载完成时触发 */
+    onLoadedmetadata?: (event: VideoLoadedmetadataEvent) => void;
+    /** 当浏览器可以播放视频时触发 */
+    onCanplay?: (event: BaseEvent) => void;
+    /** 当浏览器可在不因缓冲而停顿的情况下进行播放时触发 */
+    onCanplayThrough?: (event: BaseEvent) => void;
+    /** 当视频在已因缓冲而暂停或停止后已就绪时触发 */
+    onPlaying?: (event: BaseEvent) => void;
+    /** 当视频的播放速度已更改时触发 */
+    onRateChange?: (event: BaseEvent) => void;
+    /** 当音量已更改时触发 */
+    onVolumeChange?: (event: BaseEvent) => void;
+    /** seek 完成时触发 */
+    onSeekComplete?: (event: VideoSeekCompleteEvent) => void;
+    /**
+     * seek 完成时触发
+     * @internal
+     * @deprecated 请使用 onSeekComplete
+     */
+    onSeekcomplete?: (event: VideoSeekCompleteEvent) => void;
 }
 export declare const Video: React.ComponentType<VideoProps>;
-export {};
+/**
+ * Video 组件默认值
+ *
+ * @belong Video
+ * @defaults
+ */
+export declare const videoDefaultProps: {
+    duration: number;
+    controls: boolean;
+    danmuList: VideoDanmuItem[];
+    danmuBtn: boolean;
+    enableDanmu: boolean;
+    autoplay: boolean;
+    loop: boolean;
+    muted: boolean;
+    initialTime: number;
+    showFullscreenBtn: boolean;
+    showPlayBtn: boolean;
+    showCenterPlayBtn: boolean;
+    objectFit: string;
+    showMuteBtn: boolean;
+    autoPause: boolean;
+    borderRadius: number;
+};

package/cjs/hostComponents/Video/index.js

@@ -3,6 +3,46 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Video = void 0;
+exports.videoDefaultProps = exports.Video = void 0;
 const createHostComponent_js_1 = __importDefault(require("../createHostComponent.js"));
 exports.Video = (0, createHostComponent_js_1.default)('video');
+/**
+ * Video 组件默认值
+ *
+ * @belong Video
+ * @defaults
+ */
+exports.videoDefaultProps = {
+    duration: 0,
+    controls: true,
+    danmuList: [],
+    danmuBtn: false,
+    enableDanmu: false,
+    autoplay: false,
+    loop: false,
+    muted: false,
+    initialTime: 0,
+    showFullscreenBtn: true,
+    showPlayBtn: true,
+    showCenterPlayBtn: true,
+    objectFit: 'contain',
+    showMuteBtn: false,
+    autoPause: true,
+    borderRadius: 0,
+};
+exports.Video.defaultProps = {
+    controls: true,
+    danmuBtn: false,
+    enableDanmu: false,
+    autoplay: false,
+    loop: false,
+    muted: false,
+    initialTime: 0,
+    showFullscreenBtn: true,
+    showPlayBtn: true,
+    showCenterPlayBtn: true,
+    objectFit: 'contain',
+    showMuteBtn: false,
+    autoPause: true,
+    borderRadius: 0,
+};

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

@@ -1,25 +1,75 @@
 import * as React from 'react';
-import { BaseProps, DiffLayer, GenericEvent } from '../../types/component.js';
+import { BaseEvent, BaseProps, DiffLayer } from '../../types/component';
+/** 网页加载成功事件详情 */
+export interface WebViewLoadDetail {
+    /** 网页链接 */
+    src: string;
+}
+/** 网页加载成功事件 */
+export interface WebViewLoadEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'load';
+    detail: WebViewLoadDetail;
+}
+/** 网页加载失败事件详情 */
+export interface WebViewErrorDetail {
+    /** 网页链接 */
+    url?: string;
+    /** 加载失败时的完整 URL */
+    fullUrl?: string;
+    /** 错误信息 */
+    errMsg?: string;
+}
+/** 网页加载失败事件 */
+export interface WebViewErrorEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'error';
+    detail: WebViewErrorDetail;
+}
+/** 网页向小程序 postMessage 事件详情 */
+export interface WebViewMessageDetail {
+    /** 多次 postMessage 的参数组成的数组 */
+    data: unknown[];
+}
+/** 网页向小程序 postMessage 事件 */
+export interface WebViewMessageEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'message';
+    detail: WebViewMessageDetail;
+}
+/**
+ * 承载网页的容器；在小程序中通常会铺满整个页面。
+ * 当页面存在 web-view 标签时，其他标签将不展示，且不支持设置任何样式！
+ *
+ * @public
+ * @alias WebView
+ * @since @ray-js/ray 0.6.9
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide
+ */
 export interface WebViewProps extends BaseProps, DiffLayer {
-    /**
-     * webview 指向网页的链接，网页需登录小程序管理后台配置业务域名。
-     */
+    /** webview 指向网页的链接，需登录小程序管理后台, 进入小程序详情页->开发设置->多区服务器域名->webview 合法域名 进行webview 域名配置。 */
     src?: string;
     /**
      * 是否向 webview 中注入 TTT SDK
+     * @internal
      */
     injectTTT?: boolean;
+    /** 网页加载失败时触发 */
+    onError?: (event: WebViewErrorEvent) => void;
+    /** 网页加载成功时触发 */
+    onLoad?: (event: WebViewLoadEvent) => void;
     /**
-     * 网页加载失败的时候触发此事件。e.detail = { url, fullUrl }，其中 fullUrl 为加载失败时的完整 url
-     */
-    onError?: (event: GenericEvent) => any;
-    /**
-     * 网页加载成功时候触发此事件。e.detail = { src }
-     */
-    onLoad?: (event: GenericEvent) => any;
-    /**
-     * 网页向小程序 postMessage 时，会在特定时机（小程序后退、组件销毁、分享）触发并收到消息。e.detail = { data }，data是多次 postMessage 的参数组成的数组
+     * 网页向小程序 postMessage 时，在特定时机（小程序后退、组件销毁、分享）触发并收到消息
      */
-    onMessage?: (event: GenericEvent) => any;
+    onMessage?: (event: WebViewMessageEvent) => void;
 }
 export declare const WebView: React.ComponentType<WebViewProps>;
+/**
+ * WebView 组件默认值
+ *
+ * @belong WebView
+ * @defaults
+ */
+export declare const webViewDefaultProps: {
+    src: string;
+};

package/cjs/hostComponents/WebView/index.js

@@ -3,7 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebView = void 0;
+exports.webViewDefaultProps = exports.WebView = void 0;
 const createHostComponent_js_1 = __importDefault(require("../createHostComponent.js"));
 exports.WebView = (0, createHostComponent_js_1.default)('web-view');
+/**
+ * WebView 组件默认值
+ *
+ * @belong WebView
+ * @defaults
+ */
+exports.webViewDefaultProps = {
+    src: '',
+};
 exports.WebView.defaultProps = {};

package/cjs/types/component.d.ts

@@ -1,5 +1,8 @@
 import * as React from 'react';
-/** 微信内置组件公共属性 */
+/**
+ * 微信内置组件公共属性
+ * @internal
+ */
 export interface BaseProps {
     /** 自定义属性: 组件上触发的事件时，会发送给事件处理函数 */
     readonly dataset?: DOMStringMap;
@@ -12,7 +15,7 @@ export interface BaseProps {
     /** 组件是否显示: 所有组件默认显示 */
     hidden?: boolean;
     /** 动画对象: 由`ty.createAnimation`创建 */
-    animation?: Array<Record<string, any>>;
+    animation?: Record<string, unknown>[];
     /** 子节点 children */
     children?: React.ReactNode;
     /** 点击时触发 */
@@ -42,15 +45,18 @@ export interface BaseProps {
     /** 在支持 3D Touch 的 iPhone 设备，重按时会触发 */
     onTouchForceChange?: (event: TouchEvent) => void;
     /** 点击时触发同时阻止事件冒泡 */
-    catchClick?: (event: any) => any;
+    catchClick?: (event: TouchEvent) => void;
 }
 interface Target {
     /** 事件源组件的id */
     id: string;
     /** 事件源组件上的 `dataset` 自定义属性组成的集合 */
-    dataset: any;
+    dataset: Record<string, unknown>;
 }
-/** 基础事件对象属性列表 */
+/**
+ * 基础事件对象属性列表
+ * @internal
+ */
 export interface BaseEvent {
     /** 事件类型 */
     type: string;
@@ -64,7 +70,7 @@ export interface BaseEvent {
      */
     currentTarget: Target;
     /** 事件标记数据 */
-    mark: any;
+    mark?: any;
 }
 /** 自定义事件对象属性列表 */
 export interface GenericEvent<Detail = any> extends BaseEvent {
@@ -81,6 +87,9 @@ export interface TouchEvent<T = Touch> extends BaseEvent {
     changedTouches: T[];
 }
 export interface DiffLayer {
+    /**
+     * 用来异层组件通知容器层样式更新
+     */
     updateLayout?: unknown;
 }
 export {};

package/cjs/types/index.d.ts

@@ -1,2 +1,2 @@
-export * from './config.js';
-export type { BaseEvent, TouchEvent, GenericEvent } from './component.js';
+export * from './config';
+export type { BaseEvent, TouchEvent, GenericEvent } from './component';

package/cjs/types/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./config.js"), exports);
+__exportStar(require("./config"), exports);

package/esm/hostComponents/Camera/index.d.ts

@@ -1,21 +1,116 @@
-import type * as React from 'react';
-import type { BaseProps, DiffLayer, GenericEvent } from '../../types/component.js';
+import * as React from 'react';
+import { BaseEvent, BaseProps, DiffLayer } from '../../types/component';
+/** 相机非正常终止事件对象 */
+export interface CameraStopEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'stop';
+}
+/** 相机错误事件详情 */
+export interface CameraErrorEventDetail {
+    /** 错误信息 */
+    errMsg: string;
+}
+/** 相机错误事件对象 */
+export interface CameraErrorEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'error';
+    /** 事件详情 */
+    detail: CameraErrorEventDetail;
+}
+/** 相机初始化完成事件详情 */
+export interface CameraInitdoneEventDetail {
+    /** 最大缩放倍数 */
+    maxZoom: number;
+}
+/** 相机初始化完成事件对象 */
+export interface CameraInitdoneEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'initdone';
+    /** 事件详情 */
+    detail: CameraInitdoneEventDetail;
+}
+export type CameraResolution = 
+/** 低分辨率 */
+'low'
+/** 中分辨率 */
+ | 'medium'
+/** 高分辨率 */
+ | 'high';
+export type CameraDevicePosition = 
+/** 前置摄像头 */
+'front'
+/** 后置摄像头 */
+ | 'back';
+export type CameraFlash = 
+/** 自动闪光灯 */
+'auto'
+/** 开启闪光灯 */
+ | 'on'
+/** 关闭闪光灯 */
+ | 'off'
+/** 手电筒模式 */
+ | 'torch';
+export type CameraBorderStyle = 
+/** 实线边框 */
+'solid'
+/** 虚线边框 */
+ | 'dashed';
+/**
+ * 系统相机组件，用于预览与拍摄。
+ *
+ * @public
+ * @alias Camera
+ * @since @ray-js/ray 0.6.9
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide
+ * @example 自定义边框 ./demos/custom-border/index.tsx sandbox ide
+ */
 export interface CameraProps extends BaseProps, DiffLayer {
-    mode?: string;
-    resolution?: string;
-    devicePosition?: string;
-    flash?: string;
+    /** 应用模式，只在初始化时有效，不能动态变更 */
+    mode?: 'normal';
+    /** 分辨率，不支持动态修改 */
+    resolution?: CameraResolution;
+    /** 摄像头朝向 */
+    devicePosition?: CameraDevicePosition;
+    /** 闪光灯模式 */
+    flash?: CameraFlash;
+    /** 边框宽度，单位 px */
     borderWidth?: number;
-    borderStyle?: string;
+    /** 边框样式 */
+    borderStyle?: CameraBorderStyle;
+    /** 边框颜色，须为十六进制格式 */
     borderColor?: string;
+    /** 边框圆角，单位 px */
     borderRadius?: number;
+    /** 边框左上角圆角，单位 px */
     borderRadiusTopLeft?: number;
+    /** 边框右上角圆角，单位 px */
     borderRadiusTopRight?: number;
+    /** 边框左下角圆角，单位 px */
     borderRadiusBottomLeft?: number;
+    /** 边框右下角圆角，单位 px */
     borderRadiusBottomRight?: number;
+    /** 背景颜色，须为十六进制格式 */
     backgroundColor?: string;
-    onBindstop?: (event: GenericEvent) => any;
-    onError?: (event: GenericEvent) => any;
-    onInitdone?: (event: GenericEvent) => any;
+    /** 摄像头在非正常终止时触发，如退出后台等情况 */
+    onBindstop?: (event: CameraStopEvent) => void;
+    /** 用户不允许使用摄像头时触发 */
+    onError?: (event: CameraErrorEvent) => void;
+    /** 相机初始化完成时触发 */
+    onInitdone?: (event: CameraInitdoneEvent) => void;
 }
 export declare const Camera: React.ComponentType<CameraProps>;
+/**
+ * @belong Camera
+ * @defaults
+ */
+export declare const cameraDefaultProps: {
+    mode: string;
+    resolution: string;
+    devicePosition: string;
+    flash: string;
+    borderWidth: number;
+    borderStyle: string;
+    borderColor: string;
+    borderRadius: number;
+    backgroundColor: string;
+};