1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
(sd-tabs)=
# Tabs
Tabs organize and allow navigation between groups of content that are related and at the same level of hierarchy.
Each tab should contain content that is distinct from other tabs in a set.
::::{tab-set}
:::{tab-item} Label1
Content 1
:::
:::{tab-item} Label2
Content 2
:::
::::
`````{dropdown-syntax}
````{tab-set-code}
```{literalinclude} ./snippets/myst/tab-basic.txt
:language: markdown
```
```{literalinclude} ./snippets/rst/tab-basic.txt
:language: rst
```
````
`````
See the [Material Design](https://material.io/components/tabs) description for further details.
## Synchronised Tabs
The Selection of tab items can be synchronised across multiple tab-sets.
For a `tab-item` to be synchronisable, add the `sync` option to the `tab-item` directive with a key unique to that set.
Now when you select a tab in one set, tabs in other sets with the same key will be selected.
:::{note}
Synchronisation requires that JavaScript is enabled.
:::
:::{versionadded} 0.6.0
To synchronise tabs only across certain tab-sets, add the `:sync-group:` option to each `tab-set` directive with the same group name, such as `:sync-group: category`.
You can also add an [HTML query string](https://en.wikipedia.org/wiki/Query_string) to the end of the page's URL,
to automatically select a tab with a specific key across all tab-sets of the group, for example:
- [`?category=key1#synchronised-tabs`](?category=key1#synchronised-tabs){.external}
- [`?category=key2#synchronised-tabs`](?category=key2#synchronised-tabs){.external}
:::
::::{tab-set}
:sync-group: category
:::{tab-item} Label1
:sync: key1
Content 1
:::
:::{tab-item} Label2
:sync: key2
Content 2
:::
::::
::::{tab-set}
:sync-group: category
:::{tab-item} Label1
:sync: key1
Content 1
:::
:::{tab-item} Label2
:sync: key2
Content 2
:::
::::
`````{dropdown-syntax}
````{tab-set-code}
```{literalinclude} ./snippets/myst/tab-sync.txt
:language: markdown
```
```{literalinclude} ./snippets/rst/tab-sync.txt
:language: rst
```
````
`````
## Tabbed code examples
The `tab-set-code` directive provides a shorthand for synced code examples.
You can place any directives in a `tab-set-code` that produce a `literal_block` node with a `language` attribute, for example `code`, `code-block` and `literalinclude`.
Tabs will be labelled and synchronised by the `language` attribute (in upper-case).
:::{versionadded} 0.6.0
You can also add an [HTML query string](https://en.wikipedia.org/wiki/Query_string) to the end of the page's URL,
to automatically select a tab with a specific code across all tab-sets of the group, for example:
- [`?code=markdown#tabbed-code-examples`](?code=markdown#tabbed-code-examples){.external}
- [`?code=rst#tabbed-code-examples`](?code=rst#tabbed-code-examples){.external}
:::
```````{tab-set}
:sync-group: code
``````{tab-item} Markdown
:sync: markdown
````{literalinclude} ./snippets/myst/tab-code-set.txt
:language: markdown
````
``````
``````{tab-item} RST
:sync: rst
````{literalinclude} ./snippets/rst/tab-code-set.txt
:language: rst
````
``````
```````
## Tabs in other components
Tabs can be nested inside other components, such as inside [dropdowns](./dropdowns.md) or within [grid items](./grids.md).
:::::{dropdown} Tabs in dropdown
:open:
Paragraph
::::{tab-set}
:::{tab-item} Label1
:sync: label-1
Content 1
:::
:::{tab-item} Label2
:sync: label-2
Content 2
:::
::::
:::::
::::::{grid} 1 1 2 2
:::::{grid-item}
:outline:
Initial paragraph
::::{tab-set}
:::{tab-item} Label1
:sync: label-1
Content 1
:::
:::{tab-item} Label2
:sync: label-2
Content 2
:::
::::
:::::
:::::{grid-item}
:outline:
::::{tab-set}
:::{tab-item} Label1
:sync: label-1
Content 1
:::
:::{tab-item} Label2
:sync: label-2
Content 2
:::
::::
Ending paragraph
:::::
::::::
Tab set, within tab set:
::::::{tab-set}
:::::{tab-item} Label 1
::::{tab-set}
:::{tab-item} Label 1a
Content 1a
:::
:::{tab-item} Label 1b
Content 1b
:::
::::
:::::
:::::{tab-item} Label 2
Content 2
:::::
::::::
## `tab-set` options
sync-group
: A group name for synchronised tab sets (default `tab`).
class
: Additional CSS classes for the container element.
## `tab-set-code` options
no-sync
: Disable synchronisation of tabs.
sync-group
: A group name for synchronised tab sets (default `code`).
class-set
: Additional CSS classes for the set container element.
class-item
: Additional CSS classes for the item container element.
## `tab-item` options
selected
: a flag indicating whether the tab should be selected by default.
sync
: A key that is used to sync the selected tab across multiple tab-sets.
name
: Set a reference-able name for the dropdown container.
class-container
: Additional CSS classes for the container element.
class-label
: Additional CSS classes for the label element.
class-content
: Additional CSS classes for the content element.
|
