TiddlyWiki5/editions/tw5.com/tiddlers/widgets/ButtonWidget.tid

title: ButtonWidget
created: 201310241419
modified: 201402220837
tags: widget

! Introduction

The button widget displays an HTML `<button>` element that can perform a combination optional actions when clicked:

* Navigate to a specified tiddler
* Dispatch a user defined [[widget message|WidgetMessages]]
* Trigger a user defined [[popup|PopupMechanism]]
* Assign new text to a specified tiddler

! Content and Attributes

The content of the `<$button>` widget is displayed within the button.

|!Attribute |!Description |
|to |The title of the tiddler to navigate to |
|message |The name of the [[widget message|WidgetMessages]] to send when the button is clicked |
|param |The optional parameter to the message |
|set |The title of a tiddler to which a new value will be assigned |
|setTo |The new value to assign to the tiddler identified in the `set` attribute |
|popup |Title of a state tiddler for a popup that is toggled when the button is clicked |
|class |An optional CSS class name to be assigned to the HTML element |
|style |An optional CSS style attribute to be assigned to the HTML element |
|selectedClass |An optional additional CSS class to be assigned if the popup is triggered or the tiddler specified in `set` already has the value specified in `setTo`  |
|default |Default value if `set` tiddler is missing for testing against `setTo` to determine `selectedClass` |
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00			`title: ButtonWidget`
			`created: 201310241419`
Extend button widget to allow navigating to a tiddler Fixes #327 2014-02-22 16:13:16 +00:00			`modified: 201402220837`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00			`tags: widget`

			`! Introduction`

			The button widget displays an HTML `<button>` element that can perform a combination optional actions when clicked:

Extend button widget to allow navigating to a tiddler Fixes #327 2014-02-22 16:13:16 +00:00			`* Navigate to a specified tiddler`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00			`* Dispatch a user defined [[widget message\|WidgetMessages]]`
			`* Trigger a user defined [[popup\|PopupMechanism]]`
			`* Assign new text to a specified tiddler`

			`! Content and Attributes`

			The content of the `<$button>` widget is displayed within the button.

			`\|!Attribute \|!Description \|`
Extend button widget to allow navigating to a tiddler Fixes #327 2014-02-22 16:13:16 +00:00			`\|to \|The title of the tiddler to navigate to \|`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00			`\|message \|The name of the [[widget message\|WidgetMessages]] to send when the button is clicked \|`
			`\|param \|The optional parameter to the message \|`
			`\|set \|The title of a tiddler to which a new value will be assigned \|`
			\|setTo \|The new value to assign to the tiddler identified in the `set` attribute \|
			`\|popup \|Title of a state tiddler for a popup that is toggled when the button is clicked \|`
			`\|class \|An optional CSS class name to be assigned to the HTML element \|`
			`\|style \|An optional CSS style attribute to be assigned to the HTML element \|`
			\|selectedClass \|An optional additional CSS class to be assigned if the popup is triggered or the tiddler specified in `set` already has the value specified in `setTo` \|
Add 'default' attribute to button widget This allows us to do things like tab controls properly. 2013-11-04 09:59:26 +00:00			\|default \|Default value if `set` tiddler is missing for testing against `setTo` to determine `selectedClass` \|