zero.appdocs
Docs/Presentations/TextInput

TextInput

Presentations v1.0 zero-schema

No description provided.

Missing descriptions: TextDecoration.

Required fields

PresentationType Name

Properties

PresentationType string required
A text input allows users to enter text. It's commonly used in forms, search bars, chat applications, and more.
Allowed TextInput
Name string required
A unique identifier for the text input.
InitialValue string optional
The initial value of the input.
BackgroundColor optional
The color used to indicate errors in the input
Default "#FFFFFF"
IsJson boolean optional
Indicates whether the text input should be parsed as JSON data.
Default false
Padding anyOf optional
The space between the text input's content and its border
FontSize number optional
The size of the text inside the input in pixels
Default 16
HintText string optional
The text displayed in the input when it's empty to guide the user
IsNumber boolean optional
Specifies whether the input should accept only numeric values.
Default false
MaxLines number optional
The maximum number of lines of text the input can display
Default 1
OnChange composed optional
A function called when the input's value changes.
Ref Actions / Action / 1.0
OnSubmit composed optional
A function called when the user submits the input (e.g., presses Enter).
Ref Actions / Action / 1.0
AutoFocus boolean optional
Determines whether the input should be focused automatically when the screen loads.
Default false
AutoSubmit boolean optional
Specifies whether the form should be submitted automatically after the input is complete.
Default false
ErrorColor string optional
The color used to indicate errors in the input
Default "#FF0000"
IsRequired boolean optional
Indicates whether the input is required to be filled out.
Default false
AutoCorrect boolean optional
Specifies whether autocorrection should be applied to the input.
Default false
ObscureText boolean optional
Specifies whether the text entered in the input should be hidden (e.g., for passwords).
Default false
DisplayText string optional
The initial value displayed in the input.
BorderRadius number optional
The radius of the border corners of the input to make it rounded
BorderColor string optional
The color of the input's border accepting color name or hex value
Default "#000000"
BorderWidth number optional
The width of Input border in pixels
Default 1
DefaultColor string optional
The default color of text in input accepting color name or hex value
Default "#000000"
FontFamily string optional
The font family used for the text in the input.
Default "DefaultUI"
FontWeight number optional
The weight of the font used for the text in the input.
Default 400
Color string optional
The color of the text in the input
Default "#000000"
TextShadow array optional
A shadow effect applied to the text in the input.
TextAlign string optional
The alignment of the text in the input.
Default "Left"
Allowed Left Center Right Justify
ReadOnly boolean optional
Specifies whether the input is read-only.
Default false
TextOverflow string optional
The strategy for handling text overflow in the input.
Allowed Left Center Right Justify
TextDecoration string optional
No description
Default "The decoration applied to the text in the input."
Allowed Left Right
Height number optional
The height of the input in pixels
DisplayTextHorizontal boolean optional
Specifies whether the display text should be horizontally displayed.
Default false
DisplayTextWidth number optional
The width of the display text in pixels
Default 100
LabelWidth number optional
The width of the input's label in pixels
Default 100
FocusedColor string optional
The color of the text when the input is focused.
InputValidationRegex string optional
A regular expression used to validate the input.
InputValidationErrorMessage string optional
The error message displayed when the input fails validation.

Referenced contracts

Studio editor metadata

Shapes the studio editor; not enforced at runtime.

BackgroundColor
{
  "OnChange": {
    "To": "{{ Id }}",
    "Handler": "Whisper"
  },
  "InitialValue": "{{ Value }}",
  "DisplayText": "BackgroundColor",
  "PresentationType": "ColorPicker"
}
ErrorColor
{
  "OnChange": {
    "To": "{{ Id }}",
    "Handler": "Whisper"
  },
  "InitialValue": "{{ Value }}",
  "DisplayText": "ErrorColor",
  "PresentationType": "ColorPicker"
}
BorderColor
{
  "OnChange": {
    "To": "{{ Id }}",
    "Handler": "Whisper"
  },
  "InitialValue": "{{ Value }}",
  "DisplayText": "BorderColor",
  "PresentationType": "ColorPicker"
}
DefaultColor
{
  "OnChange": {
    "To": "{{ Id }}",
    "Handler": "Whisper"
  },
  "InitialValue": "{{ Value }}",
  "DisplayText": "DefaultColor",
  "PresentationType": "ColorPicker"
}
Color
{
  "OnChange": {
    "To": "{{ Id }}",
    "Handler": "Whisper"
  },
  "InitialValue": "{{ Value }}",
  "DisplayText": "Color",
  "PresentationType": "ColorPicker"
}
TextAlign
"Select"
TextOverflow
"Select"
TextDecoration
"Select"
FocusedColor
{
  "OnChange": {
    "To": "{{ Id }}",
    "Handler": "Whisper"
  },
  "InitialValue": "{{ Value }}",
  "DisplayText": "FocusedColor",
  "PresentationType": "ColorPicker"
}