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 |
accessibility |
object Accessibility settings. The value has the type Available platforms: Android, iOS, web. |
alignment_horizontal |
string Horizontal alignment of an element inside the parent element. Possible values: |
alignment_vertical |
string Vertical alignment of an element inside the parent element. Possible values: |
alpha |
number Sets transparency of the entire element: Restriction for the value Default value: |
animators |
array Declaration of animators that change variable values over time. Available platforms: Android, iOS. List of possible values: |
autocapitalization |
string Text auto-capitalization type. Possible values: Default value: Available platforms: Android, iOS, web. |
background |
array Element background. It can contain multiple layers. List of possible values: |
border |
object Element stroke. The value has the type |
column_span |
int Merges cells in a column of the grid element. Restriction for the value 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 clicking on a Functionality is under development. |
enter_key_type |
string The type of the Possible values: Default value: Functionality is under development. |
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: iOS. List of possible values: |
focus |
object Parameters when focusing on an element or losing focus. The value has the type |
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 Default value: |
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: Default value: |
font_weight |
string Style. Possible values: Default value: |
font_weight_value |
int Style. Numeric value. Restriction for the value Available platforms: iOS, web, Android. |
functions |
array User functions. Available platforms: iOS. |
height |
object Element height. For Android: if there is text in this or in a child element, specify height in The value has the type Default value: List of possible values: |
highlight_color |
string Text highlight color. If the value isn't set, the color set in the client will be used instead. Valid formats: Available platforms: Android, iOS, web. |
hint_color |
string Text color. Valid formats: Default value: |
hint_text |
string Tooltip text. |
id |
string Element ID. It must be unique within the root element. It is used as |
is_enabled |
bool_int Enables or disables text editing. Default value: |
keyboard_type |
string Keyboard type. Possible values: Default value: |
layout_provider |
object Provides data on the actual size of the element. The value has the type Available platforms: Android, iOS, web. |
letter_spacing |
number Spacing between characters. Default value: Available platforms: Android, iOS, web. |
line_height |
int Line spacing of the text. Units specified in Restriction for the value |
margins |
object External margins from the element stroke. The value has the type |
mask |
object Mask for entering text based on the specified template. The value has the type Available platforms: Android, iOS, web. List of possible values: |
max_length |
int Maximum number of characters that can be entered in the input field. Restriction for the value Available platforms: Android, iOS, web. |
max_visible_lines |
int Maximum number of lines to be displayed in the input field. Restriction for the value |
native_interface |
object Text input line used in the native interface. The value has the type Available platforms: Android. |
paddings |
object Internal margins from the element stroke. The value has the type |
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 Available platforms: Android, iOS, web. |
select_all_on_focus |
bool_int Highlighting input text when focused. Default value: 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: Default value: |
text_alignment_vertical |
string Vertical text alignment. Possible values: Default value: |
text_color |
string Text color. Valid formats: Default value: |
tooltips |
array Tooltips linked to an element. A tooltip can be shown by 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 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 Available platforms: Android, iOS, web. List of possible values: |
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 Available platforms: Android, iOS, web. List of possible values: |
transition_out |
object Disappearance animation. It is played when an element disappears in the new layout. The value has the type Available platforms: Android, iOS, web. List of possible values: |
transition_triggers |
array Animation starting triggers. Default value: 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. List of possible values: |
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: |
visibility |
string Element visibility. Possible values: Default value: |
visibility_action |
object Tracking visibility of a single element. Not used if the The value has the type Available platforms: Android, iOS, web. |
visibility_actions |
array Actions when an element appears on the screen. Available platforms: Android, iOS, web. |
width |
object Element width. The value has the type Default value: List of possible values: |
native_interface
Parameters | Description |
---|---|
color |
string Required parameter. Text input line color. Valid formats: Available platforms: Android. |
JSON
{
type*: "input",
accessibility: {
description: "string",
hint: "string",
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",
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",
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_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"
},
div*: div,
duration: "int",
id*: "string",
offset: {
x*: {
unit: "string",
value*: "number"
},
y*: {
unit: "string",
value*: "number"
}
},
position*: "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
}