@lynx-js/types 3.3.1 → 3.4.3

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

@@ -12,11 +12,15 @@ import { PageProps } from './page';
 import { ScrollViewProps, ScrollViewUIMethods } from './scroll-view';
 import { TextProps } from './text';
 import { ViewProps } from './view';
+import { InputProps, InputUIMethods } from './input';
+import { TextAreaProps, TextAreaUIMethods } from './textarea';
 
 export interface UIMethods {
   'list': ListUIMethods;
   'scroll-view': ScrollViewUIMethods;
   'image': ImageUIMethods;
+  'input': InputUIMethods;
+  'textarea': TextAreaUIMethods;
 }
 
 type LynxComponentProps = ComponentProps;
@@ -37,6 +41,8 @@ export interface IntrinsicElements {
   'text': TextProps;
   'view': ViewProps;
   'raw-text': StandardProps & { text: number | string };
+  'input': InputProps;
+  'textarea': TextAreaProps;
 }
 
 declare module 'react' {
@@ -57,6 +63,8 @@ declare module 'react' {
       'text': TextProps;
       'view': ViewProps;
       'raw-text': StandardProps & { text: number | string };
+      'input': InputProps;
+      'textarea': TextAreaProps;
     }
   }
 }

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

@@ -117,6 +117,15 @@ export interface ImageProps extends StandardProps {
    */
   'autoplay'?: boolean;
 
+  /**
+   * Image animation property. If set to false, images will not be cached. Each image will be discarded by default after use,
+   * which is suitable for scenarios where the animation needs to play only once.
+   * @defaultValue true
+   * @iOS
+   * @since 3.4
+   */
+  'ios-frame-cache-automatically'?: boolean;
+
   /**
    * Changes the color of all non-transparent pixels to the tint-color specified. The value is a <color>.
    * @defaultValue ""

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

@@ -10,6 +10,8 @@ export * from './page';
 export * from './scroll-view';
 export * from './text';
 export * from './view';
+export * from './input';
+export * from './textarea';
 export * from './element';
 export * from './methods';
 export * from './attributes';

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

@@ -0,0 +1,378 @@
+import { BaseEvent, BaseMethod, Callback } from '../events';
+import { StandardProps } from '../props';
+
+export interface InputFocusEvent {
+  /**
+   * Input content
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  value: string;
+}
+
+export interface InputBlurEvent {
+  /**
+   * Input content
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  value: string;
+}
+
+export interface InputConfirmEvent {
+  /**
+   * Input content
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  value: string;
+}
+
+export interface InputInputEvent {
+  /**
+   * Input content
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  value: string;
+  /**
+   * The start position of the selection
+   * @Android
+   * @iOS
+   * @Harmony
+     * @Web
+   * @since 3.4
+   */
+  selectionStart: number;
+  /**
+   * The end position of the selection
+   * @Android
+   * @iOS
+   * @Harmony
+     * @Web
+   * @since 3.4
+   */
+  selectionEnd: number;
+  /**
+   * Is composing or not
+   * @iOS
+   * @Android
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  isComposing?: boolean;
+}
+
+export interface InputSelectionEvent {
+  /**
+   * The start position of the selection
+   * @Android
+   * @iOS
+   * @Harmony
+     * @Web
+   * @since 3.4
+   */
+  selectionStart: number;
+  /**
+   * The end position of the selection
+   * @Android
+   * @iOS
+   * @Harmony
+     * @Web
+   * @since 3.4
+   */
+  selectionEnd: number;
+}
+
+export interface InputProps extends Omit<StandardProps, 'bindfocus' | 'bindblur'> {
+  /**
+   * Placeholder
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  placeholder?: string
+  /**
+   * The type of confirm button
+   * @defaultValue 'send'
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  'confirm-type'?: 'send' | 'search' | 'go' | 'done' | 'next';
+  /**
+   * Max input length
+   * @defaultValue 140
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  maxlength?: number;
+  /**
+   * Interaction enabled
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  readonly?: boolean;
+
+  /**
+   * Show soft input keyboard while focused
+   * @defaultValue true
+   * @Android
+   * @iOS
+   * @Harmony
+   * @since 3.4
+   */
+  'show-soft-input-on-focus'?: boolean;
+
+  /**
+   * Filter the input content and process it in the form of regular expressions
+   * @defaultValue undefined
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  'input-filter'?: string;
+
+  /**
+   * Input content type
+   * @defaultValue "text"
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  type?: 'text' | 'number' | 'digit' | 'password' | 'tel' | 'email';
+
+  /**
+   * Auto correct input content on iOS
+   * @defaultValue true
+   * @iOS
+   * @since 3.4
+   */
+  'ios-auto-correct'?: boolean;
+
+  /**
+   * Check spelling issue on iOS
+   * @defaultValue true
+   * @iOS
+   * @Web
+   * @since 3.4
+   */
+  'ios-spell-check'?: boolean;
+
+  /**
+   * Whether to enter the full-screen input mode when in landscape screen, in which the keyboard and input box will take up the entire screen
+   * @defaultValue true
+   * @Android
+   * @since 3.4
+   */
+  'android-fullscreen-mode'?: boolean;
+
+  /**
+   * Focused
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindfocus?: (e: BaseEvent<'bindfocus', InputFocusEvent>) => void;
+
+  /**
+   * Blurred
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindblur?: (e: BaseEvent<'bindblur', InputBlurEvent>) => void;
+
+  /**
+   * Confirm button clicked
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindconfirm?: (e: BaseEvent<'bindconfirm', InputConfirmEvent>) => void;
+
+  /**
+   * Input content changed
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindinput?: (e: BaseEvent<'bindinput', InputInputEvent>) => void;
+
+  /**
+   * Input selection changed
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindselection?: (e: BaseEvent<'bindselection', InputSelectionEvent>) => void;
+}
+
+/**
+ * Require focus
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface InputFocusMethod extends BaseMethod {
+  method: 'focus';
+}
+
+/**
+ * Release focus
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface InputBlurMethod extends BaseMethod {
+  method: 'blur';
+}
+
+/**
+ * Get input content
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface InputGetValueMethod extends BaseMethod {
+  method: 'getValue';
+  success?: Callback<{
+    /**
+     * Input content
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    value: string;
+    /**
+     * Begin position of the selection
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    selectionStart: number;
+    /**
+     * End position of the selection
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    selectionEnd: number;
+    /**
+     * Is composing or not, iOS only
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    isComposing: boolean;
+  }>;
+}
+
+/**
+ *  Set input content
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface InputSetValueMethod extends BaseMethod {
+  method: 'setValue';
+  params: {
+    /**
+     * Input content
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    value: string;
+  };
+}
+
+/**
+ * Set selection range
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface InputSetSelectionRangeMethod extends BaseMethod {
+  method: 'setSelectionRange';
+  params: {
+    /**
+     * Start position of the selection
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    selectionStart: number;
+    /**
+     * End position of the selection
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    selectionEnd: number;
+  };
+}
+
+export type InputUIMethods = InputFocusMethod | InputBlurMethod | InputGetValueMethod | InputSetValueMethod | InputSetSelectionRangeMethod;

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
@@ -785,7 +818,7 @@ export interface ListProps extends StandardProps {
    */
   'enable-nested-scroll'?: boolean;
 
-   
+
   /**
    * NestedScrollOptions for scrollForward
    * @since 3.0

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';
 
 /**
@@ -46,13 +46,6 @@ export interface TextProps extends StandardProps {
    */
   '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
@@ -87,11 +80,168 @@ 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
    */
   bindlayout?: (e: LayoutEvent) => void;
+
+  /**
+   * Text selection change event
+   * @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
+ * @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;