Text Field

Text field is a component for entering text strings.

Property

No	Item	Input Value	Default Value	Action Property	Type	Action Default Value	Description
1	ID	String	Auto-generated	id	string	Auto-generated	The [id] property cannot be set by actions.
2	Label L	String	Text Field	label	string	Text Field	Component label
3	Width	String	222	width	string	222	Component width
4	Height	String	55	height	string	55	Component height
5	X	String		x	string		X coordinate position
6	Y	String		y	string		Y coordinate position
7	Lock	Boolean	OFF	lock	boolean	false	When ON, the component stays fixed even when the screen is scrolled. When OFF, the component moves along with the screen scroll. Added in v4.1.0.
8	Size	Selection 1. Small 2. Medium 3. None	None	size	string	none	When a value other than None is selected, Height is disabled. When Legacy Design is ON, Size is disabled. Added in v4.2.0.
9	Variant	Selection 1. Outlined 2. Filled 3. Standard	Outlined	variant	string	outlined	Component style
10	Legacy Design	Boolean	OFF				This is only effective when the Variant is set to Standard. When ON, the component is displayed with the legacy design. When OFF, the component is displayed with the new design. Added in v4.1.0
11	Color	String Color Picker		color	string		Component color
12	Background Color	String Color Picker		backgroundColor	string		Background color
13	Label Color	String Color Picker		labelColor	string		Label text color
14	Input Color	String Color Picker		inputColor	string		Input text color
15	Disabled	Boolean	OFF	disabled	boolean	false	Component disabled/enabled state
16	Read Only	Boolean	OFF	readOnly	boolean	false	Read-only mode
17	Required	Boolean	OFF	required	boolean	false	Required input field specification
18	Visibility	Boolean	ON	visibility	boolean	true	Component show/hide
19	Input Alignment	Selection 1. Left 2. Center 3. Right	Left	inputAlignment	string	left	Input text alignment Added in v3.3.0
20	Input Adornments Position	Selection 1. None 2. Start 3. End	None	inputAdornmentsPosition	string	none	Symbol and unit display position
21	Input Adornments L	String		inputAdornments	string		Symbol and unit to display
22	Input Type	Selection 1. Any 2. Phone 3. Email	Any	inputType	string	any	Input value validation type
23	Country Code	Selection	Japan	countryCode	string	JA	Phone number country code
24	Placeholder L	String		placeholder	string		Placeholder text
25	Helper Text L	String		helperText	string		Helper text
26	Input Error Message L	String	Your input is incomplete	inputErrorMessage	string		Message for input errors
27	Value	String		value	string		Text field value
28	Change Event	Selection 1. None 2. UI Script 3. Action 4. Detached Action	None				Event setting for value changes Detached Action became selectable in v4.1.0. UI Script became selectable in v4.2.0.
29	Error			error	boolean	false	Error state
30	Detached Action	Selection 1. [Detached Action ID]		detachedAction	string		Set a detached action Added in v4.1.0.
31	Tab Focus	Selection 1. [Component ID]		tabFocus	string		Next focus component specification Added in v3.3.0

Note

• ^L: This is a Multilingual Property.
• The following properties do not support getting or setting multilingual values from actions:
  • Input Adornments
  • Input Error Message
• If the value of "Input Adornments Position" is "none", the "Input Adornments" setting is ignored.
• The following can be entered for the "Width" and "Height" property values:
  • If you want to display in px, specify only numerical values; if you want to display in %, specify % as the unit.
  • Operation will not be supported if you enter anything other than the following:
    • number
    • number%
    • calc() function
• The following can be entered for the [X] and [Y] property values:
  • If you want to display in px, specify only numerical values.
  • Operation will not be supported if you enter anything other than the following:
    • number
    • calc() function
• The calc() function is a CSS function that enables calculations. (e.g. calc(100% - 30px))
  • The units that can be used with the calc() function are "%" and "px".
  • Other units (e.g., em, rem, etc.) are not supported.
• When the calc() function is used to specify the size, the appearance in the editor may differ from the appearance in the application. Please confirm using the preview.
• The [Size] property can be set from actions with the following values:
  • small
  • medium
  • none
• The [Input Error Message] property can be set when the [Input Type] property is set to [Phone number] or [Email].
• When defining as a dynamic component, the [Input Error Message] property must be written as follows:

new $comp.TextField({
  id: "text_field",
  width: 200,
  ...
  inputErrorMessage: "<message to display by default>",
  inputErrorMessageLanguages: {
    en: "<message to display when language is English>",
    ja: "<message to display when language is Japanese>"
  }
})

• When an input check error occurs when the [Input type] property is [Phone number] or [Email], the [error] property is set to “true”.
• When the [Required] property is turned ON, a * mark is displayed next to the label.
  Required validation is not performed automatically, so please define an action.

Event

Event name	Description
onchange	Occurs when a value change is made and the cursor is moved out of the way.