TiddlyWiki5/editions/tw5.com/tiddlers/macros/TabsMacro.tid

created: 20131228162203521
modified: 20140928113527667
tags: Macros
title: TabsMacro
type: text/vnd.tiddlywiki
caption: tabs

The tabs macro displays a list of tiddlers as a tab control. The user can switch between tabs by clicking on them. The tabs are labelled with the title of the corresponding tiddler, unless there is a `caption` field present in which case it is used instead.

By default the tab control arranges the tabs horizontally with the content underneath. You can also choose to have the tabs arranged vertically by passing the class `tc-vertical`.

! Parameters

|!Position |!Name |!Description |!Default |
|1st |tabsList |Filter giving the tiddlers to be displayed | |
|2nd |default |Name of the tiddler containing the default tab | |
|3rd |state |String to distinguish multiple tabs within the same tiddler (use of the system tiddler prefix is recommended) |''$:/state/tab'' |
|4th |class |Additional CSS classes for the three wrappers DIV of the tab | |
|5th |template |Optional template through which to render the tab content | |

Within the template the title of the current tab is available in the widget variable ''currentTab''. The ''currentTiddler'' variable is not affected by the tabs macro.

! Examples

Here are some examples of the tabs macro:

```
<<tabs "SampleTabOne SampleTabTwo SampleTabThree SampleTabFour" "SampleTabThree" "$:/state/tab1">>

<<tabs "[tag[sampletab]]" "SampleTabTwo" "$:/state/tab2" "tc-vertical">>
```

<<tabs "SampleTabOne SampleTabTwo SampleTabThree SampleTabFour" "SampleTabThree" "$:/state/tab1">>

<<tabs "[tag[sampletab]]" "SampleTabTwo" "$:/state/tab2" "tc-vertical">>
Docs update Hopefully fixing #309 2013-12-28 17:57:11 +00:00			`created: 20131228162203521`
Update tabs macro documentation 2014-09-28 11:25:27 +00:00			`modified: 20140928113527667`
Update macro reference docs 2014-09-10 22:42:06 +00:00			`tags: Macros`
Docs update Hopefully fixing #309 2013-12-28 17:57:11 +00:00			`title: TabsMacro`
			`type: text/vnd.tiddlywiki`
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`caption: tabs`
Sort out the docs for the tabs macro 2013-11-21 17:32:24 +00:00
Docs update 2014-02-26 08:27:40 +00:00			The tabs macro displays a list of tiddlers as a tab control. The user can switch between tabs by clicking on them. The tabs are labelled with the title of the corresponding tiddler, unless there is a `caption` field present in which case it is used instead.
Sort out the docs for the tabs macro 2013-11-21 17:32:24 +00:00
Rename more "tw-" classes to "tc-" Part of #764 2014-08-28 18:08:31 +00:00			By default the tab control arranges the tabs horizontally with the content underneath. You can also choose to have the tabs arranged vertically by passing the class `tc-vertical`.
Refactor vertical tabs for reusability In practice, if you look at TabsMacro you’ll see that the width of the tab content is wrong, and will usually overflow the container. Next step is to fix that by using flexbox… 2014-05-11 17:47:14 +00:00
Sort out the docs for the tabs macro 2013-11-21 17:32:24 +00:00			`! Parameters`

			`\|!Position \|!Name \|!Description \|!Default \|`
			`\|1st \|tabsList \|Filter giving the tiddlers to be displayed \| \|`
			`\|2nd \|default \|Name of the tiddler containing the default tab \| \|`
Docs update 2014-02-26 08:27:40 +00:00			`\|3rd \|state \|String to distinguish multiple tabs within the same tiddler (use of the system tiddler prefix is recommended) \|''$:/state/tab'' \|`
Refactor vertical tabs for reusability In practice, if you look at TabsMacro you’ll see that the width of the tab content is wrong, and will usually overflow the container. Next step is to fix that by using flexbox… 2014-05-11 17:47:14 +00:00			`\|4th \|class \|Additional CSS classes for the three wrappers DIV of the tab \| \|`
Extend the tabs macro to allow tab contents to be templated 2014-07-02 11:15:52 +00:00			`\|5th \|template \|Optional template through which to render the tab content \| \|`
Sort out the docs for the tabs macro 2013-11-21 17:32:24 +00:00
Update tabs macro documentation 2014-09-28 11:25:27 +00:00			`Within the template the title of the current tab is available in the widget variable ''currentTab''. The ''currentTiddler'' variable is not affected by the tabs macro.`
Fix problem with tabs macro changing current tiddler The problem was introduced in e18d8a88661a1c2caa1b722841747c75ca6af437 2014-07-12 08:07:51 +00:00
Sort out the docs for the tabs macro 2013-11-21 17:32:24 +00:00			`! Examples`

Update tabs macro docs 2014-07-25 07:45:57 +00:00			`Here are some examples of the tabs macro:`
Sort out the docs for the tabs macro 2013-11-21 17:32:24 +00:00
Docs update Hopefully fixing #309 2013-12-28 17:57:11 +00:00			```
Improved tabs examples 2014-07-25 07:49:58 +00:00			`<<tabs "SampleTabOne SampleTabTwo SampleTabThree SampleTabFour" "SampleTabThree" "$:/state/tab1">>`
Update tabs macro docs 2014-07-25 07:45:57 +00:00
Rename more "tw-" classes to "tc-" Part of #764 2014-08-28 18:08:31 +00:00			`<<tabs "[tag[sampletab]]" "SampleTabTwo" "$:/state/tab2" "tc-vertical">>`
Docs update Hopefully fixing #309 2013-12-28 17:57:11 +00:00			```

Improved tabs examples 2014-07-25 07:49:58 +00:00			`<<tabs "SampleTabOne SampleTabTwo SampleTabThree SampleTabFour" "SampleTabThree" "$:/state/tab1">>`
Sort out the docs for the tabs macro 2013-11-21 17:32:24 +00:00
Rename more "tw-" classes to "tc-" Part of #764 2014-08-28 18:08:31 +00:00			`<<tabs "[tag[sampletab]]" "SampleTabTwo" "$:/state/tab2" "tc-vertical">>`