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

created: 20130824154300000
modified: 20150220162134000
tags: Widgets
title: TiddlerWidget
type: text/vnd.tiddlywiki
caption: tiddler

! Introduction

The TiddlerWidget is used to set a value for the [[current tiddler|Current Tiddler]] variable, valid within the scope of the TiddlerWidget.

! Content and Attributes

|!Attribute |!Description |
|tiddler |The title of the tiddler to become the new [[current tiddler|Current Tiddler]] |
|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
: `tc-tiddler-exists` or...
: `tc-tiddler-missing` depending on whether the tiddler exists
;shadowTiddlerClass
: `tc-tiddler-shadow` if the tiddler is a shadow tiddler
;systemTiddlerClass
:` tc-tiddler-system` if the tiddler is a system tiddler
;tiddlerTagClasses
: a space separated list of CSS classes named `tc-tagged-{tagname}`,<br>e.g. `tc-tagged-introduction`<br><br>''Note:'' tag names are URI encoded which means that the tag [[$:/tags/Macro]] appears as the CSS class `tc-tagged-%24%3A%2Ftags%2FMacro`. See [[How to apply custom styles by tag]] for more details

You can use these variables like this:

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

See also [[$:/core/ui/ViewTemplate]].
Docs updates 2014-01-07 11:57:42 +00:00			`created: 20130824154300000`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`modified: 20150220162134000`
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`tags: Widgets`
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`
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`caption: tiddler`
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`

Clarified intro statment for TiddlerWidget (#2770) Ref [discussion](https://groups.google.com/d/msg/tiddlywiki/S-DliskYksE/55c6_CssCgAJ). 2017-02-23 17:02:49 +00:00			`The TiddlerWidget is used to set a value for the [[current tiddler\|Current Tiddler]] variable, valid within the scope of the TiddlerWidget.`
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 \|`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`\|tiddler \|The title of the tiddler to become the new [[current tiddler\|Current Tiddler]] \|`
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:`

fixes example and improves readability 2014-12-31 11:38:15 +00:00			`; missingTiddlerClass`
			: `tc-tiddler-exists` or...
			: `tc-tiddler-missing` depending on whether the tiddler exists
			`;shadowTiddlerClass`
Tweaks to tiddler widget docs 2015-01-02 17:11:37 +00:00			: `tc-tiddler-shadow` if the tiddler is a shadow tiddler
fixes example and improves readability 2014-12-31 11:38:15 +00:00			`;systemTiddlerClass`
Tweaks to tiddler widget docs 2015-01-02 17:11:37 +00:00			:` tc-tiddler-system` if the tiddler is a system tiddler
fixes example and improves readability 2014-12-31 11:38:15 +00:00			`;tiddlerTagClasses`
Tweaks to tiddler widget docs 2015-01-02 17:11:37 +00:00			: a space separated list of CSS classes named `tc-tagged-{tagname}`,<br>e.g. `tc-tagged-introduction`<br><br>''Note:'' tag names are URI encoded which means that the tag [[$:/tags/Macro]] appears as the CSS class `tc-tagged-%24%3A%2Ftags%2FMacro`. See [[How to apply custom styles by tag]] for more details
Docs update 2014-08-02 12:39:02 +00:00
			`You can use these variables like this:`

			```
			`<$tiddler tiddler="MyOtherTiddler">`
			`<div class=<<missingTiddlerClass>>>`
			`<$transclude/>`
fixes example and improves readability 2014-12-31 11:38:15 +00:00			`</div>`
Docs update 2014-08-02 12:39:02 +00:00			`</$tiddler>`
			```

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