Component:TextField: Difference between revisions

Latest revision as of 23:30, 12 September 2024

Component image

**TextField** component as seen in the Scene Inspector

The TextField component is used in conjunction with a TextEditor, Text, and Button component to provide an editable text field. The Text component stores the text, the TextEditor is the editor for the text, and the Button allows the text editor to appear when then text field is selected.

You must drag a reference to the Text component into the Text property of the TextEditor in order for the editor to know what text it is editing.

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled.
`Editor`	TextEditor	A reference to the text editor component.
`__text`	Text	Internal - The text for this field.
`EditingStarted`	Action`1<TextEditor>	The editing started action.
`EditingChanged`	Action`1<TextEditor>	The editing changed action.
`EditingFinished`	Action`1<TextEditor>	The editing finished action.
`SubmitPressed`	[[Type:Action`1<TextEditor>\|Action`1<TextEditor>]]	The submit pressed action.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=TextFieldComponent.png
@@ Line 9: / Line 8: @@
 <!--T:2-->
-== Intoduction ==
 The '''TextField''' component is used in conjunction with a [[TextEditor (Component)|TextEditor]], [[Text (Component)|Text]], and [[Button (Component)|Button]] component to provide an editable text field. The Text component stores the text, the TextEditor is the editor for the text, and the Button allows the text editor to appear when then text field is selected.
@@ Line 16: / Line 13: @@
 <!--T:3-->
-== Usage ==
 {{Table ComponentFields
 |Editor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv0=true|A reference to the text editor component.
-|__text|'''[[Component:Text|Text]]'''|TypeAdv1=true|
+|__text|'''[[Component:Text|Text]]'''|TypeAdv1=true|Internal - The text for this field.
-|EditingStarted|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv2=true|
+|EditingStarted|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv2=true|The editing started action.
-|EditingChanged|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv3=true|
+|EditingChanged|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv3=true|The editing changed action.
-|EditingFinished|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv4=true|
+|EditingFinished|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv4=true|The editing finished action.
+|SubmitPressed|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv4=true|The submit pressed action.
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
+This component is useful for forms, user input, and other text based projects.
 <!--T:5-->
 == Examples ==
+=== Videos ===
+[[User:ProbablePrime|ProbablePrime]] made a tutorial video on TextFields:
+<youtube>ReERNLr-CJo</youtube>
 <!--T:6-->
-== Related Components ==
+== See Also ==
+* [[Component:TouchableTextField]]
 </translate>
 [[Category:Components{{#translation:}}|Text Field]]
-[[Category:ComponentStubs]]
 [[Category:Components:UIX:Interaction{{#translation:}}|Text Field]]