PasswordInput widget

The PasswordInput Widget enables the rendering of secure password input fields, ensuring that user-entered passwords remain hidden and protected within your application for enhanced security and privacy.

Test in Kitchen Sink (opens in a new tab)

Properties

Property	Type	Description
id	string	ID to be referenced later
maxWidth	integer	The max width of this Input widget (default 700)
label	string	Label for your widget
labelHint	string	Hint text on your label
hintText	string	Hint text explaining your widget
required	boolean	Whether the field is required
enabled	boolean	Enables or disables the interactivity and input functionality of the widget
icon	object	See properties
onChange		Call Ensemble's built-in functions or execute code when the input changes. Note for free-form text input, this event only dispatches if the text changes AND the focus is lost (e.g. clicking on button)
onFocusReceived	action	Execute an Ensemble action when the field receives focus
onFocusLost	action	Execute an Ensemble action when the field loses focus
styles	object	See properties
validator	object	See properties
onKeyPress	action	On every keystroke, call Ensemble's built-in functions or execute code
keyboardAction	string	Specify the action key on native device's soft keyboard
obscureToggle	boolean	enable the toggling between plain and obscure text.
readOnly	boolean	When it is true, the text cannot be modified by any shortcut or keyboard operation.
selectable	boolean	Setting this to true will enable features such as long-pressing the TextField to select text and show the cut/copy/paste menu, and tapping to move the text caret text.
maxLength	integer	The maximum number of characters allowed in the text field. If set, the text field will restrict the input to this number of characters.
maxLengthEnforcement	string	none, enforced, truncateAfterCompositionEnds. see properties

icon

Property	Type	Description
name	string	The name of the icon
library	string	Which icon library to use.
color	integer or string	The color specification for the text, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
size	integer	Defines the dimensions or magnitude of an element, allowing control over its overall size within the layout.

styles

Property	Type	Description
expanded	boolean	If the parent is a Row or Column, this flag will stretch this widget in the appropriate direction. (e.g stretch horizontally for parent of type Row)
contentPadding	integer or string	Padding around your input content with CSS-style notation e.g. margin: 5 20 5
fillColor	integer or string	The fill color for this input fields. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
borderRadius	integer	The border radius for this Input widget. This property can be defined in the theme to apply to all Input widgets.
borderWidth	integer	The border width for this Input widget. This property can be defined in the theme to apply to all Input widgets.
borderColor	integer or string	Sets the border color, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
errorBorderColor	integer or string	The border color when there are errors on this input field. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
focusedBorderColor	integer or string	The border color when this input field is receiving focus. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
focusedErrorBorderColor	integer or string	The border color of this input field when it is receiving focus in its error state. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
disabledBorderColor	integer or string	The border color when this input field is disabled. This property can be defined in the theme to apply to all Input widgets, starting with '0xFF' for full opacity. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
variant	string	Select a pre-defined look and feel for this Input widget. This property can be defined in the theme to apply to all Input widgets. see properties
visible	boolean	Toggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified.
visibilityTransitionDuration	number	Specify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible.
stackPositionTop	integer	The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children.
stackPositionBottom	integer	The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children.
stackPositionLeft	integer	The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children.
stackPositionRight	integer	The distance that the child's right edge from the right of the stack. This is applicable only for Stack's children.
alignment	string	The alignment of the widget relative to its parent. `topLeft`, `topCenter`, `topRight`, `centerLeft`, `center`, `centerRight`, `bottomLeft`, `bottomCenter`, `bottomRight`
elevation	integer	The z-coordinate at which to place this material relative to its parent. A non-zero value will show a shadow, with its size relative to the elevation value. Minimum value: 0, Maximum value: 24
elevationShadowColor	integer or string	The shadow color for the elevation, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. `transparent` `black` `blue` `white` `red` `grey` `teal` `amber` `pink` `purple` `yellow` `green` `brown` `cyan` `indigo` `lime` `orange`
elevationBorderRadius	string or integer	The border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0.
captureWebPointer	boolean	Applicable for Web only. When overlaying widgets on top of certain HTML container (e.g. Maps), the mouse click is captured by the HTML container, causing issue interacting with the widget. Use this to capture and maintain the mouse pointer on your widget.
fontSize	integer	Sets the size of the text.

validator

Property	Type	Description
minLength	integer	The minimum number of characters
maxLength	integer	The maximum number of characters
regex	string	The Regular Expression the input will need to match
regexError	string	The customized error message to show when the input does not match the provided regex.

options for styles.variant

Option	Description
box	draw a Box border around this input widget. This property can be defined in the theme to apply to all Input widgets.
underline	draw an Underline below this input widget. This property can be defined in the theme to apply to all Input widgets.

MaxLengthEnforcement

Property	Type	Description
none	string	No enforcement applied to the editing value. It's possible to exceed the maxLength.
enforced	string	Keep the length of the text input from exceeding the max length even when the text has an unfinished composing region.
truncateAfterCompositionEnds	string	Users can still input text if the current value is composing even after reaching the max length limit. After composing ends, the value will be truncated.

Multi Child Layouts Profile Image