@ray-js/adapter 1.7.79 → 1.7.81

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

@@ -1,74 +1,227 @@
 import * as React from 'react';
-import { BaseProps, DiffLayer, GenericEvent } from '../../types/component.js';
-export interface MapProps extends BaseProps, DiffLayer {
-    longitude: number;
+import type { BaseEvent, BaseProps, DiffLayer } from '../../types/component';
+/** 坐标点 */
+export interface MapPoint {
+    /** 纬度 */
     latitude: number;
-    scale?: number;
-    minScale?: number;
-    maxScale?: number;
-    disableAnimation?: boolean;
-    disableRotate?: boolean;
-    /**
-     * 地图类型
-     * @description 0：夜景地图，1：白昼地图，2：卫星图
-     */
-    mapType?: 0 | 1 | 2;
-    markers?: Array<Marker>;
-    polyline?: Array<Polyline>;
-    circles?: Array<Circle>;
-    polygons?: Array<Polygon>;
-    borderWidth?: number;
-    borderStyle?: string;
-    borderColor?: string;
-    borderRadius?: number;
-    borderRadiusTopLeft?: number;
-    borderRadiusTopRight?: number;
-    borderRadiusBottomLeft?: number;
-    borderRadiusBottomRight?: number;
-    backgroundColor?: string;
-    onMarkertap?: (e: GenericEvent) => void;
-    onCallouttap?: (e: GenericEvent) => void;
-    onRegionchange?: (e: GenericEvent) => void;
-    onInitdone?: (e: GenericEvent) => void;
-    onMaptap?: (e: GenericEvent) => void;
+    /** 经度 */
+    longitude: number;
 }
-export type Marker = {
+/** 气泡窗口属性 */
+export interface MapCallout {
+    /** 文本 */
     content?: string;
+    /** 文本颜色 */
     color?: string;
+    /** 文字大小 */
     fontSize?: number;
+    /** 边框圆角 */
     borderRadius?: number;
+    /** 边框宽度 */
     borderWidth?: number;
+    /** 边框颜色 */
     borderColor?: string;
+    /** 背景色 */
     bgColor?: string;
+    /** 文本边缘留白 */
     padding?: number;
-    textAlign?: string;
+    /** 文本对齐方式 */
+    textAlign?: 'left' | 'right' | 'center';
+    /** 横向偏移量，向右为正数 */
     anchorX?: number;
+    /** 纵向偏移量，向下为正数 */
     anchorY?: number;
-};
-export type Polyline = {
-    points: Array<{
-        latitude: number;
-        longitude: number;
-    }>;
+}
+/** 标记点 */
+export interface MapMarker {
+    /** 标记点 ID */
+    id?: number;
+    /** 经度 */
+    longitude: number;
+    /** 纬度 */
+    latitude: number;
+    /** 标注点名 */
+    title?: string;
+    /** 气泡样式类型 ID */
+    styleId?: string;
+    /** 标记点上方的气泡窗口 */
+    callout?: MapCallout;
+    /** 显示的图标路径 */
+    iconPath?: string;
+    /** 旋转角度 */
+    rotate?: number;
+    /** 标注图标宽度 */
+    width?: number | string;
+    /** 标注图标高度 */
+    height?: number | string;
+}
+/** 路线 */
+export interface MapPolyline {
+    /** 经纬度数组 */
+    points: MapPoint[];
+    /** 线的颜色，十六进制 */
     color?: string;
+    /** 线的宽度 */
     width?: number;
+    /** 是否虚线 */
     dottedLine?: boolean;
-};
-export type Circle = {
+}
+/** 圆 */
+export interface MapCircle {
+    /** 纬度 */
     latitude: number;
+    /** 经度 */
     longitude: number;
+    /** 描边的颜色，十六进制 */
     color?: string;
+    /** 填充颜色，十六进制 */
     fillColor?: string;
+    /** 半径 */
     radius: number;
+    /** 描边的宽度 */
     strokeWidth?: number;
-};
-export type Polygon = {
-    points: Array<{
-        latitude: number;
-        longitude: number;
-    }>;
-    strokeWidth?: number;
+}
+/** 多边形 */
+export interface MapPolygon {
+    /** 经纬度数组 */
+    points: MapPoint[];
+    /** 描边的颜色 */
     strokeColor?: string;
+    /** 填充颜色 */
     fillColor?: string;
-};
+    /** 描边的宽度 */
+    strokeWidth?: number;
+}
+/** 标记点标识事件详情 */
+export interface MapMarkerIdDetail {
+    /** 标记点 ID */
+    markerId: number;
+}
+/** 标记点点击事件对象 */
+export interface MapMarkertapEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'markertap';
+    /** 事件详情数据 */
+    detail: MapMarkerIdDetail;
+}
+/** 气泡点击事件对象 */
+export interface MapCallouttapEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'callouttap';
+    /** 事件详情数据 */
+    detail: MapMarkerIdDetail;
+}
+/** 视野变化事件详情 */
+export interface MapRegionChangeDetail {
+    /** 变化类型 */
+    type: 'begin' | 'end';
+    /** 导致视野变化的原因 */
+    causedBy: string;
+}
+/** 视野变化事件对象 */
+export interface MapRegionchangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'regionchange';
+    /** 事件详情数据 */
+    detail: MapRegionChangeDetail;
+}
+/** 初始化完成事件对象 */
+export interface MapInitdoneEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'initdone';
+}
+/**
+ * 地图组件；真机国内使用高德地图，海外使用 Google 地图。
+ *
+ * Tuya MiniApp IDE 和在线预览上是通过 WebView 模拟的与真机存在差异，请以真机效果为主。
+ *
+ * @public
+ * @alias Map
+ * @since @ray-js/ray 0.6.9
+ * @since 基础库 2.0.12
+ * @since MapKit 2.2.2
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide
+ * @example 标记点与气泡 ./demos/markers-callout/index.tsx sandbox ide
+ * @example 路线与覆盖层 ./demos/polyline-overlay/index.tsx sandbox ide
+ */
+export interface MapProps extends BaseProps, DiffLayer {
+    /** 中心经度 */
+    longitude?: number;
+    /** 中心纬度 */
+    latitude?: number;
+    /** 缩放级别，取值范围为 4-19 */
+    scale?: number;
+    /** 最小缩放级别 */
+    minScale?: number;
+    /** 最大缩放级别 */
+    maxScale?: number;
+    /**
+     * 是否禁用地图动画
+     *
+     * @internal
+     */
+    disableAnimation?: boolean;
+    /** 是否禁用旋转，默认 false */
+    disableRotate?: boolean;
+    /**
+     * 地图类型
+     *
+     * @internal
+     */
+    mapType?: number;
+    /** 标记点 */
+    markers?: MapMarker[];
+    /** 路线 */
+    polyline?: MapPolyline[];
+    /** 圆 */
+    circles?: MapCircle[];
+    /** 多边形 */
+    polygons?: MapPolygon[];
+    /** 边框的宽度，单位 px */
+    borderWidth?: number;
+    /** 边框的样式 */
+    borderStyle?: 'solid' | 'dashed';
+    /** 边框的颜色，必须为十六进制格式 */
+    borderColor?: string;
+    /** 边框的圆角，单位 px */
+    borderRadius?: number;
+    /** 边框的左上角圆角大小，单位 px */
+    borderRadiusTopLeft?: number;
+    /** 边框的右上角圆角大小，单位 px */
+    borderRadiusTopRight?: number;
+    /** 边框的左下角圆角大小，单位 px */
+    borderRadiusBottomLeft?: number;
+    /** 边框的右下角圆角大小，单位 px */
+    borderRadiusBottomRight?: number;
+    /** 背景颜色，必须为十六进制格式 */
+    backgroundColor?: string;
+    /** 点击标记点时触发 */
+    onMarkertap?: (event: MapMarkertapEvent) => void;
+    /** 点击标记点对应的气泡时触发 */
+    onCallouttap?: (event: MapCallouttapEvent) => void;
+    /** 视野发生变化时触发 */
+    onRegionchange?: (event: MapRegionchangeEvent) => void;
+    /** 初始化完成时触发 */
+    onInitdone?: (event: MapInitdoneEvent) => void;
+}
+export type Marker = MapMarker;
+export type Polyline = MapPolyline;
+export type Circle = MapCircle;
+export type Polygon = MapPolygon;
 export declare const Map: React.ComponentType<MapProps>;
+/**
+ * Map 组件文档默认值
+ *
+ * @belong Map
+ * @defaults
+ */
+export declare const mapDefaultProps: {
+    scale: number;
+    minScale: number;
+    maxScale: number;
+    borderWidth: number;
+    borderStyle: string;
+    borderColor: string;
+    borderRadius: number;
+    backgroundColor: string;
+};

package/esm/hostComponents/Map/index.js

@@ -1,5 +1,21 @@
 import createHostComponent from '../createHostComponent.js';
 export const Map = createHostComponent('map');
+/**
+ * Map 组件文档默认值
+ *
+ * @belong Map
+ * @defaults
+ */
+export const mapDefaultProps = {
+    scale: 16,
+    minScale: 4,
+    maxScale: 19,
+    borderWidth: 0,
+    borderStyle: 'solid',
+    borderColor: '#ffffff',
+    borderRadius: 0,
+    backgroundColor: '#ffffff',
+};
 Map.defaultProps = {
     scale: 16,
     minScale: 4,

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

@@ -1,7 +1,25 @@
 import * as React from 'react';
 import { BaseProps } from '../../types/component.js';
+/**
+ * MovableView 的可移动区域容器；须包裹 MovableView，且后者须为直接子节点。
+ *
+ * @public
+ * @alias MovableArea
+ * @since @ray-js/ray 0.5.10
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide e2e
+ * @example 缩放区域扩展 ./demos/scale-area/index.tsx sandbox ide e2e
+ */
 export interface MovableAreaProps extends BaseProps {
     /** 当里面的 movable-view 设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个 movable-area */
     scaleArea?: boolean;
 }
 export declare const MovableArea: React.ComponentType<MovableAreaProps>;
+/**
+ * MovableArea 组件文档默认值
+ *
+ * @belong MovableArea
+ * @defaults
+ */
+export declare const movableAreaDefaultProps: {
+    scaleArea: boolean;
+};

package/esm/hostComponents/MovableArea/index.js

@@ -1,5 +1,14 @@
 import createHostComponent from '../createHostComponent.js';
 export const MovableArea = createHostComponent('movable-area');
+/**
+ * MovableArea 组件文档默认值
+ *
+ * @belong MovableArea
+ * @defaults
+ */
+export const movableAreaDefaultProps = {
+    scaleArea: false,
+};
 MovableArea.defaultProps = {
     scaleArea: false,
 };

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

@@ -1,25 +1,111 @@
 import * as React from 'react';
-import { BaseProps, GenericEvent } from '../../types/component.js';
+import { BaseEvent, BaseProps, GenericEvent } from '../../types/component';
+/** movable-view 拖动过程事件数据 */
+export interface MovableViewChangeDetail {
+    /** x 轴方向的偏移 */
+    x: number;
+    /** y 轴方向的偏移 */
+    y: number;
+    /** 产生移动的原因 */
+    source: 'touch' | 'touch-out-of-bounds' | 'out-of-bounds' | 'friction' | '';
+}
+/** movable-view 拖动过程事件对象 */
+export interface MovableViewChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'change';
+    /** 事件数据 */
+    detail: MovableViewChangeDetail;
+}
+/** movable-view 缩放过程事件数据 */
+export interface MovableViewScaleDetail {
+    /** x 轴方向的偏移 */
+    x: number;
+    /** y 轴方向的偏移 */
+    y: number;
+    /** 缩放倍数 */
+    scale: number;
+}
+/** movable-view 缩放过程事件对象 */
+export interface MovableViewScaleEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'scale';
+    /** 事件数据 */
+    detail: MovableViewScaleDetail;
+}
+/**
+ * 可拖拽的可移动视图，须置于 MovableArea 内使用。
+ *
+ * @public
+ * @alias MovableView
+ * @since @ray-js/ray 0.5.10
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide e2e
+ * @example 惯性与回弹 ./demos/inertia-bounce/index.tsx sandbox ide e2e
+ * @example 禁用与指定位置 ./demos/disabled-position/index.tsx sandbox ide e2e
+ * @example 双指缩放 ./demos/pinch-zoom/index.tsx sandbox ide e2e
+ */
 export interface MovableViewProps extends Omit<BaseProps, 'animation'> {
-    direction?: string;
+    /** movable-view 的移动方向 */
+    direction?: 'all' | 'vertical' | 'horizontal' | 'none';
+    /** movable-view 是否带有惯性 */
     inertia?: boolean;
+    /** 超过可移动区域后，movable-view 是否还可以移动 */
     outOfBounds?: boolean;
+    /** 定义 x 轴方向的偏移，如果 x 的值不在可移动范围内，会自动移动到可移动范围；改变 x 的值会触发动画 */
     x?: number;
+    /** 定义 y 轴方向的偏移，如果 y 的值不在可移动范围内，会自动移动到可移动范围；改变 y 的值会触发动画 */
     y?: number;
+    /** 阻尼系数，用于控制 x 或 y 改变时的动画和过界回弹的动画，值越大移动越快 */
     damping?: number;
+    /** 摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于 0，否则会被设置成默认值 */
     friction?: number;
+    /** 是否禁用 */
     disabled?: boolean;
+    /** 是否支持双指缩放，默认缩放手势生效区域是在 movable-view 内 */
     scale?: boolean;
+    /** 定义缩放倍数最小值 */
     scaleMin?: number;
+    /** 定义缩放倍数最大值 */
     scaleMax?: number;
+    /** 定义缩放倍数，取值范围为 0.5 - 10 */
     scaleValue?: number;
+    /** 是否使用动画 */
     animation?: boolean;
-    onChange?: (event: GenericEvent) => void;
-    onScale?: (event: GenericEvent) => void;
+    /** 拖动过程中触发 */
+    onChange?: (event: MovableViewChangeEvent) => void;
+    /**
+     * 缩放过程中触发，x 和 y 字段在 2.1.0 之后支持
+     *
+     * @since 2.1.0
+     */
+    onScale?: (event: MovableViewScaleEvent) => void;
+    /**
+     * 初次手指触摸后移动为横向的移动时触发
+     * @internal
+     */
     htouchmove?: (event: GenericEvent) => void;
+    /**
+     * 初次手指触摸后移动为纵向的移动时触发
+     * @internal
+     */
     vtouchmove?: (event: GenericEvent) => void;
 }
+export declare const MovableView: React.ComponentType<MovableViewProps>;
 /**
- * https://developers.weixin.qq.com/miniprogram/dev/component/movable-view.html
+ * MovableView 组件默认值
+ *
+ * @belong MovableView
+ * @defaults
  */
-export declare const MovableView: React.ComponentType<MovableViewProps>;
+export declare const movableViewDefaultProps: {
+    direction: string;
+    inertia: boolean;
+    outOfBounds: boolean;
+    damping: number;
+    friction: number;
+    disabled: boolean;
+    scale: boolean;
+    scaleMin: number;
+    scaleMax: number;
+    scaleValue: number;
+    animation: boolean;
+};

package/esm/hostComponents/MovableView/index.js

@@ -1,8 +1,24 @@
 import createHostComponent from '../createHostComponent.js';
+export const MovableView = createHostComponent('movable-view');
 /**
- * https://developers.weixin.qq.com/miniprogram/dev/component/movable-view.html
+ * MovableView 组件默认值
+ *
+ * @belong MovableView
+ * @defaults
  */
-export const MovableView = createHostComponent('movable-view');
+export const movableViewDefaultProps = {
+    direction: 'none',
+    inertia: false,
+    outOfBounds: false,
+    damping: 20,
+    friction: 2,
+    disabled: false,
+    scale: false,
+    scaleMin: 0.5,
+    scaleMax: 10,
+    scaleValue: 1,
+    animation: true,
+};
 MovableView.defaultProps = {
     direction: 'none',
     inertia: false,