Interface: NumberInput
Description
Allows user to enter a number into a single-line field. The number input element accepts both whole and
decimal numbers. For example, 0.25, 5.5, and -10 are all valid input values. Decimal numbers are only allowed when
is_decimal_allowed is equal to true.
See
- Number input element reference.
- This is an interactive component - see our guide to enabling interactivity.
Extends
Properties
action_id?
optional action_id: string;
@description: An identifier for this action. You can use this when you receive an interaction payload to
identify the source of the action. Should be unique
among all other action_ids in the containing block. Maximum length for this field is 255 characters.
Inherited from
Defined in
dispatch_action_config?
optional dispatch_action_config: DispatchActionConfig;
Description
A DispatchActionConfig object that determines when during text input the element returns a
block_actions payload.
Inherited from
Dispatchable.dispatch_action_config
Defined in
focus_on_load?
optional focus_on_load: boolean;
Description
Indicates whether the element will be set to auto focus within the
view object. Only one element can be set to true.
Defaults to false.
Inherited from
Defined in
initial_value?
optional initial_value: string;
Description
The initial value in the input when it is loaded.
Defined in
block-kit/block-elements.ts:498
is_decimal_allowed
is_decimal_allowed: boolean;
Description
Decimal numbers are allowed if this property is true, set the value to false otherwise.
Defined in
block-kit/block-elements.ts:494
max_value?
optional max_value: string;
Description
The maximum value, cannot be less than min_value.
Defined in
block-kit/block-elements.ts:506
min_value?
optional min_value: string;
Description
The minimum value, cannot be greater than max_value.
Defined in
block-kit/block-elements.ts:502
placeholder?
optional placeholder: PlainTextElement;
Description
A PlainTextElement object that defines the placeholder text shown on the element. Maximum
length for the text field in this object is 150 characters.
Inherited from
Defined in
type
type: "number_input";
Description
The type of element. In this case type is always number_input.