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

created: 20130824154300000
modified: 20140802114152456
tags: widget
title: TiddlerWidget
type: text/vnd.tiddlywiki

! Introduction

The TiddlerWidget sets the CurrentTiddler that applies for processing its content.

! Content and Attributes

|!Attribute |!Description |
|tiddler |The title of the tiddler to become the new CurrentTiddler |
|class |CSS classes to be added to the generated elements |

! CSS Class Variables

The tiddler widget assigns several useful CSS classes to variables that it creates:

* ''missingTiddlerClass'': ''"tw-tiddler-exists"'' or ''"tw-tiddler-missing"'' depending upon whether the target tiddler exists
* ''shadowTiddlerClass'': ''"tw-tiddler-shadow"'' if the tiddler is a shadow tiddler
* ''systemTiddlerClass'': ''"tw-tiddler-system"'' if the tiddler is a system tiddler
* ''tiddlerTagClasses'': A space separated list of CSS classes named ''"tw-tagged-{tagname}"''. For example ''"tw-tagged-introduction"''. Note that tag names are UrlEncoded which means that the tag ''$:/tags/Macro'' appears as the CSS class ''"tw-tagged-%24%3A%2Ftags%2FMacro"''

You can use these variables like this:

```
<$tiddler tiddler="MyOtherTiddler">
<div class=<<missingTiddlerClass>>>
<$transclude/>
</$tiddler>
```

See also [[$:/core/ui/ViewTemplate]].
Docs updates 2014-01-07 11:57:42 +00:00			`created: 20130824154300000`
Docs update 2014-08-02 12:39:02 +00:00			`modified: 20140802114152456`
Get rid of the 'docs' tag It was unnecessary, since everything here is documentation 2013-08-25 20:41:00 +00:00			`tags: widget`
Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00			`title: TiddlerWidget`
Docs updates 2014-01-07 11:57:42 +00:00			`type: text/vnd.tiddlywiki`
Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00
			`! Introduction`

Docs updates 2014-01-07 11:57:42 +00:00			`The TiddlerWidget sets the CurrentTiddler that applies for processing its content.`
Split "transclude" widget into a separate "tiddler" and "transclude" widget Belatedly realised that the design would be clearer without these two separate concepts being conflated into a single widget. As a result of this change, any other widget or template that generates transclude widgets has needed adjustment. 2013-08-24 15:45:45 +00:00
			`! Content and Attributes`

			`\|!Attribute \|!Description \|`
Docs updates 2014-01-07 11:57:42 +00:00			`\|tiddler \|The title of the tiddler to become the new CurrentTiddler \|`
Docs typo 2014-08-04 12:31:52 +00:00			`\|class \|CSS classes to be added to the generated elements \|`
Docs update 2014-08-02 12:39:02 +00:00
			`! CSS Class Variables`

			`The tiddler widget assigns several useful CSS classes to variables that it creates:`

			`* ''missingTiddlerClass'': ''"tw-tiddler-exists"'' or ''"tw-tiddler-missing"'' depending upon whether the target tiddler exists`
			`* ''shadowTiddlerClass'': ''"tw-tiddler-shadow"'' if the tiddler is a shadow tiddler`
			`* ''systemTiddlerClass'': ''"tw-tiddler-system"'' if the tiddler is a system tiddler`
			`* ''tiddlerTagClasses'': A space separated list of CSS classes named ''"tw-tagged-{tagname}"''. For example ''"tw-tagged-introduction"''. Note that tag names are UrlEncoded which means that the tag ''$:/tags/Macro'' appears as the CSS class ''"tw-tagged-%24%3A%2Ftags%2FMacro"''`

			`You can use these variables like this:`

			```
			`<$tiddler tiddler="MyOtherTiddler">`
			`<div class=<<missingTiddlerClass>>>`
			`<$transclude/>`
			`</$tiddler>`
			```

			`See also [[$:/core/ui/ViewTemplate]].`