@lynx-js/types 3.3.0 → 3.3.2

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

@@ -11,7 +11,11 @@ import { StandardProps } from '../props';
 export interface ImageProps extends StandardProps {
   /**
    * Supports http/https/base64
-   * @defaultValue ""
+   * @defaultValue undefined
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 0.2
    */
   src?: string;
@@ -22,8 +26,12 @@ 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';
 
@@ -31,72 +39,93 @@ 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
-   * @defaultValue ""
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 1.4
    */
   placeholder?: string;
 
   /**
    * Image blur radius
-   * @defaultValue "3px"
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 0.2
    */
   'blur-radius'?: string;
 
   /**
    * Stretchable area for 9patch images, in percentage or decimal, four values for top, right, bottom, left
-   * @defaultValue "0.2 10% 0.3 20%"
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 1.4
    */
   'cap-insets'?: string;
 
   /**
-   * Number of times an animated image plays
+   * Adjust the scale of stretchable area for 9patch images
    * @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 "100px"
+   * @defaultValue "0px"
+   * @deprecated
+   * @iOS
+   * @Android
    * @since 1.4
    */
   'prefetch-width'?: string;
 
   /**
    * Image won't load if its size is 0, but will load if prefetch-height is set
-   * @defaultValue "100px"
+   * @defaultValue "0px"
+   * @deprecated
+   * @iOS
+   * @Android
    * @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;
@@ -106,6 +135,10 @@ 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;
@@ -113,66 +146,42 @@ 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>.
-   * @defaultValue ""
+   * @iOS
+   * @Android
+   * @Harmony
    * @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>;
@@ -180,8 +189,10 @@ 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.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @deprecated Deprecated. Some scenarios may not call back the call result. It is recommended to use resumeAnimation instead.
  */
 export interface ImageStartAnimMethod extends BaseMethod {
@@ -190,8 +201,10 @@ export interface ImageStartAnimMethod extends BaseMethod {
 
 /**
  * Resumes the animation, without resetting the loop-count.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @since 2.11
  */
 export interface ImageResumeAnimMethod extends BaseMethod {
@@ -200,8 +213,10 @@ export interface ImageResumeAnimMethod extends BaseMethod {
 
 /**
  * Pauses the animation, without resetting the loop-count.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @since 2.11
  */
 export interface ImagePauseAnimMethod extends BaseMethod {
@@ -210,8 +225,10 @@ export interface ImagePauseAnimMethod extends BaseMethod {
 
 /**
  * Stops the animation, and it will reset the loop-count.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @since 2.11
  */
 export interface ImageStopAnimMethod extends BaseMethod {

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,386 @@
+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;
+  /**
+   * Readonly
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @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
+   * @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;