Automated: update Fields, Categories |
Small overhaul. Updated description. Added usage information. |
||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=ValueRadio`1Component.png | |Image=ValueRadio`1Component.png | ||
Line 9: | Line 8: | ||
<!--T:2--> | <!--T:2--> | ||
The '''ValueRadio''' component is a listener component that activates or deactivates slots using the <code>CheckVisual</code> field, based if a <code>TargetValue</code> matches the <code>OptionValue</code> field. When a match is found, the <code>CheckVisual</code> field will be set to true. | |||
ValueRadio | |||
<!--T:3--> | <!--T:3--> | ||
Line 23: | Line 21: | ||
== Usage == | == Usage == | ||
To function, the component simply needs to be attached to a slot that also has a button component attached to it. From then on, pressing that button will activate the ValueRadio, making it set its <code>TargetValue</code> to its <code>OptionValue</code>, which then also sets its <code>CheckVisual</code> to true. | To function, the component simply needs to be attached to a slot that also has a button component attached to it. From then on, pressing that button will activate the ValueRadio, making it set its <code>TargetValue</code> to its <code>OptionValue</code>, which then also sets its <code>CheckVisual</code> to true. | ||
* This is useful for making forms that need one answer from many choices, a set of button that should only have one being active, and anything that requires only one activation from many things. | |||
* the <code>CheckVisual</code> field does not just have to be the active of a slot, this can be any [[Type:IField|IField]] [[Type:bool|bool]], allowing users to be creative with how they want to structure their component's logic. | |||
<!--T:5--> | <!--T:5--> | ||
Line 35: | Line 36: | ||
[[Category:Generics{{#translation:}}]] | [[Category:Generics{{#translation:}}]] | ||
[[Category:Components{{#translation:}}|Value Radio`1]] | [[Category:Components{{#translation:}}|Value Radio`1]] | ||
[[Category:Generic Components{{#translation:}}|Value Radio`1]] | [[Category:Generic Components{{#translation:}}|Value Radio`1]] | ||
[[Category:Components:UIX:Interaction{{#translation:}}|Value Radio`1]] | [[Category:Components:UIX:Interaction{{#translation:}}|Value Radio`1]] |
Latest revision as of 02:12, 28 July 2024
Component image
The ValueRadio component is a listener component that activates or deactivates slots using the CheckVisual
field, based if a TargetValue
matches the OptionValue
field. When a match is found, the CheckVisual
field will be set to true.
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. |
CheckVisual
|
field drive of Bool | The boolean that is driven to true whenever the TargetValue is equal to the OptionValue
|
OptionValue
|
T | What to set the TargetValue to when the button is pressed.
|
TargetValue
|
direct RelayRef`1<IField`1<T>> | The value to set when the button is pressed. |
Usage
To function, the component simply needs to be attached to a slot that also has a button component attached to it. From then on, pressing that button will activate the ValueRadio, making it set its TargetValue
to its OptionValue
, which then also sets its CheckVisual
to true.
- This is useful for making forms that need one answer from many choices, a set of button that should only have one being active, and anything that requires only one activation from many things.
- the
CheckVisual
field does not just have to be the active of a slot, this can be any IField bool, allowing users to be creative with how they want to structure their component's logic.