@lynx-js/types 3.4.3 → 3.5.9

package/types/common/element/methods.d.ts

@@ -3,82 +3,239 @@
 // LICENSE file in the root directory of this source tree.
 
 import { BaseMethod, Callback } from '../events';
-import { AutoScrollMethod, ScrollToPositionMethod } from './list';
-import { ScrollToMethod } from './scroll-view';
+import { AutoScrollMethod, ListUIMethods } from './list';
+import {  ScrollViewUIMethods } from './scroll-view';
 
-export type ListParams = ScrollToPositionMethod;
+export type ListParams = ListUIMethods;
 
-export type ScrollViewParams = ScrollToMethod | AutoScrollMethod;
+export type ScrollViewParams = ScrollViewUIMethods | AutoScrollMethod;
 
+/**
+ * Call this method to get the width, height, and position information of the target element.
+ * @Android
+ * @iOS
+ * @Harmony
+ * @PC
+ */
 interface BoundingClientRectMethod extends BaseMethod {
   method: 'boundingClientRect';
+  params: {
+    /**
+     * The element to which the coordinates are relative. If not specified, the coordinates are relative to the viewport. If the value is `screen`, the coordinates are relative to the screen. If the value is a element's `id`, the coordinates are relative to the element with the specified ID. Else, the coordinates are relative to the viewport of LynxView.
+     * @defaultValue null
+     * @iOS
+     * @Harmony
+     * @Android
+     */
+    relativeTo?: 'screen' | string | null;
+    /**
+     * Whether to enable transform props on Android, it is recommended to set it to `true` when the element has transform props.
+     * @defaultValue false
+     * @Android
+     */
+    androidEnableTransformProps?: boolean;
+  };
   success?: Callback<{
     /**
-     *  Node ID.
+     * The id of the element 
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     id: string;
 
     /**
-     *  Dataset of nodes.
+     *  Dataset of the element.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     dataset: object;
 
     /**
-     * Left boundary coordinate of the node (in pixels)
+     * Left boundary coordinate of the element (in pixels)
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     left: number;
 
     /**
-     *  The right boundary coordinates of the node.
+     *  The right boundary coordinates of the element.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     right: number;
 
     /**
-     *  Upper boundary coordinate of the node.
+     *  Upper boundary coordinate of the element.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     top: number;
 
     /**
-     *  The lower boundary coordinates of the node
+     *  The lower boundary coordinates of the element.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     bottom: number;
 
     /**
-     *  Width of the node.
+     *  Width of the element.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     width: number;
 
     /**
-     * height of the node.
+     * height of the element.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
      */
     height: number;
   }>;
 }
 
+/**
+ * Call this method to take a screenshot of the element.
+ * @Android
+ * @iOS
+ * @Harmony
+ * @PC
+ */
+interface TakeScreenShotMethod extends BaseMethod {
+  method: 'takeScreenshot';
+  params: {
+    /**
+     * Specify the image format.
+     * @defaultValue 'jpeg'
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
+     */
+    format: 'jpeg' | 'png';
+    /**
+     * Specify the image quality, within [0, 1], the smaller the value, the blurrier and smaller the size.
+     * @defaultValue 1
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
+     */
+    scale?: number;
+  };
+  success?: Callback<{
+    /**
+     * The base64-encoded string of the screenshot image.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
+     */
+    data: string;
+  }>;
+}
+
+/**
+ * Set the element to require focus
+ * @PC
+ */
 interface SetFocusMethod extends BaseMethod {
   method: 'setFocus';
   params: {
-    /**  Set whether the element gains focus, `false` means the element loses focus.*/
+    /**
+     * Set whether the element gains focus, `false` means the element loses focus.
+     * @PC
+     */
     focus: boolean;
-    /**   Whether to scroll the element into the visible area at the same time, default is `true`.*/
+    /**
+     * Whether to scroll the element into the visible area at the same time, default is `true`.
+     * @PC
+     */
     scroll?: boolean;
   };
 }
 
+/**
+ * Call this method to request accessibility focus for the element.
+ * @Android
+ * @iOS
+ */
+interface RequestAccessibilityFocusMethod extends BaseMethod {
+  method: 'requestAccessibilityFocus';
+}
+
+/**
+ * Call this method to check if the element is currently animating.
+ * @deprecated Legacy API
+ */
 interface IsAnimatingMethod extends BaseMethod {
   method: 'isAnimating';
   success?: Callback<{ data: boolean }>;
 }
 
+/**
+ * Call this method to scroll the element into the visible area.
+ * @Android
+ * @iOS
+ * @Harmony
+ * @PC
+ */
 interface ScrollIntoViewMethod extends BaseMethod {
   method: 'scrollIntoView';
   params: {
+    /**
+     * Specify the scroll options.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
+     */
     scrollIntoViewOptions: {
-      block: 'start' | 'center' | 'end';
-      inline: 'start' | 'center' | 'end';
-      behavior?: 'smooth';
+      /**
+       * Vertical alignment options: "start" aligns top | "center" centers | "end" aligns bottom
+       * @defaultValue 'center'
+       * @Android
+       * @iOS
+       * @Harmony
+       * @PC
+       */
+      block?: 'start' | 'center' | 'end';
+      /**
+       * Horizontal alignment options: "start" aligns left | "center" centers | "end" aligns right
+       * @defaultValue 'start'
+       * @Android
+       * @iOS
+       * @Harmony
+       * @PC
+       */
+      inline?: 'start' | 'center' | 'end';
+      /**
+       * Specify the scroll behavior.
+       * @defaultValue 'smooth'
+       * @Android
+       * @iOS
+       * @Harmony
+       * @PC
+       */
+      behavior?: 'smooth' | 'none';
     };
   };
 }
 
-export type InvokeParams = ListParams | ScrollViewParams | BoundingClientRectMethod | SetFocusMethod | IsAnimatingMethod | ScrollIntoViewMethod;
+export type InvokeParams = ListParams | ScrollViewParams | BoundingClientRectMethod | SetFocusMethod | IsAnimatingMethod | ScrollIntoViewMethod | TakeScreenShotMethod | RequestAccessibilityFocusMethod;

package/types/common/element/scroll-view.d.ts

@@ -4,7 +4,6 @@
 
 import { BaseEvent, BaseMethod, EventHandler } from '../events';
 import { StandardProps } from '../props';
-import { AutoScrollMethod } from './list';
 import {
   ContentSizeChangedEvent,
   ScrollEndEvent,
@@ -18,172 +17,101 @@ import {
 } from './common';
 
 export interface ScrollViewProps extends StandardProps {
-  /**
-   * Scroll horizontaly.
-   * @defaultValue false
-   * @since 1.4
-   * @iOS
-   * @Android
-   * @H
-   */
-  'scroll-x'?: boolean;
-
-  /**
-   * Scroll vertically
-   * @defaultValue false
-   * @since 1.4
-   * @iOS
-   * @Android
-   * @H
-   */
-  'scroll-y'?: boolean;
-
   /**
    * Replacement of scroll-x and scroll-y
+   * @defaultValue 'vertical'
    * @since 3.0
    * @iOS
    * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
   'scroll-orientation'?: 'vertical' | 'horizontal';
 
   /**
    * Enable bounce effect
-   * @defaultValue false
+   * @defaultValue true
    * @since 1.4
    * @iOS
-   * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
   bounces?: boolean;
 
   /**
    * Enable dragging
-   * @defaultValue false
+   * @defaultValue true
    * @since 1.4
    * @iOS
    * @Android 2.2
-   * @H
+   * @Harmony
+   * @PC
    */
   'enable-scroll'?: boolean;
 
   /**
    * Enable scrollbar
-   * @defaultValue false
+   * @defaultValue true
    * @since 1.4
    * @iOS
-   * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
   'scroll-bar-enable'?: boolean;
 
   /**
-   * Not recommended to use. Please use upper-threshold-item-count instead. Set upper threshold to bindscrolltoupper event.
+   * Set upper threshold to bindscrolltoupper event.
    * @defaultValue 0
    * @since 1.4
    * @iOS
    * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
   'upper-threshold'?: number;
 
   /**
-   * Not recommended to use. Please use lower-threshold-item-count instead. Set upper threshold to bindscrolltoupper event.
+   * Set upper threshold to bindscrolltoupper event.
    * @defaultValue 0
    * @since 1.4
    * @iOS
    * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
   'lower-threshold'?: number;
 
   /**
-   * Please use initial-scroll-offset or ScrollTo method. Set the content offset from the top.
-   * @defaultValue 0
-   * @since 1.4
-   * @deprecated 2.17
-   * @iOS
-   * @Android
-   * @H
-   */
-  'scroll-top'?: number;
-
-  /**
-   * Please use initial-scroll-offset or ScrollTo method. Set the content offset from the left.
-   * @defaultValue 0
-   * @since 1.4
-   * @deprecated 2.17
-   * @iOS
-   * @Android
-   * @H
-   */
-  'scroll-left'?: number;
-
-  /**
-   * Initial scroll position, only effective once
+   * Initial scroll position, only effective once, in PX
    * @defaultValue 0
    * @since 2.17
    * @iOS
    * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
   'initial-scroll-offset'?: number;
 
-  /**
-   * Please use initial-scroll-index or ScrollTo method。Set the first item at the first screen
-   * @defaultValue 0
-   * @since 2.1
-   * @deprecated 2.17
-   * @iOS
-   * @Android
-   */
-  'scroll-to-index'?: number;
-
   /**
    * Scroll to specified child node on first screen, only effective once. All direct child nodes must be flatten=false.
    * @defaultValue 0
    * @since 2.17
    * @iOS
    * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
   'initial-scroll-to-index'?: number;
 
-  /**
-   * On iOS, force-can-scroll should be used with ios-block-gesture-class and ios-recognized-view-tag. Can be used alone on Android.
-   * @defaultValue false
-   * @since 2.10.1
-   * @iOS
-   * @Android
-   * @H
-   */
-  'force-can-scroll'?: boolean;
-
-  /**
-   * Force-can-scroll should be used with ios-block-gesture-class、ios-recognized-view-tag. Specify the class name of scrollable container that should be blocked by force-can-scroll. Given by container's developer.
-   * @defaultValue none
-   * @since 2.10.1
-   * @iOS
-   */
-  'ios-block-gesture-class'?: string;
-
-  /**
-   *  force-can-scroll should be used with ios-block-gesture-class、ios-recognized-view-tag. Specify scrollable container's tag, the UIView's tag. Set and given by container's developer.
-   * @defaultValue none
-   * @since 2.10.1
-   * @iOS
-   */
-  'ios-recognized-view-tag'?: number;
-
   /**
    * This event is triggered when the upper/left edge of the scrolling area intersects with the visible area defined by the upperThreshold.
    * @defaultValue none
    * @since 1.4
    * @iOS
    * @Android
-   * @H
+   * @Harmony
    */
-  bindscrolltoupper?: EventHandler<ScrollToUpperEvent>;
+  bindscrolltoupper?: (e: ScrollToUpperEvent) => void;
 
   /**
    * This event is triggered when the lower/right edge of the scrolling area intersects with the visible area defined by the lowerThreshold.
@@ -191,9 +119,9 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.4
    * @iOS
    * @Android
-   * @H
+   * @Harmony
    */
-  bindscrolltolower?: EventHandler<ScrollToLowerEvent>;
+  bindscrolltolower?: (e: ScrollToLowerEvent) => void;
 
   /**
    * This event is triggered when the scrollview is scrolling.
@@ -201,9 +129,10 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.4
    * @iOS
    * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
-  bindscroll?: EventHandler<ScrollEvent>;
+  bindscroll?: (e: ScrollEvent) => void;
 
   /**
    * This event is triggered when the scrollview's scroll ended.
@@ -211,9 +140,10 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.6
    * @iOS
    * @Android
-   * @H
+   * @Harmony
+   * @PC
    */
-  bindscrollend?: EventHandler<ScrollEndEvent>;
+  bindscrollend?: (e: ScrollEndEvent) => void;
 
   /**
    * This event is triggered when the scrollview's content size changed.
@@ -221,42 +151,19 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.6
    * @iOS
    * @Android
-   * @H
-   */
-  bindcontentsizechanged?: EventHandler<ContentSizeChangedEvent>;
-
-  /**
-   * scrollview scrolls to upper edge
-   * @defaultValue none
-   * @since 3.0
-   * @iOS
-   * @Android
-   * @H
+   * @Harmony
    */
-  bindscrolltoupperedge?: EventHandler<ScrollToUpperEdgeEvent>;
-
-  /**
-   * scrollview scrolls to lower edge
-   * @defaultValue none
-   * @since 3.0
-   * @iOS
-   * @Android
-   * @H
-   */
-  bindscrolltoloweredge?: EventHandler<ScrollToLowerEdgeEvent>;
-
-  /**
-   * scrollview scrolls to normal position. Not at upper or lower edge
-   * @defaultValue none
-   * @since 3.0
-   * @iOS
-   * @Android
-   * @H
-   */
-  bindscrolltonormalstate?: EventHandler<ScrollToNormalStateEvent>;
+  bindcontentsizechanged?: (e: ContentSizeChangedEvent) => void;
 }
 
-export interface ScrollToMethod extends BaseMethod {
+/**
+ * Scroll to specified position
+ * @Android
+ * @iOS
+ * @Harmony
+ * @PC
+ */
+export interface ScrollViewScrollToMethod extends BaseMethod {
   method: 'scrollTo';
   params: {
     /**
@@ -277,4 +184,52 @@ export interface ScrollToMethod extends BaseMethod {
   };
 }
 
-export type ScrollViewUIMethods = ScrollToMethod | AutoScrollMethod;
+/**
+ * Scroll by specified offset
+ * @Android
+ * @iOS
+ * @Harmony
+ * @PC
+ */
+export interface ScrollViewScrollByMethod extends BaseMethod {
+  method: 'scrollBy';
+  params: {
+    /**
+     * Offset to scroll
+     */
+    offset?: number;
+  };
+}
+
+
+
+/**
+ * Automatic scrolling
+ * @Android
+ * @iOS
+ * @Harmony
+ * @PC
+ */
+export interface ScrollViewAutoScrollMethod extends BaseMethod {
+  method: 'autoScroll';
+  params: {
+    /**
+     *  The distance of each second's scrolling, which supports positive and negative values. The unit of distance can be "px", "rpx", "ppx", or null (for iOS, the value must be greater than 1/screen.scale px).
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
+     */
+    rate: number;
+    /**
+     * Start/stop automatic scrolling.
+     * @Android
+     * @iOS
+     * @Harmony
+     * @PC
+     */
+    start: boolean;
+  };
+}
+
+export type ScrollViewUIMethods = ScrollViewScrollToMethod | ScrollViewScrollByMethod | ScrollViewAutoScrollMethod;

package/types/common/element/text.d.ts

@@ -11,14 +11,16 @@ import { StandardProps } from '../props';
 export interface TextProps extends StandardProps {
   /**
    * Maximum number of lines for text display
-   * @defaultValue "-1"
+   * @Android
+   * @iOS
+   * @Harmony
+   * @PC
    * @since 1.0
    */
   'text-maxline'?: string;
 
   /**
    * Maximum number of characters for text display
-   * @defaultValue ""
    * @since 1.0
    * @deprecated Suggest preprocessing the text content length.
    */
@@ -27,6 +29,7 @@ export interface TextProps extends StandardProps {
   /**
    * Whether font-size is affected by system font scaling
    * @defaultValue false
+   * @deprecated
    * @since 1.6
    */
   'enable-font-scaling'?: boolean;
@@ -42,15 +45,18 @@ export interface TextProps extends StandardProps {
   /**
    * By default, if text truncation occurs, the color of the inserted ... will be specified by the style on the nearest inline-text. If this attribute is enabled, the color of ... will be specified by the style on the outermost text tag.
    * @defaultValue false
+   * @Android
+   * @iOS
    * @since 2.0
    */
   'tail-color-convert'?: boolean;
 
   /**
    * Set single-line plain text to be centered and aligned within the line. Inline text settings are not supported. Recommended only when the default font doesn't meet center alignment needs, as it increases text measurement time.
-   * @defaultValue normal
+   * @defaultValue 'normal'
    * @iOS
    * @Android
+   * @PC
    * @since 2.12
    */
   'text-single-line-vertical-align'?: 'normal' | 'bottom' | 'center' | 'top';
@@ -110,11 +116,17 @@ export interface TextProps extends StandardProps {
   /**
    * Text layout event
    * @since 2.7
+   * @Android
+   * @iOS
+   * @Harmony
+   * @PC
    */
   bindlayout?: (e: LayoutEvent) => void;
 
   /**
    * Text selection change event
+   * @Android
+   * @iOS
    * @since 2.18
    */
   bindselectionchange?: (e: SelectionChangeEvent) => void;
@@ -205,6 +217,7 @@ interface SetTextSelectionMethod extends BaseMethod {
  * Gets the bounding rectangle of the text.
  * @Android
  * @iOS
+ * @PC
  * @since 2.18
  */
 interface GetTextBoundingRectMethod extends BaseMethod {

package/types/common/element/textarea.d.ts

@@ -152,7 +152,7 @@ export interface TextAreaProps extends Omit<StandardProps, 'bindfocus' | 'bindbl
    */
   'line-spacing'?: number | `${number}px` | `${number}rpx`;
   /**
-   * Interaction enabled
+   * Readonly
    * @defaultValue false
    * @Android
    * @iOS
@@ -162,6 +162,16 @@ export interface TextAreaProps extends Omit<StandardProps, 'bindfocus' | 'bindbl
    */
   readonly?: boolean;
 
+  /**
+   * Interaction enabled
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @Harmony
+   * @since 3.5
+   */
+  disabled?: boolean;
+
   /**
    * Show soft input keyboard while focused
    * @defaultValue true