Component:Expander: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
Small corrections.
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ExpanderComponent.png
|Image=ExpanderComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''Expander''' component is an intractable [[UIX]] element that expands a section called the <code>SectionRoot</code> under itself. The <code>SectionRoot</code>'s active state will toggle when that expander is triggered, expanding it under the [[Slot]] the expander is on. This can be seen on the [[Scene Inspector]].


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|SectionRoot|Slot|
|SectionRoot|Slot|The slot to expend with, by activating the slot that is referenced when toggled.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
 
This component is combined with the [[Component:Button|Button]] component to trigger this expander component. This component is also combined with the [[Component:TextExpandIndicator|TextExpandIndicator]] component to drive the text and show the user that this expander has expanded, collapsed, or is empty.


<!--T:5-->
<!--T:5-->
Line 27: Line 27:
</translate>
</translate>
[[Category:Components{{#translation:}}|Expander]]
[[Category:Components{{#translation:}}|Expander]]
[[Category:ComponentStubs]]
[[Category:Components:UIX:Interaction{{#translation:}}|Expander]]
[[Category:Components:UIX:Interaction{{#translation:}}|Expander]]

Latest revision as of 06:09, 22 July 2024

Component image 
Expander component as seen in the Scene Inspector


The Expander component is an intractable UIX element that expands a section called the SectionRoot under itself. The SectionRoot's active state will toggle when that expander is triggered, expanding it under the Slot the expander is on. This can be seen on the Scene Inspector.

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.
SectionRoot Slot The slot to expend with, by activating the slot that is referenced when toggled.

Usage

This component is combined with the Button component to trigger this expander component. This component is also combined with the TextExpandIndicator component to drive the text and show the user that this expander has expanded, collapsed, or is empty.

Examples

Related Components