Added descriptions. Added field descriptions. Added usage information.
(2 intermediate revisions by 2 users not shown)
Line 2:
Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ReferenceRadio`1Component.png
|Image=ReferenceRadio`1Component.png
Line 9:
Line 8:
<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''ReferenceRadio''' component is a listener component that activates or deactivates slots using the <code>CheckVisual</code> field, based if a <code>TargetReference</code> matches the <code>OptionReference</code> field. When a match is found, the <code>CheckVisual</code> field will be set to true.
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|CheckVisual|Bool|
|CheckVisual|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv0=true|The bool that will be set true when there is a match.
|OptionReference|Sync`1|TypeString1=Sync<T>|
|OptionReference|'''T'''|TypeAdv1=true|The reference we are checking a match for, when found, it will trigger this option.
|TargetReference|{{RootFieldType|RelayRef`1|[[Type:SyncRef`1|SyncRef`1]]<T>}}|TypeAdv2=true|The thing we are using to check.
}}
}}
<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
* 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.
The ReferenceRadio component is a listener component that activates or deactivates slots using the CheckVisual field, based if a TargetReference matches the OptionReference field. When a match is found, the CheckVisual field will be set 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 IFieldbool, allowing users to be creative with how they want to structure their component's logic.
