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

title: LinkWidget
tags: widget

The `link` widget generates links to tiddlers.

! Content and Attributes

|!Attribute |!Description |
|to |The title of the target tiddler for the link (defaults to the [[WidgetVariable: currentTiddler]]) |

The content of the link widget is rendered within the `<a>` tag.

! CSS Classes

* `tw-tiddlylink` - applied to all links
* `tw-tiddlylink-external` - applied to external, non-tiddler links
* `tw-tiddlylink-internal` - applied to tiddler links
* `tw-tiddlylink-missing` - applied to tiddler links where the target tiddler doesn't exist
* `tw-tiddlylink-resolves` - applied to tiddler links when the target tiddler does exist

! Configuration macros

Configuration macros can be used to modify the behaviour of the link widget.

!! tw-wikilinks

Links are suppressed if the macro `tw-wikilinks` evaluates to the string `no`. For example:

```
\define tw-wikilinks() no
```

!! tw-wikilink-template

Link targets default to the URL encoded title of the tiddler. The `href` can be templated by defining the configuration macro `tw-wikilink-template`, and including within it the token `$uri_encoded$`. For example:

```
\define tw-wikilink-template() http://tiddlywiki.com/#$uri_encoded$
```

Note that in the browser the `<a>` element generated by the link widget has a JavaScript event handler that navigates directly to the target tiddler, ignoring the `href` attribute.
Allow templating with the link widget And add some documentation 2013-03-04 11:13:10 +00:00			`title: LinkWidget`
Get rid of the 'docs' tag It was unnecessary, since everything here is documentation 2013-08-25 20:41:00 +00:00			`tags: widget`
Allow templating with the link widget And add some documentation 2013-03-04 11:13:10 +00:00
Docs updates 2013-10-23 22:12:19 +00:00			The `link` widget generates links to tiddlers.
Allow templating with the link widget And add some documentation 2013-03-04 11:13:10 +00:00
Docs updates 2013-10-23 22:12:19 +00:00			`! Content and Attributes`
Allow templating with the link widget And add some documentation 2013-03-04 11:13:10 +00:00
Docs updates 2013-10-23 22:12:19 +00:00			`\|!Attribute \|!Description \|`
Docs updates 2013-11-01 15:00:17 +00:00			`\|to \|The title of the target tiddler for the link (defaults to the [[WidgetVariable: currentTiddler]]) \|`
Docs update 2013-03-04 14:42:41 +00:00
Docs updates 2013-10-23 22:12:19 +00:00			The content of the link widget is rendered within the `<a>` tag.
Allow templating with the link widget And add some documentation 2013-03-04 11:13:10 +00:00
			`! CSS Classes`

Docs update 2013-03-04 14:42:41 +00:00			* `tw-tiddlylink` - applied to all links
			* `tw-tiddlylink-external` - applied to external, non-tiddler links
			* `tw-tiddlylink-internal` - applied to tiddler links
			* `tw-tiddlylink-missing` - applied to tiddler links where the target tiddler doesn't exist
			* `tw-tiddlylink-resolves` - applied to tiddler links when the target tiddler does exist
Allow templating with the link widget And add some documentation 2013-03-04 11:13:10 +00:00
			`! Configuration macros`

			`Configuration macros can be used to modify the behaviour of the link widget.`

			`!! tw-wikilinks`

			Links are suppressed if the macro `tw-wikilinks` evaluates to the string `no`. For example:

			```
			`\define tw-wikilinks() no`
			```

			`!! tw-wikilink-template`

			Link targets default to the URL encoded title of the tiddler. The `href` can be templated by defining the configuration macro `tw-wikilink-template`, and including within it the token `$uri_encoded$`. For example:

			```
			`\define tw-wikilink-template() http://tiddlywiki.com/#$uri_encoded$`
			```
Docs updates 2013-10-23 22:12:19 +00:00
			Note that in the browser the `<a>` element generated by the link widget has a JavaScript event handler that navigates directly to the target tiddler, ignoring the `href` attribute.