Component:TextField: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page TextField (Component) to Component:TextField: Creating component Namespace
Automated: update Fields, Categories
Line 18: Line 18:
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Editor|TextEditor|A reference to the text editor component.
|Editor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv0=true|A reference to the text editor component.
|__text|Text|  
|__text|'''[[Component:Text|Text]]'''|TypeAdv1=true|
|EditingStarted|Action`1|TypeString2=Action<TextEditor>|  
|EditingStarted|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv2=true|
|EditingChanged|Action`1|TypeString3=Action<TextEditor>|  
|EditingChanged|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv3=true|
|EditingFinished|Action`1|TypeString4=Action<TextEditor>|  
|EditingFinished|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;}}|TypeAdv4=true|
}}
}}


Line 34: Line 34:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|TextField (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Text Field]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components:UIX:Interaction{{#translation:}}|TextField (Component){{#translation:}}]]
[[Category:Components:UIX:Interaction{{#translation:}}|Text Field]]

Revision as of 21:39, 3 March 2024


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
TextField component as seen in the Scene Inspector


Intoduction

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.

Usage

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
EditingStarted Action`1<TextEditor>
EditingChanged Action`1<TextEditor>
EditingFinished Action`1<TextEditor>

Behavior

Examples

Related Components