@dcloudio/uni-app-x 0.7.62 → 0.7.64

package/types/dom2/UniNativeDefines.d.ts

@@ -0,0 +1,435 @@
+/**
+ * NativeView通用基础类型定义  
+ * 
+ * 特别说明
+ * 类型中涉及长度单位的，如果没有特殊说明，单位为逻辑像素值，渲染时需转换各自平台需要的值  
+ */
+import { UniSize, UniPosition, UniLTWH, UniLTRB } from './UniCommon'
+
+
+/**
+ * 颜色对象
+ * 不同平台根据自身使用自己的类型，比如Int
+ */
+export type UniNativeColor = {
+  /**
+   * 颜色值
+   * 如何定义各平台根据实际情况处理，可以使用CSSOM中的颜色定义（新取别名）
+   */
+}
+
+
+/**
+ * 位置对象
+ */
+export type UniNativeLayout = UniLTWH
+/**
+ * 尺寸信息
+ */
+export type UniNativeLayoutSize = UniSize
+
+/**
+ * 位置信息
+ */
+export type UniNativeLayoutPosition = UniPosition
+
+/**
+ * 内边距
+ */
+export type UniNativePadding = number
+/**
+ * 内边距信息
+ */
+export type UniNativePaddings = UniLTRB
+
+/**
+ * 外边距
+ */
+export type UniNativeMargin = number
+/**
+ * 外边距详细信息
+ */
+export type UniNativeMargins = UniLTRB
+
+/**
+ * 边框信息
+ */
+export type UniNativeBorders = {
+  /**
+   * 边框宽度
+   */
+  width: UniNativeBorderWidths
+  /**
+   * 边框颜色
+   */
+  color: UniNativeBorderColors
+  /**
+   * 边框圆角半径
+   */
+  radius: UniNativeBorderRadiuses
+  /**
+   * 比那款样式
+   */
+  style: UniNativeBorderStyles
+}
+export type UniNativeBorder = {
+  /**
+   * 边框宽度
+   */
+  width: UniNativeBorderWidth
+  /**
+   * 边框颜色
+   */
+  color: UniNativeBorderColor
+  /**
+   * 边框圆角半径
+   */
+  radius: UniNativeBorderRadius
+  /**
+   * 比那款样式
+   */
+  style: UniNativeBorderStyle
+}
+
+/**
+ * 边框宽度类型
+ */
+export type UniNativeBorderWidth = number
+/**
+ * 边框宽度详细信息
+ */
+export type UniNativeBorderWidths = UniLTRB
+/**
+ * 边框颜色
+ */
+export type UniNativeBorderColor = UniNativeColor
+/**
+ * 边框颜色详细信息
+ */
+export type UniNativeBorderColors = {
+  /**
+   * 上边框颜色
+   */
+  top: UniNativeBorderColor
+  /**
+   * 右边框颜色
+   */
+  right: UniNativeBorderColor
+  /**
+   * 下边框颜色
+   */
+  bottom: UniNativeBorderColor
+  /**
+   * 左边框颜色
+   */
+  left: UniNativeBorderColor
+}
+
+/**
+ * 边框样式
+ */
+export enum UniNativeBorderStyle {
+  /**
+   * 无边框
+   */
+  None,
+  /**
+   * 实线样式边框
+   */
+  Solid,
+  /**
+   * 方形虚线样式边框
+   */
+  Dashed,
+  /**
+   * 圆点样式边框，圆点半径为borderWidth的一半
+   */
+  Dotted
+}
+/**
+ * 边框样式详细信息
+ */
+export type UniNativeBorderStyles = {
+  /**
+   * 上边框样式
+   */
+  top: UniNativeBorderStyle
+  /**
+   * 右边框样式
+   */
+  right: UniNativeBorderStyle
+  /**
+   * 下边框样式
+   */
+  bottom: UniNativeBorderStyle
+  /**
+   * 左边框样式
+   */
+  left: UniNativeBorderStyle
+}
+
+/**
+ * 边框圆角半径
+ */
+export type UniNativeBorderRadius = number
+/**
+ * 边框圆角半径详细信息
+ */
+export type UniNativeBorderRadiuses = {
+  /**
+   * 左上角圆角半径
+   */
+  topLeft: UniNativeBorderRadius
+  /**
+   * 右上角圆角半径
+   */
+  topRight: UniNativeBorderRadius
+  /**
+   * 右下角圆角半径
+   */
+  bottomRight: UniNativeBorderRadius
+  /**
+   * 左下角圆角半径
+   */
+  bottomLeft: UniNativeBorderRadius
+}
+
+
+/**
+ * 阴影样式详细信息
+ */
+export type UniNativeBoxShadow = {
+  /**
+   * 阴影是否在元素内部
+   * 默认值为false，即阴影在外部
+   */
+  isInset: boolean
+  /**
+   * 阴影的 x 偏移量
+   */
+  offsetX: number
+  /**
+   * 阴影的 y 偏移量
+   */
+  offsetY: number
+  /**
+   * 阴影的模糊半径
+   * 默认值为0
+   */
+  blurRadius: number
+  /**
+   * 阴影的扩展范围
+   * 默认值为0
+   */
+  spreadRadius: number
+  /**
+   * 阴影颜色
+   * 默认为透明
+   */
+  color: UniNativeColor
+}
+
+
+/**
+ * 元素溢出行为类型
+ */
+export enum UniNativeOverflowType {
+  /**
+   * 内容被裁减，即不可渲染到元素外部
+   */
+  Hidden,
+  /**
+   * 内容不被裁减，即可能渲染到元素外部
+   */
+  Visible,
+}
+
+
+/**
+ * pointer-event类型
+ * 元素是否可以成为事件的target
+ */
+export enum UniNativePointerEventType {
+  /**
+   * 元素可成为事件的target
+   */
+  Auto,
+  /**
+   * 元素不可成为事件的target
+   */
+  None,
+}
+
+
+/**
+ * display类型
+ * 元素显示类型
+ *  注：鸿蒙/iOS平台都是在C层可以与CSS中的 UniCSSDisplayType 复用
+ */
+export enum UniNativeDisplayType {
+  /**
+   * 元素按弹性布局
+   */
+  Flex,
+  /**
+   * 元素不显示
+   */
+  None,
+}
+//export type UniNativeDisplayType = UniCSSDisplayType
+
+
+/**
+ * position类型
+ * 元素位置信息，渲染时需特殊处理fixed的场景
+ *  注：鸿蒙/iOS平台都是在C层可以与CSS中的 UniCSSPositionType 复用
+ */
+export enum UniNativePositionType {
+  /**
+   * 当前元素将参与父节点布局，根据 top、right、bottom、left 等属性相对于自身偏移。
+   */
+  Relative,
+  /**
+   * 当前元素将不参与父节点布局，布局时不会为该元素创建任何空间，在父元素的内容区域中进行绝对布局，根据 top、right、bottom、left 等属性决定其位置。
+   */
+  Absolute,
+  /**
+   * 当前元素将不参与父节点布局，将被视为页面根节点的子元素进行绝对布局，根据 top、right、bottom、left 等属性决定其位置。
+   */
+  Fixed,
+  /**
+   * 
+   */
+  Sticky,
+  /**
+   * 
+   */
+  Static,
+}
+//export type UniNativePositionType = UniCSSPositionType
+
+
+/**
+ * visibility类型
+ * 元素是否可见
+ *  注：鸿蒙/iOS平台都是在C层可以与CSS中的 UniCSSVisibilityType 复用
+ */
+export enum UniNativeVisibilityType {
+  /**
+   * 元素可见
+   */
+  Visible,
+  /**
+   * 元素不可见
+   */
+  Hidden,
+}
+//export type UniNativeVisibilityType = UniCSSVisibilityType
+
+
+/**
+ * transform类型
+ */
+export enum UniNativeTransformType {
+  /**
+   * 矩阵变换
+   */
+  Matrix,
+  /**
+   * 3D矩阵变换
+   */
+  Matrix3D,
+  /**
+   * 观察距离变换
+   */
+  Perspective,
+  /**
+   * 旋转
+   */
+  Rotate,
+  /**
+   * 绕 X 轴旋转
+   */
+  RotateX,
+  /**
+   * 绕 Y 轴旋转
+   */
+  RotateY,
+  /**
+   * 绕 Z 轴旋转
+   */
+  RotateZ,
+  /**
+   * 3D旋转
+   */
+  Rotate3D,
+  /**
+   * 缩放
+   */
+  Scale,
+  /**
+   * X 轴方向缩放
+   */
+  ScaleX,
+  /**
+   * Y 轴方向缩放
+   */
+  ScaleY,
+  /**
+   * Z 轴方向缩放
+   */
+  ScaleZ,
+  /**
+   * 3D缩放
+   */
+  Scale3D,
+  /**
+   * 倾斜（扭曲）
+   */
+  Skew,
+  /**
+   * 沿 X 轴倾斜
+   */
+  SkewX,
+  /**
+   * 沿 Y 轴倾斜
+   */
+  SkewY,
+  /**
+   * 移动
+   */
+  Translate,
+  /**
+   * 沿 X 轴移动
+   */
+  TranslateX,
+  /**
+   * 沿 Y 轴移动
+   */
+  TranslateY,
+  /**
+   * 沿 Z 轴移动
+   */
+  TranslateZ,
+  /**
+   * 3D移动
+   */
+  Translate3D,
+}
+
+
+/**
+ * 插槽名称  
+ */
+export enum UniNativeSlotType {
+  /**
+   * 无插槽
+   */
+  None,
+  /**
+   * 下拉刷新插槽
+   *  scroll-view组件的子组件使用
+   */
+  Refresher
+}
+

package/types/dom2/UniNativeImageView.d.ts

@@ -0,0 +1,34 @@
+import { UniNativeBaseView,  } from "./UniNativeBaseView"
+import { UniImageModeType } from "./UniImageElement";
+
+
+
+/**
+ * 图片组件 image
+ */
+export interface UniNativeImageView extends UniNativeBaseView {
+
+  /**
+   * 设置图片资源地址
+   *  仅Android平台支持
+   *  其它平台通过UniElement在c层加载图片后更新
+   */
+  src(src: string): void;
+  
+  /**
+   * 设置图片裁剪、缩放模式
+   */
+  mode(value: UniImageModeType): void;
+  
+  /**
+   * 设置是否懒加载
+   */
+  lazyLoad(value: boolean): void;
+  
+  /**
+   * 图片显示动画效果
+   */
+  fadeShow(value: boolean): void;
+}
+
+

package/types/dom2/UniNativeScrollView.d.ts

@@ -0,0 +1,42 @@
+import { UniNativeBaseView,  } from "./UniNativeBaseView"
+
+
+
+/**
+ * 滚动容器组件 scroll-view
+ */
+export interface UniNativeScrollView extends UniNativeBaseView {
+
+
+}
+
+
+/**
+ * scroll-view组件构造参数
+ */
+export type UniNativeScrollViewOptions = {
+  direction: UniNativeScrollViewDirectionType
+}
+
+
+/**
+ * scroll-view组件滚动方向枚举值
+ */
+export enum UniNativeScrollViewDirectionType {
+  /**
+   * 禁止滚动
+   */
+  None,
+  /**
+   * 竖向滚动
+   */
+  Vertical,
+  /**
+   * 横向滚动
+   */
+  Horizontal,
+  /**
+   * 横向竖向都可滚动
+   */
+  All,
+}

package/types/dom2/UniNativeTextView.d.ts

@@ -0,0 +1,25 @@
+import { UniNativeBaseView, } from "./UniNativeBaseView"
+import { UniTextLayout } from "./index"
+
+
+
+/**
+ * 基本视图容器View
+ */
+/**
+ * 文本View
+ */
+export interface UniNativeTextView extends UniNativeBaseView {
+  /**
+   * 设置文本内容
+   */
+  content(value: UniTextLayout): UniNativeTextView
+
+
+  /**
+   * 属性
+   */
+}
+
+
+

package/types/dom2/UniNativeView.d.ts

@@ -0,0 +1,51 @@
+import { UniNativeBaseView,  } from "./UniNativeBaseView"
+
+
+
+/**
+ * 基本视图容器 view
+ */
+export interface UniNativeView extends UniNativeBaseView {
+  /**
+   * 管理子View
+   */
+  /**
+   * 添加子View
+   */
+  append(view: UniNativeBaseView): UniNativeView
+  /**
+   * 删除子View
+   */
+  removeChild(view: UniNativeBaseView): UniNativeView
+  /**
+   * 在指定子View前插入
+   *  如未指定ref则添加到末尾，与append效果一致
+   */
+  insertBefore(view: UniNativeBaseView, ref: UniNativeBaseView|null): UniNativeView
+
+
+  /**
+   * View的属性相关API
+   */
+  /**
+   * 是否阻止本节点的祖先节点出现点击态
+   * 默认值为false
+   */
+  hoverStopPropagation(value: boolean): UniNativeView
+  /**
+   * 按住后多久出现点击态，单位为毫秒
+   * 默认值为50ms
+   */
+  hoverStartTime(value: number): UniNativeView
+  /**
+   * 手指松开后点击态保留时间，单位为毫秒
+   * 默认值为400ms
+   */
+  hoverStayTime(value: number): UniNativeView
+
+
+}
+
+
+export type UniNativeViewStyles = Map<string, any>
+

package/types/dom2/UniNativeViewType.d.ts

@@ -0,0 +1,22 @@
+
+/**
+ * 原生View类型
+ */
+export enum UniNativeViewType {
+  /**
+   * 基本视图容器View
+   */
+  View,
+  /**
+   * 文本View
+   */
+  Text,
+  /**
+   * 图片View
+   */
+  Image,
+  /**
+   * 可滚动视图容器View
+   */
+  ScrollView
+}

package/types/dom2/UniPage.d.ts

@@ -0,0 +1,55 @@
+import { UniElement } from './index'
+import { UniElementType, UniElementStyles } from './UniElementType'
+import { UniViewElement } from './index'
+import { UniTextElement } from './index'
+import { UniImageElement } from './index'
+import { UniNativeView } from './UniNativeView'
+import { UniNativeTextView } from './UniNativeTextView'
+import { UniNativeImageView } from './UniNativeImageView'
+import { UniNativeScrollView, UniNativeScrollViewOptions } from './UniNativeScrollView'
+import { UniNativeCustomView } from './UniNativeCustomView'
+
+declare global {
+  /**
+   * 页面对象
+   */
+  interface UniPage {
+
+    /**
+     * 创建UniElement
+     * 仅内部使用
+     * @param type - UniElementType类型
+     * @param flatten - Element是否被拍平（扁平化）
+     *  true表示可拍平，false表示不可拍平，默认值false
+     * @param style - 同时设置多个CSS样式
+     * 注意：在Android平台仅支持排版CSS，为了各平台统一，编译生成的代码应该只设置排版相关CSS
+     */
+    createElement(type: UniElementType, flatten: boolean): UniElement
+    createElement(type: UniElementType, flatten: boolean, style: UniElementStyles): UniElement
+    createViewElement(flatten: boolean, style?: UniElementStyles | null): UniViewElement
+    createTextElement(flatten: boolean, style?: UniElementStyles | null): UniTextElement
+    createImageElement(flatten: boolean, style?: UniElementStyles | null): UniImageElement
+    createComment(data: string): UniElement
+
+    /**
+     * 创建原生View
+     * @param flatten 原生View是否被拍平（扁平化），true表示可拍平，false表示不可拍平，默认值false
+     */
+    createNativeView(flatten: boolean): UniNativeView
+    createNativeTextView(flatten: boolean): UniNativeTextView
+    createNativeImageView(flatten: boolean): UniNativeImageView
+    createNativeScrollView(options: UniNativeScrollViewOptions, flatten: boolean): UniNativeScrollView
+    createNativeCustomView(flatten: boolean): UniNativeCustomView
+    // 废弃通过类型创建NativeView的API，改用上面创建指定类型的原生View
+    // createNativeView(type: UniNativeViewType, flatten: boolean): UniNativeBaseView
+    // createNativeView<T extends UniNativeBaseView>(type: UniNativeViewType, flatten: boolean): T
+
+
+    /**
+     * 定义CSS变量
+     * @param key - css变量名称
+     * @param value - css变量值，空字符串则表示移除变量定义
+     */
+    defineStyleVariable(key: string, value: string): void
+  }
+}

package/types/dom2/UniScrollViewElement.d.ts

@@ -0,0 +1,13 @@
+import { UniElement } from './UniElement'
+
+declare global {
+
+  /**
+   * UniScrollViewElement
+   */
+  interface UniScrollViewElement extends UniElement {
+
+
+  }
+}
+

package/types/dom2/UniTextElement.d.ts

@@ -0,0 +1,20 @@
+import { UniElement } from './UniElement'
+import { UniTextLayout } from './index'
+
+
+declare global {
+  /**
+   * UniTextElement
+   */
+  interface UniTextElement extends UniElement {
+
+    /**
+     * 设置文本内容
+     *  Android平台仅在kotlin层实现，用于开放给开发者使用
+     *  鸿蒙/iOS平台的在c层实现，设置后需同步更新给NativeView
+     *  鸿蒙/iOS平台在ArkTS/Swift包装调用c层的实现
+     */
+    setLayoutText(text: UniTextLayout): void;
+  }
+}
+