@lynx-js/types/types/common/element/input.d.ts

@lynx-js/types is a type package of all public APIs officially provided by the Lynx team. Using this package can help you better use Lynx APIs to develop your applications.

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;