@lynx-js/types 3.3.1 → 3.4.3

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

@@ -0,0 +1,401 @@
+import { BaseEvent, BaseMethod, Callback } from '../events';
+import { StandardProps } from '../props';
+
+
+export interface TextAreaInputEvent {
+  /**
+   * 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
+   * @Web
+   * @Android
+   * @Harmony
+   * @since 3.4
+   */
+  isComposing?: boolean;
+}
+
+export interface TextAreaFocusEvent {
+  /**
+   * Input content
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  value: string;
+}
+
+export interface TextAreaBlurEvent {
+  /**
+   * Input content
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  value: string;
+}
+
+export interface TextAreaConfirmEvent {
+  /**
+   * Input content
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  value: string;
+}
+
+export interface TextAreaSelectionChangeEvent {
+  /**
+   * 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 TextAreaProps extends Omit<StandardProps, 'bindfocus' | 'bindblur'> {
+  /**
+   * Placeholder
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  placeholder?: string
+  /**
+   * The type of confirm button
+   * @defaultValue 'done'
+   * @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;
+  /**
+   * Max input lines
+   * @defaultValue undefined
+   * @Android
+   * @iOS
+   * @Harmony
+   * @since 3.4
+   */
+  maxlines?: number;
+  /**
+   * Bounce effect for iOS
+   * @defaultValue true
+   * @iOS
+   * @since 3.4
+   */
+  bounces?: boolean;
+  /**
+   * Line spacing
+   * @defaultValue undefined
+   * @iOS
+   * @Android
+   * @since 3.4
+   */
+  'line-spacing'?: number | `${number}px` | `${number}rpx`;
+  /**
+   * Interaction enabled
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  readonly?: boolean;
+
+  /**
+   * Show soft input keyboard while focused
+   * @defaultValue true
+   * @Android
+   * @iOS
+   * @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' | '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', TextAreaFocusEvent>) => void;
+
+  /**
+   * Blurred
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindblur?: (e: BaseEvent<'bindblur', TextAreaBlurEvent>) => void;
+
+  /**
+   * Input content changed
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindinput?: (e: BaseEvent<'bindinput', TextAreaInputEvent>) => void;
+
+  /**
+   * Input selection changed
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindselection?: (e: BaseEvent<'bindselection', TextAreaSelectionChangeEvent>) => void;
+
+  /**
+   * Confirm button clicked, only work when confirm-type is defined
+   * @Android
+   * @iOS
+   * @Harmony
+   * @Web
+   * @since 3.4
+   */
+  bindconfirm?: (e: BaseEvent<'bindconfirm', TextAreaConfirmEvent>) => void;
+}
+
+/**
+ * Require focus
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface TextAreaFocusMethod extends BaseMethod {
+  method: 'focus';
+}
+
+/**
+ * Release focus
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface TextAreaBlurMethod extends BaseMethod {
+  method: 'blur';
+}
+
+/**
+ * Get input content
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface TextAreaGetValueMethod extends BaseMethod {
+  method: 'getValue';
+  success?: Callback<{
+    /**
+     * Input content
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    value: string;
+    /**
+     * Begin position of the cursor
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    selectionStart: number;
+    /**
+     * End position of the cursor
+     * @Android
+     * @iOS
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    selectionEnd: number;
+    /**
+     * Is composing or not, iOS only
+     * @iOS
+     * @Android
+     * @Harmony
+     * @Web
+     * @since 3.4
+     */
+    isComposing: boolean;
+  }>;
+}
+
+/**
+ * Set input content
+ * @Android
+ * @iOS
+ * @Harmony
+ * @Web
+ * @since 3.4
+ */
+export interface TextAreaSetValueMethod 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 TextAreaSetSelectionRangeMethod 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 TextAreaUIMethods = TextAreaFocusMethod | TextAreaBlurMethod | TextAreaGetValueMethod | TextAreaSetValueMethod | TextAreaSetSelectionRangeMethod;

package/types/common/events.d.ts

@@ -80,9 +80,9 @@ export interface BaseTouchEvent<T> extends BaseEventOrig<any, T> {
   changedTouches: Array<Touch>;
 
   detail: {
-    /** The current position of the touch point relative to the touched element's x-coordinate. */
+    /** The current position of the touch point relative to the page's x-coordinate. */
     x: number;
-    /** The current position of the touch point relative to the touched element's y-coordinate. */
+    /** The current position of the touch point relative to the page's y-coordinate. */
     y: number;
   }
 }
@@ -217,6 +217,12 @@ export interface TextLayoutEventDetail {
   };
 }
 
+export interface TextSelectionChangeEventDetail {
+  start: number;
+  end: number;
+  direction: 'forward' | 'backward';
+}
+
 export interface AccessibilityActionDetailEvent<T> extends BaseEventOrig<{}, T> {
   detail: {
     /**
@@ -460,3 +466,73 @@ export interface ITouchEvent extends BaseTouchEvent<Target> {}
 export interface IMouseEvent extends BaseMouseEvent<Target> {}
 export interface IWheelEvent extends BaseWheelEvent<Target> {}
 export interface IKeyEvent extends BaseKeyEvent<Target> {}
+
+interface LynxMessageEvents {
+  // from native context
+  __GlobalEvent: {
+    data: [
+      // name
+      string,
+      // params
+      any,
+    ];
+    origin: 'NATIVE';
+  };
+  __DestroyLifetime: {
+    data: [
+      // appGUID
+      number,
+    ];
+    origin: 'NATIVE';
+  }
+
+  // from engine context
+  __RenderPage: {
+    data: [
+      // data
+      object,
+      // renderOptions
+      object,
+    ];
+    origin: 'ENGINE';
+  };
+  __UpdatePage: {
+    data: [
+      // data
+      object,
+      // updateOptions
+      object,
+    ];
+    origin: 'ENGINE';
+  };
+  __UpdateGlobalProps: {
+    data: [
+      // data
+      Object
+    ];
+    origin: 'ENGINE';
+  };
+  __RemoveComponents: {
+    data: [];
+    origin: 'ENGINE';
+  };
+  __SSRHydrate: {
+    data: [
+      // customHydrateInfo
+      string,
+      // listIDs
+      number[],
+    ];
+    origin: 'ENGINE';
+  };
+}
+
+type LynxMessageEventType = keyof LynxMessageEvents;
+
+type LynxMessageEventsWithType = {
+  [k in LynxMessageEventType]: LynxMessageEvents[k] & {
+    type: k;
+  };
+};
+
+export type LynxMessageEvent = LynxMessageEventsWithType[LynxMessageEventType];

package/types/common/lynx.d.ts

@@ -13,6 +13,58 @@ export interface TextMetrics {
   width: number;
   content?: Array<string>;
 }
+
+export type DispatchEventResult = 
+  // 'NotCanceled'
+  // Event was not canceled by event handler or default event handler.
+  | 0
+  // 'CanceledByEventHandler'
+  // Event was canceled by event handler; i.e. a script handler calling
+  // preventDefault.
+  | 1
+  // 'CanceledByDefaultEventHandler'
+  // Event was canceled by the default event handler; i.e. executing the default
+  // action.  This result should be used sparingly as it deviates from the DOM
+  // Event Dispatch model. Default event handlers really shouldn't be invoked
+  // inside of dispatch.
+  | 2
+  // 'CanceledBeforeDispatch'
+  // Event was canceled but suppressed before dispatched to event handler.  This
+  // result should be used sparingly; and its usage likely indicates there is
+  // potential for a bug. Trusted events may return this code; but untrusted
+  // events likely should always execute the event handler the developer intends
+  // to execute.
+  | 3;
+
+export interface MessageEvent {
+  type: string;
+  data: any;
+  origin?: string;
+}
+
+export interface ContextProxy {
+  onTriggerEvent?: (event: MessageEvent) => void;
+
+  postMessage(message: any): void;
+  dispatchEvent(event: MessageEvent): DispatchEventResult;
+  addEventListener(type: string, listener: (event: MessageEvent) => void): void;
+  removeEventListener(
+    type: string,
+    listener: (event: MessageEvent) => void
+  ): void;
+}
+
+export interface BundleInfo {
+  url: string;
+  code: number;
+  error_msg: string;
+}
+
+export interface ResponseHandler {
+  wait: (timeout: number) => BundleInfo;
+  then: (info: BundleInfo) => {}
+}
+
 /*
  *@description Common Lynx type
  */
@@ -32,4 +84,12 @@ export interface CommonLynx {
    * @since main-thread:3.0, background-thread: 2.6
    */
   targetSdkVersion?: string;
+
+  getDevtool(): ContextProxy;
+  getCoreContext(): ContextProxy;
+  getJSContext(): ContextProxy;
+  getUIContext(): ContextProxy;
+  getNative(): ContextProxy;
+  getEngine(): ContextProxy;
+  fetchBundle(url: string, options?: {}): ResponseHandler;
 }