created: 20140723103751357
modified: 20240523174013095
tags: Messages
title: WidgetMessage: tm-permalink
type: text/vnd.tiddlywiki
caption: tm-permalink

The `tm-permalink` message changes the browser address bar to form a [[permalink|PermaLinks]] to a specified tiddler, defaulting to the current tiddler. The resulting link will be copied to the clipboard.

The permalink message supports the following properties on the `event` object:

|!Name |!Description |
|param |Title of the tiddler to be permalinked |
|tiddlerTitle |The current tiddler (used by default if the tiddler title isn't specified in the `param`) |
|successNotification |<<.from-version "5.3.4">> Optional title of tiddler containing notification to be used if the operation succeeds |
|failureNotification |<<.from-version "5.3.4">> Optional title of tiddler containing notification to be used if the operation fails |

The permalink message can be generated by the ButtonWidget, and is handled by the story mechanism.
