@lynx-js/types 3.3.1 → 3.3.2

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

@@ -338,14 +338,14 @@ export interface LayoutCompleteEvent extends BaseEvent<'layoutcomplete', {}> {
      * @Android
      * @H
      */
-    visibleCellsAfterUpdate?: ListItemInfo[];
+    visibleItemAfterUpdate?: ListItemInfo[];
     /**
      * Cell info of the list before layout.
      * @iOS
      * @Android
      * @H
      */
-    visibleCellsBeforeUpdate?: ListItemInfo[];
+    visibleItemBeforeUpdate?: ListItemInfo[];
     /**
      * The scroll info after layout.
      * @iOS
@@ -516,6 +516,22 @@ export interface ListProps extends StandardProps {
    */
   'sticky-offset'?: number;
 
+  /**
+   * The property to control whether recycle sticky item. The default value is true if sdk version >= 3.4 and false if sdk version < 3.4.
+   * @defaultValue false
+   * @Android
+   * @iOS
+   */
+  'experimental-recycle-sticky-item'?: boolean;
+
+  /**
+   * The property to set the capacity of sticky item cache. The default value is 1 if thread mode is ALL_ON_UI and 2 if thread mode is MOST_ON_TASM / PART_ON_LAYOUT / MULTI_THREADS.
+   * @defaultValue 1
+   * @Android
+   * @iOS
+   */
+  'sticky-buffer-count'?: number;
+
   /**
    * When enabled, the upper or lower element will also be shifted together with the bounces effect.
    * @defaultValue false
@@ -691,6 +707,14 @@ export interface ListProps extends StandardProps {
    */
   'upper-threshold-item-count'?: number;
 
+  /**
+   * The property to control whether to update sticky item for diff. The default value is true if sdk version >= 3.4 and false if sdk version < 3.4.
+   * @defaultValue false
+   * @Android
+   * @iOS
+   */
+  'experimental-update-sticky-for-diff'?: boolean;
+
   /**
    * During a single sliding process, when the upper_distance is first smaller than the value specified by upper-threshold, a scrolltoupper event is triggered. When upper_distance is already smaller than the value specified by upper-threshold, the scrolltoupper event will no longer be triggered.
    * @defaultValue  50
@@ -715,6 +739,15 @@ export interface ListProps extends StandardProps {
    */
   'needs-visible-cells'?: boolean;
 
+  /**
+   * Control whether the list recycle available items before layout, so list can reuse these items in this layout pass. By default, the list will recycle all items after layout.
+   * @defaultValue  false
+   * @Android
+   * @iOS
+   * @Harmony
+   */
+  'experimental-recycle-available-item-before-layout'?: boolean;
+
    /**
    * Control whether the 'attachedCells' is included in the scroll event callback parameters on native list.
    * @defaultValue  false
@@ -724,6 +757,15 @@ export interface ListProps extends StandardProps {
    */
     'need-visible-item-info'?: boolean;
 
+   /**
+    * Control whether the span count can be dynamically switched. The default value is true. If set to true, the list will try to maintain stability of layout, and if set to false, the list will layout from the first list-item.
+    * @defaultValue true
+    * @Android
+    * @iOS
+    * @Harmony
+    */
+    'enable-dynamic-span-count'?: boolean;
+
   /**
    * Specify the callback frequency of the scroll event by passing in a value, which specifies how many milliseconds (ms) <list> will call the scroll callback event during scrolling.
    * @defaultValue  200
@@ -785,7 +827,7 @@ export interface ListProps extends StandardProps {
    */
   'enable-nested-scroll'?: boolean;
 
-   
+
   /**
    * NestedScrollOptions for scrollForward
    * @since 3.0

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

@@ -4,11 +4,11 @@
 
 import { BaseMethod, Callback } from '../events';
 import { AutoScrollMethod, ScrollToPositionMethod } from './list';
-import { ScrollToMethod } from './scroll-view';
+import {  ScrollViewUIMethods } from './scroll-view';
 
 export type ListParams = ScrollToPositionMethod;
 
-export type ScrollViewParams = ScrollToMethod | AutoScrollMethod;
+export type ScrollViewParams = ScrollViewUIMethods | AutoScrollMethod;
 
 interface BoundingClientRectMethod extends BaseMethod {
   method: 'boundingClientRect';

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

@@ -2,7 +2,7 @@
 // Licensed under the Apache License Version 2.0 that can be found in the
 // LICENSE file in the root directory of this source tree.
 
-import { BaseEvent, TextLayoutEventDetail } from '../events';
+import { BaseEvent, Callback, BaseMethod, TextLayoutEventDetail, TextSelectionChangeEventDetail } from '../events';
 import { StandardProps } from '../props';
 
 /**
@@ -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,22 +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;
 
-  /**
-   * Enable long press to select text
-   * @defaultValue false
-   * @since 2.5
-   */
-  'text-selection'?: 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';
@@ -87,11 +86,175 @@ export interface TextProps extends StandardProps {
    */
   'text-fake-bold'?: boolean;
 
+  /**
+   * Sets whether to enable text selection.
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @since 2.18
+   */
+  'text-selection'?: boolean;
+
+  /**
+   * Used to set whether to turn on the custom pop-up context menu after selection and copying. It takes effect after enabling text-selection.
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @since 2.18
+   */
+  'custom-context-menu'?: boolean;
+
+  /**
+   * Used to set whether to enable the custom text selection function. When it is enabled, the element will no longer handle the gesture logic related to selection and copying. It takes effect after enabling text-selection.
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @since 2.18
+   */
+  'custom-text-selection'?: boolean;
+
   /**
    * 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;
 }
 
 export type LayoutEvent = BaseEvent<'layout', TextLayoutEventDetail>;
+
+export type SelectionChangeEvent = BaseEvent<
+  'selectionchange',
+  TextSelectionChangeEventDetail
+>;
+
+interface Rect {
+  left: number;
+  right: number;
+  top: number;
+  bottom: number;
+  width: number;
+  height: number;
+}
+
+interface Handle {
+  /**
+   * Center X of handle
+   */
+  x: number;
+  /**
+   * Center Y of handle
+   */
+  y: number;
+  /**
+   * Touch radius of the handle
+   */
+  radius: number;
+}
+
+/**
+ * Sets the text selection.
+ * @Android
+ * @iOS
+ * @since 2.18
+ */
+interface SetTextSelectionMethod extends BaseMethod {
+  method: 'setTextSelection';
+  params: {
+    /**
+     *  X-coordinate of the selection start relative to the element
+     */
+    startX: number;
+    /**
+     *  Y-coordinate of the selection start relative to the element
+     */
+    startY: number;
+    /**
+     *  X-coordinate of the selection end relative to the element
+     */
+    endX: number;
+    /**
+     *  Y-coordinate of the selection end relative to the element
+     */
+    endY: number;
+    /**
+     * Whether to show the start handle, default is true
+     */
+    showStartHandle?: boolean;
+    /**
+     * Whether to show the end handle, default is true
+     */
+    showEndHandle?: boolean;
+  };
+  success?: Callback<{
+    /**
+     * Bounding rectangle of the selected text
+     */
+    boundingRect: Rect;
+    /**
+     * Rectangles of the selected text
+     */
+    boxes: Rect[];
+    /**
+     * Handles of the selected text
+     */
+    handles: Handle[]
+  }>;
+}
+
+/**
+ * Gets the bounding rectangle of the text.
+ * @Android
+ * @iOS
+ * @PC
+ * @since 2.18
+ */
+interface GetTextBoundingRectMethod extends BaseMethod {
+  method: 'getTextBoundingRect';
+  params: {
+    /**
+     * Start index of the text
+     */
+    start: number;
+    /**
+     * End index of the text
+     */
+    end: number;
+  };
+  success?: Callback<{
+    /**
+     * Bounding rectangle of the text
+     */
+    boundingRect: Rect;
+    /**
+     * Rectangles of the text
+     */
+    boxes: Rect[];
+  }>;
+}
+
+/**
+ * Gets the selected text.
+ * @Android
+ * @iOS
+ * @since 2.18
+ */
+interface GetSelectedTextMethod extends BaseMethod {
+  method: 'getSelectedText';
+  success?: Callback<{
+    selectedText: string;
+  }>;
+}
+
+export type TextUIMethods = SetTextSelectionMethod | GetTextBoundingRectMethod | GetSelectedTextMethod;