1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-29 11:30:28 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/widgets/ActionSendMessageWidget.tid
nome 9e01a30dc7 Small documentation fixes
* Copy example from  ActionSendMessageWidget to tm-new-tiddler

It is counter-intuitive that the ActionSendMessageWidget documentation has more information on tm-new-tiddler than the more specific one.

* Fix link in reference docs

* Fix some typos
2016-04-04 12:45:31 +01:00

34 lines
1.4 KiB
Plaintext

caption: action-sendmessage
created: 20141008134309742
modified: 20150518210909583
tags: Widgets ActionWidgets
title: ActionSendMessageWidget
type: text/vnd.tiddlywiki
! Introduction
The ''action-sendmessage'' widget is an [[action widget|ActionWidgets]] that sends a [[message|Messages]] back up the widget tree. ActionWidgets are used within triggering widgets such as the ButtonWidget.
! Content and Attributes
The ''action-sendmessage'' widget is invisible. Any content within it is ignored.
|!Attribute |!Description |
|$message |The message to send (eg, [[WidgetMessage: tm-new-tiddler]]) |
|$param |Optional parameter string whose meaning is dependent on the message being sent |
|$name |Optional name of additional parameter |
|$value |Value for optional parameter whose name is specified in `$name` |
|//{any attributes not starting with $}// |Multiple additional, optional named parameters that are attached to the message |
! Examples
Here is an example of button that displays both a notification and a wizard, and creates a new tiddler with tags and text:
<$macrocall $name='wikitext-example-without-html'
src='<$button>
<$action-sendmessage $message="tm-modal" $param="SampleWizard"/>
<$action-sendmessage $message="tm-notify" $param="SampleNotification"/>
<$action-sendmessage $message="tm-new-tiddler" title="This is newly created tiddler" tags="OneTag [[Another Tag]]" text=<<now "Today is DDth, MMM YYYY">>/>
Click me!
</$button>'/>