27th January 2025 at 1:44pm
The "copy to clipboard" message attempts to copy the specified text to the clipboard. If it succeeds, the tiddler $:/language/Notifications/CopiedToClipboard/Succeeded is displayed as a notification. If the browser doesn't permit the operation, the tiddler $:/language/Notifications/CopiedToClipboard/Failed is displayed instead.
It requires the following properties on the event object:
| Name | Description |
|---|---|
| param | Text to be copied to the clipboard |
| successNotification | New in v5.3.4 Optional title of tiddler containing notification to be used if the operation succeeds |
| failureNotification | New in v5.3.4 Optional title of tiddler containing notification to be used if the operation fails |
| type | New in v5.3.7 MIME type of the text to be copied, defaults to text/plain |
| plainText | New in v5.3.7 Additional plain text to be copied when type attribute isn't text/plain |
This message is usually generated with the ButtonWidget. It is handled by the TiddlyWiki core.
Example
This example copies the current time to the clipboard:
<$button message="tm-copy-to-clipboard" param=<<now>>>
Copy date to clipboard
</$button>That renders as: