@lynx-js/types 3.3.2 → 3.4.3

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

@@ -11,11 +11,7 @@ import { StandardProps } from '../props';
 export interface ImageProps extends StandardProps {
   /**
    * Supports http/https/base64
-   * @defaultValue undefined
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
+   * @defaultValue ""
    * @since 0.2
    */
   src?: string;
@@ -26,12 +22,8 @@ export interface ImageProps extends StandardProps {
    * aspectFit: Scales the image while preserving aspect ratio so that the long side is fully visible
    * aspectFill: Scales the image while preserving aspect ratio, ensuring the short side fills the element
    * center: Does not scale the image; image is centered
-   * @defaultValue 'scaleToFill'
+   * @defaultValue "scaleToFill"
    * @since 0.2
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
    */
   mode?: 'scaleToFill' | 'aspectFit' | 'aspectFill' | 'center';
 
@@ -39,93 +31,72 @@ export interface ImageProps extends StandardProps {
    * ARGB_8888: 32-bit memory per pixel, supports semi-transparent images
    * RGB_565: 16-bit memory per pixel, reduces memory usage but loses transparency
    * @defaultValue "ARGB_8888"
-   * @Android
    * @since 1.4
    */
   'image-config'?: 'ARGB_8888' | 'RGB_565';
 
   /**
    * Placeholder image, used same as src
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
+   * @defaultValue ""
    * @since 1.4
    */
   placeholder?: string;
 
   /**
    * Image blur radius
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
+   * @defaultValue "3px"
    * @since 0.2
    */
   'blur-radius'?: string;
 
   /**
    * Stretchable area for 9patch images, in percentage or decimal, four values for top, right, bottom, left
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
+   * @defaultValue "0.2 10% 0.3 20%"
    * @since 1.4
    */
   'cap-insets'?: string;
 
   /**
-   * Adjust the scale of stretchable area for 9patch images
+   * Number of times an animated image plays
    * @defaultValue 1
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
-   * @since 1.4
-   */
-  'cap-insets-scale'?: number;
-
-  /**
-   * Number of times an animated image plays, 0 stands for infinite 
-   * @defaultValue 0
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
    * @since 1.4
    */
   'loop-count'?: number;
 
   /**
    * Image won't load if its size is 0, but will load if prefetch-width is set
-   * @defaultValue "0px"
-   * @deprecated
-   * @iOS
-   * @Android
+   * @defaultValue "100px"
    * @since 1.4
    */
   'prefetch-width'?: string;
 
   /**
    * Image won't load if its size is 0, but will load if prefetch-height is set
-   * @defaultValue "0px"
-   * @deprecated
-   * @iOS
-   * @Android
+   * @defaultValue "100px"
    * @since 1.4
    */
   'prefetch-height'?: string;
 
+  /**
+   * If true, URL mapping is skipped. LynxView's custom ImageInterceptor won't work
+   * @defaultValue false
+   * @since 1.5
+   */
+  'skip-redirection'?: boolean;
+
+  /**
+   * Reduces the chance of OOM by downsampling large images, requires container support
+   * @defaultValue false
+   * @since iOS 2.0
+   */
+  downsampling?: boolean;
+
   /**
    * When set to true and the <image> element has no width or height,
    * the size of the <image> will be automatically adjusted
    * to match the image's original dimensions after the image is successfully loaded,
    * ensuring that the aspect ratio is maintained.
    * @defaultValue false
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
    * @since 2.6
    */
   'auto-size'?: boolean;
@@ -135,10 +106,6 @@ export interface ImageProps extends StandardProps {
    * The default behavior is to clear the image resource before starting a new load.
    * This can resolve flickering issues when the image src is switched and reloaded. It is not recommended to enable this in scenarios where there is node reuse in views like lists.
    * @defaultValue false
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
    * @since 2.7
    */
   'defer-src-invalidation'?: boolean;
@@ -146,42 +113,75 @@ export interface ImageProps extends StandardProps {
   /**
    * Specifies whether the animated image should start playing automatically once it is loaded.
    * @defaultValue true
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
    * @since 2.11
    */
   'autoplay'?: boolean;
 
   /**
-   * Changes the color of all non-transparent pixels to the tint-color specified. The value is a <color>.
+   * 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
-   * @Android
-   * @Harmony
+   * @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 ""
    * @since 2.12
    */
   'tint-color'?: string;
 
+  /**
+   * Support outputting image monitoring information in bindload
+   * @defaultValue false
+   * @since 2.12
+   */
+  'extra-load-info'?: boolean;
+
+  /**
+   * Disables unexpected iOS built-in animations
+   * @defaultValue true
+   * @since iOS 2.0
+   */
+  'implicit-animation'?: boolean;
+
+  /**
+   * Add custom parameters to image
+   * @since 2.17
+   */
+  'additional-custom-info'?: { [key: string]: string };
+
   /**
    * Image load success event
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
    * @since 0.2
    */
   bindload?: (e: LoadEvent) => void;
 
   /**
    * Image load error event
-   * @iOS
-   * @Android
-   * @Harmony
-   * @PC
    * @since 0.2
    */
   binderror?: (e: ErrorEvent) => void;
+
+  /**
+   * The animation will call back when it starts playing.
+   * @since 2.11
+   */
+  bindstartplay?: (e: BaseEvent) => void;
+
+  /**
+   * Call back after one loop time of the animation is played.
+   * @since 2.11
+   */
+  bindcurrentloopcomplete?: (e: BaseEvent) => void;
+
+  /**
+   * It will be called after the animation has been played for all loop-count times. If the loop-count is not set, it will not be called back.
+   * @since 2.11
+   */
+  bindfinalloopcomplete?: (e: BaseEvent) => void;
 }
 
 export type LoadEvent = BaseEvent<'load', ImageLoadEvent>;
@@ -189,10 +189,8 @@ export type ErrorEvent = BaseEvent<'error', ImageErrorEvent>;
 
 /**
  * Restart the animation playback method controlled by the front end, and the animation playback progress and loop count will be reset.
- * @iOS
  * @Android
- * @Harmony
- * @PC
+ * @iOS
  * @deprecated Deprecated. Some scenarios may not call back the call result. It is recommended to use resumeAnimation instead.
  */
 export interface ImageStartAnimMethod extends BaseMethod {
@@ -201,10 +199,8 @@ export interface ImageStartAnimMethod extends BaseMethod {
 
 /**
  * Resumes the animation, without resetting the loop-count.
- * @iOS
  * @Android
- * @Harmony
- * @PC
+ * @iOS
  * @since 2.11
  */
 export interface ImageResumeAnimMethod extends BaseMethod {
@@ -213,10 +209,8 @@ export interface ImageResumeAnimMethod extends BaseMethod {
 
 /**
  * Pauses the animation, without resetting the loop-count.
- * @iOS
  * @Android
- * @Harmony
- * @PC
+ * @iOS
  * @since 2.11
  */
 export interface ImagePauseAnimMethod extends BaseMethod {
@@ -225,10 +219,8 @@ export interface ImagePauseAnimMethod extends BaseMethod {
 
 /**
  * Stops the animation, and it will reset the loop-count.
- * @iOS
  * @Android
- * @Harmony
- * @PC
+ * @iOS
  * @since 2.11
  */
 export interface ImageStopAnimMethod extends BaseMethod {

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

@@ -128,7 +128,7 @@ export interface InputProps extends Omit<StandardProps, 'bindfocus' | 'bindblur'
    */
   maxlength?: number;
   /**
-   * Readonly
+   * Interaction enabled
    * @defaultValue false
    * @Android
    * @iOS
@@ -137,15 +137,7 @@ export interface InputProps extends Omit<StandardProps, 'bindfocus' | 'bindblur'
    * @since 3.4
    */
   readonly?: boolean;
-  /**
-   * Interaction enabled
-   * @defaultValue false
-   * @Android
-   * @iOS
-   * @Harmony
-   * @since 3.5
-   */
-  disabled?: boolean;
+
   /**
    * Show soft input keyboard while focused
    * @defaultValue true

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

@@ -757,15 +757,6 @@ 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

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

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

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

@@ -4,6 +4,7 @@
 
 import { BaseEvent, BaseMethod, EventHandler } from '../events';
 import { StandardProps } from '../props';
+import { AutoScrollMethod } from './list';
 import {
   ContentSizeChangedEvent,
   ScrollEndEvent,
@@ -17,101 +18,172 @@ 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
-   * @Harmony
-   * @PC
+   * @H
    */
   'scroll-orientation'?: 'vertical' | 'horizontal';
 
   /**
    * Enable bounce effect
-   * @defaultValue true
+   * @defaultValue false
    * @since 1.4
    * @iOS
-   * @Harmony
-   * @PC
+   * @Android
+   * @H
    */
   bounces?: boolean;
 
   /**
    * Enable dragging
-   * @defaultValue true
+   * @defaultValue false
    * @since 1.4
    * @iOS
    * @Android 2.2
-   * @Harmony
-   * @PC
+   * @H
    */
   'enable-scroll'?: boolean;
 
   /**
    * Enable scrollbar
-   * @defaultValue true
+   * @defaultValue false
    * @since 1.4
    * @iOS
-   * @Harmony
-   * @PC
+   * @Android
+   * @H
    */
   'scroll-bar-enable'?: boolean;
 
   /**
-   * Set upper threshold to bindscrolltoupper event.
+   * Not recommended to use. Please use upper-threshold-item-count instead. Set upper threshold to bindscrolltoupper event.
    * @defaultValue 0
    * @since 1.4
    * @iOS
    * @Android
-   * @Harmony
-   * @PC
+   * @H
    */
   'upper-threshold'?: number;
 
   /**
-   * Set upper threshold to bindscrolltoupper event.
+   * Not recommended to use. Please use lower-threshold-item-count instead. Set upper threshold to bindscrolltoupper event.
    * @defaultValue 0
    * @since 1.4
    * @iOS
    * @Android
-   * @Harmony
-   * @PC
+   * @H
    */
   'lower-threshold'?: number;
 
   /**
-   * Initial scroll position, only effective once, in PX
+   * 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
    * @defaultValue 0
    * @since 2.17
    * @iOS
    * @Android
-   * @Harmony
-   * @PC
+   * @H
    */
   '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
-   * @Harmony
-   * @PC
+   * @H
    */
   '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
-   * @Harmony
+   * @H
    */
-  bindscrolltoupper?: (e: ScrollToUpperEvent) => void;
+  bindscrolltoupper?: EventHandler<ScrollToUpperEvent>;
 
   /**
    * This event is triggered when the lower/right edge of the scrolling area intersects with the visible area defined by the lowerThreshold.
@@ -119,9 +191,9 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.4
    * @iOS
    * @Android
-   * @Harmony
+   * @H
    */
-  bindscrolltolower?: (e: ScrollToLowerEvent) => void;
+  bindscrolltolower?: EventHandler<ScrollToLowerEvent>;
 
   /**
    * This event is triggered when the scrollview is scrolling.
@@ -129,10 +201,9 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.4
    * @iOS
    * @Android
-   * @Harmony
-   * @PC
+   * @H
    */
-  bindscroll?: (e: ScrollEvent) => void;
+  bindscroll?: EventHandler<ScrollEvent>;
 
   /**
    * This event is triggered when the scrollview's scroll ended.
@@ -140,10 +211,9 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.6
    * @iOS
    * @Android
-   * @Harmony
-   * @PC
+   * @H
    */
-  bindscrollend?: (e: ScrollEndEvent) => void;
+  bindscrollend?: EventHandler<ScrollEndEvent>;
 
   /**
    * This event is triggered when the scrollview's content size changed.
@@ -151,19 +221,42 @@ export interface ScrollViewProps extends StandardProps {
    * @since 1.6
    * @iOS
    * @Android
-   * @Harmony
+   * @H
+   */
+  bindcontentsizechanged?: EventHandler<ContentSizeChangedEvent>;
+
+  /**
+   * scrollview scrolls to upper edge
+   * @defaultValue none
+   * @since 3.0
+   * @iOS
+   * @Android
+   * @H
    */
-  bindcontentsizechanged?: (e: ContentSizeChangedEvent) => void;
+  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>;
 }
 
-/**
- * Scroll to specified position
- * @Android
- * @iOS
- * @Harmony
- * @PC
- */
-export interface ScrollViewScrollToMethod extends BaseMethod {
+export interface ScrollToMethod extends BaseMethod {
   method: 'scrollTo';
   params: {
     /**
@@ -184,52 +277,4 @@ export interface ScrollViewScrollToMethod extends BaseMethod {
   };
 }
 
-/**
- * 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;
+export type ScrollViewUIMethods = ScrollToMethod | AutoScrollMethod;