div-input

Text input element.

Parameters

Parameters Description
text_variable

string

Required parameter.

Name of text storage variable.
type

string

Required parameter.

The value must always be input.
accessibility

object

Accessibility settings.

The value has the type div-accessibility.

Available platforms: Android, iOS, web.
alignment_horizontal

string

Horizontal alignment of an element inside the parent element.

Possible values: left, center, right, start, end.
alignment_vertical

string

Vertical alignment of an element inside the parent element.

Possible values: top, center, bottom, baseline.
alpha

number

Sets transparency of the entire element: 0 — completely transparent, 1 — opaque.

Restriction for the value x: x >= 0.0 && x <= 1.0.

Default value: 1.0.
animators

array

Declaration of animators that change variable values over time.

Available platforms: Android, iOS, web.

List of possible values:

  • div-color-animator
  • div-number-animator

    		•
    autocapitalization

    string

    Text auto-capitalization type.

  • By default: auto - default behavior of the platform;
  • none' - automatic capitalization is not applied;</li><li>words - capitalization of each word;</li><li>sentences - capitalization at the beginning of a sentence;</li><li>all_characters' - capitalization of each character.

    • Possible values: auto, none, words, sentences, all_characters.

    Default value: auto.

    Available platforms: Android, iOS, web.
    background

    array

    Element background. It can contain multiple layers.

    List of possible values:

  • div-linear-gradient
  • div-radial-gradient
  • div-image-background
  • div-solid-background
  • div-nine-patch-background

    		•
    border

    object

    Element stroke.

    The value has the type div-border.
    column_span

    int

    Merges cells in a column of the grid element.

    Restriction for the value x: x >= 0.

    Available platforms: Android, iOS, web.
    disappear_actions

    array

    Actions when an element disappears from the screen.

    Available platforms: Android, iOS, web.
    enter_key_actions

    array

    Actions when pressing the 'Enter' key. Actions (if any) override the default behavior.

    Available platforms: iOS, Android, web.
    enter_key_type

    string

    'Enter' key type.

    Possible values: default, go, search, send, done.

    Default value: default.

    Available platforms: iOS, Android, web.
    extensions

    array

    Extensions for additional processing of an element. The list of extensions is given in DivExtension.

    Available platforms: Android, iOS, web.
    filters

    array

    Filter that prevents users from entering text that doesn't satisfy the specified conditions.

    Available platforms: Android, iOS, web.

    List of possible values:

  • div-input-filter-regex
  • div-input-filter-expression

    		•
    focus

    object

    Parameters when focusing on an element or losing focus.

    The value has the type div-focus.
    font_family

    string

    Font family:

  • text — a standard text font;
  • display — a family of fonts with a large font size.

    • Available platforms: Android, iOS, web.
    font_size

    int

    Font size.

    Restriction for the value x: x >= 0.

    Default value: 12.
    font_size_unit

    string

    Unit of measurement:

  • px — a physical pixel.
  • dp — a logical pixel that doesn't depend on screen density.
  • sp — a logical pixel that depends on the font size on a device. Specify height in sp. Only available on Android.

    • Possible values: dp, sp, px.

    Default value: sp.
    font_variation_settings

    dictionary

    List of TrueType/OpenType font features. The object is constructed from pairs of axis tag and style values. The axis tag must contain four ASCII characters.

    Available platforms: iOS, Android.
    font_weight

    string

    Style.

    Possible values: light, medium, regular, bold.

    Default value: regular.
    font_weight_value

    int

    Style. Numeric value.

    Restriction for the value x: x > 0.

    Available platforms: Android, iOS, web.
    functions

    array

    User functions.

    Available platforms: Android, iOS, web.
    height

    object

    Element height. For Android: if there is text in this or in a child element, specify height in sp to scale the element together with the text. To learn more about units of size measurement, see Layout inside the card.

    The value has the type div-size.

    Default value: {"type": "wrap_content"}.

    List of possible values:

  • div-fixed-size
  • div-match-parent-size
  • div-wrap-content-size

    		•
    highlight_color

    string

    Text highlight color. If the value isn't set, the color set in the client will be used instead.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    Available platforms: Android, iOS, web.
    hint_color

    string

    Text color.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    Default value: #73000000.
    hint_text

    string

    Tooltip text.
    id

    string

    Element ID. It must be unique within the root element. It is used as accessibilityIdentifier on iOS.
    is_enabled

    bool_int

    Enables or disables text editing.

    Default value: true.
    keyboard_type

    string

    Keyboard type.

    Possible values: single_line_text, multi_line_text, phone, number, email, uri, password.

    Default value: multi_line_text.
    layout_provider

    object

    Provides data on the actual size of the element.

    The value has the type div-layout-provider.

    Available platforms: Android, iOS, web.
    letter_spacing

    number

    Spacing between characters.

    Default value: 0.

    Available platforms: Android, iOS, web.
    line_height

    int

    Line spacing of the text. Units specified in font_size_unit.

    Restriction for the value x: x >= 0.
    margins

    object

    External margins from the element stroke.

    The value has the type div-edge-insets.
    mask

    object

    Mask for entering text based on the specified template.

    The value has the type div-input-mask.

    Available platforms: Android, iOS, web.

    List of possible values:

  • div-fixed-length-input-mask
  • div-currency-input-mask
  • div-phone-input-mask

    		•
    max_length

    int

    Maximum number of characters that can be entered in the input field.

    Restriction for the value x: x > 0.

    Available platforms: Android, iOS, web.
    max_visible_lines

    int

    Maximum number of lines to be displayed in the input field.

    Restriction for the value x: x > 0.
    native_interface

    object

    Text input line used in the native interface.

    The value has the type native_interface.

    Available platforms: Android.
    paddings

    object

    Internal margins from the element stroke.

    The value has the type div-edge-insets.
    reuse_id

    string

    ID for the div object structure. Used to optimize block reuse. See block reuse.

    Available platforms: Android, iOS.
    row_span

    int

    Merges cells in a string of the grid element.

    Restriction for the value x: x >= 0.

    Available platforms: Android, iOS, web.
    select_all_on_focus

    bool_int

    Highlighting input text when focused.

    Default value: false.

    Available platforms: Android, iOS, web.
    selected_actions

    array

    List of actions to be executed when selecting an element in pager.

    Available platforms: Android, iOS, web.
    text_alignment_horizontal

    string

    Horizontal text alignment.

    Possible values: left, center, right, start, end.

    Default value: start.
    text_alignment_vertical

    string

    Vertical text alignment.

    Possible values: top, center, bottom, baseline.

    Default value: center.
    text_color

    string

    Text color.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    Default value: #FF000000.
    tooltips

    array

    Tooltips linked to an element. A tooltip can be shown by div-action://show_tooltip?id=, hidden by div-action://hide_tooltip?id= where id — tooltip id.

    Available platforms: Android, iOS, web.
    transform

    object

    Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.

    The value has the type div-transform.

    Available platforms: Android, iOS, web.
    transition_change

    object

    Change animation. It is played when the position or size of an element changes in the new layout.

    The value has the type div-change-transition.

    Available platforms: Android, iOS, web.

    List of possible values:

  • div-change-set-transition
  • div-change-bounds-transition

    		•
    transition_in

    object

    Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see Animated transitions.

    The value has the type div-appearance-transition.

    Available platforms: Android, iOS, web.

    List of possible values:

  • div-appearance-set-transition
  • div-fade-transition
  • div-scale-transition
  • div-slide-transition

    		•
    transition_out

    object

    Disappearance animation. It is played when an element disappears in the new layout.

    The value has the type div-appearance-transition.

    Available platforms: Android, iOS, web.

    List of possible values:

  • div-appearance-set-transition
  • div-fade-transition
  • div-scale-transition
  • div-slide-transition

    		•
    transition_triggers

    array

    Animation starting triggers. Default value: [state_change, visibility_change].

    An array must not be empty.

    Available platforms: Android, iOS, web.
    validators

    array

    Validator that checks that the field value meets the specified conditions.

    Available platforms: Android, iOS, web.

    List of possible values:

  • div-input-validator-regex
  • div-input-validator-expression

    		•
    variable_triggers

    array

    Triggers for changing variables within an element.

    Available platforms: Android, iOS, web.
    variables

    array

    Declaration of variables that can be used within an element. Variables declared in this array can only be used within the element and its child elements.

    Available platforms: iOS, web, Android.

    List of possible values:

  • string_variable
  • number_variable
  • integer_variable
  • boolean_variable
  • color_variable
  • url_variable
  • dict_variable
  • array_variable

    		•
    visibility

    string

    Element visibility.

    Possible values: visible, invisible, gone.

    Default value: visible.
    visibility_action

    object

    Tracking visibility of a single element. Not used if the visibility_actions parameter is set.

    The value has the type div-visibility-action.
    visibility_actions

    array

    Actions when an element appears on the screen.
    width

    object

    Element width.

    The value has the type div-size.

    Default value: {"type": "match_parent"}.

    List of possible values:

  • div-fixed-size
  • div-match-parent-size
  • div-wrap-content-size

    		•

    native_interface

    Parameters Description
    color

    string

    Required parameter.

    Text input line color.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    Available platforms: Android.
    JSON 
    {
  type*: "input",
  accessibility: {
    description: "string",
    hint: "string",
    is_checked: "bool_int",
    mode: "string",
    mute_after_action: "bool_int",
    state_description: "string",
    type: "string"
  },
  alignment_horizontal: "string",
  alignment_vertical: "string",
  alpha: "number",
  animators: [ div-animator, ... ],
  autocapitalization: "string",
  background: [ div-background, ... ],
  border: {
    corner_radius: "int",
    corners_radius: {
      bottom-left: "int",
      bottom-right: "int",
      top-left: "int",
      top-right: "int"
    },
    has_shadow: "bool_int",
    shadow: {
      alpha: "number",
      blur: "int",
      color: "string",
      offset*: {
        x*: {
          unit: "string",
          value*: "number"
        },
        y*: {
          unit: "string",
          value*: "number"
        }
      }
    },
    stroke: {
      color*: "string",
      style: div-stroke-style,
      unit: "string",
      width: "number"
    }
  },
  column_span: "int",
  disappear_actions: [
    {
      disappear_duration: "int",
      download_callbacks: {
        on_fail_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            scope_id: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ],
        on_success_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            scope_id: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_limit: "int",
      payload: "object",
      referer: "string",
      scope_id: "string",
      typed: div-action-typed,
      url: "string",
      visibility_percentage: "int"
    },
    ...
  ],
  enter_key_actions: [
    {
      download_callbacks: {
        on_fail_actions: [ div-action, ... ],
        on_success_actions: [ div-action, ... ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_url: "string",
      menu_items: [
        {
          action: div-action,
          actions: [ div-action, ... ],
          text*: "string"
        },
        ...
      ],
      payload: "object",
      referer: "string",
      scope_id: "string",
      target: "string",
      typed: div-action-typed,
      url: "string"
    },
    ...
  ],
  enter_key_type: "string",
  extensions: [
    {
      id*: "string",
      params: "object"
    },
    ...
  ],
  filters: [ div-input-filter, ... ],
  focus: {
    background: [ div-background, ... ],
    border: {
      corner_radius: "int",
      corners_radius: {
        bottom-left: "int",
        bottom-right: "int",
        top-left: "int",
        top-right: "int"
      },
      has_shadow: "bool_int",
      shadow: {
        alpha: "number",
        blur: "int",
        color: "string",
        offset*: {
          x*: {
            unit: "string",
            value*: "number"
          },
          y*: {
            unit: "string",
            value*: "number"
          }
        }
      },
      stroke: {
        color*: "string",
        style: div-stroke-style,
        unit: "string",
        width: "number"
      }
    },
    next_focus_ids: {
      down: "string",
      forward: "string",
      left: "string",
      right: "string",
      up: "string"
    },
    on_blur: [
      {
        download_callbacks: {
          on_fail_actions: [ div-action, ... ],
          on_success_actions: [ div-action, ... ]
        },
        is_enabled: "bool_int",
        log_id*: "string",
        log_url: "string",
        menu_items: [
          {
            action: div-action,
            actions: [ div-action, ... ],
            text*: "string"
          },
          ...
        ],
        payload: "object",
        referer: "string",
        scope_id: "string",
        target: "string",
        typed: div-action-typed,
        url: "string"
      },
      ...
    ],
    on_focus: [
      {
        download_callbacks: {
          on_fail_actions: [ div-action, ... ],
          on_success_actions: [ div-action, ... ]
        },
        is_enabled: "bool_int",
        log_id*: "string",
        log_url: "string",
        menu_items: [
          {
            action: div-action,
            actions: [ div-action, ... ],
            text*: "string"
          },
          ...
        ],
        payload: "object",
        referer: "string",
        scope_id: "string",
        target: "string",
        typed: div-action-typed,
        url: "string"
      },
      ...
    ]
  },
  font_family: "string",
  font_size: "int",
  font_size_unit: "string",
  font_variation_settings: "dictionary",
  font_weight: "string",
  font_weight_value: "int",
  functions: [
    {
      arguments*: [
        {
          name*: "string",
          type*: "string"
        },
        ...
      ],
      body*: "string",
      name*: "string",
      return_type*: "string"
    },
    ...
  ],
  height: div-size,
  highlight_color: "string",
  hint_color: "string",
  hint_text: "string",
  id: "string",
  is_enabled: "bool_int",
  keyboard_type: "string",
  layout_provider: {
    height_variable_name: "string",
    width_variable_name: "string"
  },
  letter_spacing: "number",
  line_height: "int",
  margins: {
    bottom: "int",
    end: "int",
    left: "int",
    right: "int",
    start: "int",
    top: "int",
    unit: "string"
  },
  mask: div-input-mask,
  max_length: "int",
  max_visible_lines: "int",
  native_interface: {
    color*: "string"
  },
  paddings: {
    bottom: "int",
    end: "int",
    left: "int",
    right: "int",
    start: "int",
    top: "int",
    unit: "string"
  },
  reuse_id: "string",
  row_span: "int",
  select_all_on_focus: "bool_int",
  selected_actions: [
    {
      download_callbacks: {
        on_fail_actions: [ div-action, ... ],
        on_success_actions: [ div-action, ... ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_url: "string",
      menu_items: [
        {
          action: div-action,
          actions: [ div-action, ... ],
          text*: "string"
        },
        ...
      ],
      payload: "object",
      referer: "string",
      scope_id: "string",
      target: "string",
      typed: div-action-typed,
      url: "string"
    },
    ...
  ],
  text_alignment_horizontal: "string",
  text_alignment_vertical: "string",
  text_color: "string",
  text_variable*: "string",
  tooltips: [
    {
      animation_in: {
        duration: "int",
        end_value: "number",
        interpolator: "string",
        items: [ div-animation, ... ],
        name*: "string",
        repeat: div-count,
        start_delay: "int",
        start_value: "number"
      },
      animation_out: {
        duration: "int",
        end_value: "number",
        interpolator: "string",
        items: [ div-animation, ... ],
        name*: "string",
        repeat: div-count,
        start_delay: "int",
        start_value: "number"
      },
      background_accessibility_description: "string",
      close_by_tap_outside: "bool",
      div*: div,
      duration: "int",
      id*: "string",
      mode: div-tooltip-mode,
      offset: {
        x*: {
          unit: "string",
          value*: "number"
        },
        y*: {
          unit: "string",
          value*: "number"
        }
      },
      position*: "string",
      tap_outside_actions: [
        {
          download_callbacks: {
            on_fail_actions: [ div-action, ... ],
            on_success_actions: [ div-action, ... ]
          },
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          scope_id: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ]
    },
    ...
  ],
  transform: {
    pivot_x: div-pivot,
    pivot_y: div-pivot,
    rotation: "number"
  },
  transition_change: div-change-transition,
  transition_in: div-appearance-transition,
  transition_out: div-appearance-transition,
  transition_triggers: [ "string", ... ],
  validators: [ div-input-validator, ... ],
  variable_triggers: [
    {
      actions*: [
        {
          download_callbacks: {
            on_fail_actions: [ div-action, ... ],
            on_success_actions: [ div-action, ... ]
          },
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          scope_id: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ],
      condition*: "bool_int",
      mode: "string"
    },
    ...
  ],
  variables: [ div-variable, ... ],
  visibility: "string",
  visibility_action: {
    download_callbacks: {
      on_fail_actions: [
        {
          download_callbacks: div-download-callbacks,
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          scope_id: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ],
      on_success_actions: [
        {
          download_callbacks: div-download-callbacks,
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          scope_id: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ]
    },
    is_enabled: "bool_int",
    log_id*: "string",
    log_limit: "int",
    payload: "object",
    referer: "string",
    scope_id: "string",
    typed: div-action-typed,
    url: "string",
    visibility_duration: "int",
    visibility_percentage: "int"
  },
  visibility_actions: [
    {
      download_callbacks: {
        on_fail_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            scope_id: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ],
        on_success_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            scope_id: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_limit: "int",
      payload: "object",
      referer: "string",
      scope_id: "string",
      typed: div-action-typed,
      url: "string",
      visibility_duration: "int",
      visibility_percentage: "int"
    },
    ...
  ],
  width: div-size
}
    Previous
    indicator
    Next
    pager