mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-24 10:37:20 +00:00
44 lines
2.4 KiB
Plaintext
44 lines
2.4 KiB
Plaintext
caption: radio
|
|
created: 20131212195353929
|
|
modified: 20211009121654734
|
|
tags: Widgets TriggeringWidgets
|
|
title: RadioWidget
|
|
type: text/vnd.tiddlywiki
|
|
|
|
! Introduction
|
|
|
|
The radio widget displays an HTML `<input type="radio">` that reflects whether a given tiddler field has a specified value. Selecting the radio button sets to the tiddler field to the value.
|
|
|
|
! Content and Attributes
|
|
|
|
The content of the `<$radio>` widget is displayed within an HTML `<label>` element also containing the radio button. This means that clicking on the content will have the same effect as clicking on the button itself.
|
|
|
|
|!Attribute |!Description |
|
|
|tiddler |Title of the tiddler to manipulate (defaults to the [[current tiddler|Current Tiddler]]) |
|
|
|field |The field of the //tiddler// bound to the radio button |
|
|
|index|<<.from-version "5.1.14">> The index of the //tiddler// being [[DataTiddler|DataTiddlers]] bound to the radio button (takes precedence over //field//) |
|
|
|default |<<.from-version "5.2.0">> The default value to be used for matching if the tiddler, field or index are missing |
|
|
|value |The value for the //field// or //index// of the //tiddler// |
|
|
|class |The CSS classes assigned to the label around the radio button <<.from-version "5.1.14">> `tc-radio` is always applied by default, as well as `tc-radio-selected` when selected |
|
|
|actions|<<.from-version "5.1.23">> Optional string containing ActionWidgets to be triggered when the value changes. <br>The variable: ''actionValue'' is available for the actions |
|
|
|disabled|<<.from-version "5.1.23">> Optional. Set to "yes" to disable the radio input. Defaults to "no" |
|
|
|
|
!! Field Mode
|
|
|
|
This example uses the radio widget to change the `modifier` field of this tiddler:
|
|
|
|
<<wikitext-example-without-html """<$radio field="modifier" value="JoeBloggs"> Joe Bloggs</$radio>
|
|
<$radio field="modifier" value="JaneBloggs"> Jane Bloggs</$radio>""">>
|
|
|
|
!! Index Mode
|
|
|
|
Using the radio widget in index mode requires the //index// attribute to specify the name of the index of a [[DataTiddler|DataTiddlers]] to which the specified //value// is assigned.
|
|
|
|
This example sets the `Tree Frog` index in the tiddler AnimalColours:
|
|
|
|
<$macrocall $name="wikitext-example-without-html" src="""<$tiddler tiddler="AnimalColours">
|
|
<$radio index="Tree Frog" value="green"> green</$radio>
|
|
<$radio index="Tree Frog" value="brown"> brown</$radio>
|
|
</$tiddler>"""/>
|
|
|
|
{{RadioWidget Example}} |