Number field
Schema:
"root"}
:
{1 Items"fields"]
:
[1 Items0}
:
{2 Items"name"
:
string
"age"
"meta"}
:
{2 Items"displayName"
:
string
"Age"
"displayType"
:
string
"number"
Properties
Name | Description | Type |
---|---|---|
placeholder | The hint shown in the text field | String |
isReadonly | A readonly field is not editable and value cannot be changed | Boolean |
isDisabled | Shows the field as disabled. This is also not editable and value cannot be changed | Boolean |
variant | Contains the field variant to be used. Allowed values: standard, filled, outlined. Default is standard. |
Common field properties
These are the common properties of a field ( inside meta
field)
Field | Data type | Default Value | Description |
---|---|---|---|
className | String | None | Pass classname for custom styling or reference |
displayName | String | None | It is used to display name of the field in the form |
displayType | String | None | It is used to determine the field type to be displayed. Supported options: |
displayProps | Object | None | It is used for field layouting. Refer for details: DisplayType |
htmlProps | Object | None | It is used for setting native html attributes to basic form controls like text_field, select, number, password, email etc. Example of such attributes would be like step , min , max for displayType number |
value | String Boolean Number | None | It is value of the field |
type | String | None | Used for hidden fields and field section. Value for hidden field: hidden . Value for section: section |
validation | Object | For field validation | |
dependencies | Object | Defines relationships and dependencies between various fields. Refer here for details: Dependencies | |
events | Object | Defines field level events |
Common validation
properties
Field | Description |
---|---|
required | Marks a field as mandatory |
pattern | Adds a pattern validation for the field. For email , pattern is supported by default |
patternDetail | Contains info msg and error msg for pattern validation property |
min | For Textbox fields, it is the minimum number of characters required for the field, For number fields, it is the minimum value allowed |
max | For Textbox fields it is the maximum number of characters allowed. For number fields, it is the maximum value allowed |
minDetail | Contains error and info msg for min validation property |
maxDetail | Contains error and info msg for max validation property |
infoDetail | Contains general info msg about the field |
requiredDetail | Contains info msgs about the required validation property |
Max. allowed number
Enter an age greater than 100 years and click on Submit
.
Schema:
"root"}
:
{1 Items"fields"]
:
[1 Items0}
:
{2 Items"name"
:
string
"age"
"meta"}
:
{3 Items"displayName"
:
string
"Age"
"displayType"
:
string
"number"
"validation"}
:
{1 Items"max"
:
int
100
Placeholder
Schema:
"root"}
:
{1 Items"fields"]
:
[1 Items0}
:
{2 Items"name"
:
string
"age"
"meta"}
:
{3 Items"displayName"
:
string
"Age"
"displayType"
:
string
"number"
"placeholder"
:
string
"Enter your age"