Skip to content

Commit 9a33da6

Browse files
robertmesserlejelbourn
authored andcommitted
docs(tabs): adds README file (#527)
1 parent 31bf7ef commit 9a33da6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/components/tab-group/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# MdTabGroup
2+
Tab groups allow the user to organize their content by labels such that only one tab is visible at any given time.
3+
4+
### Examples
5+
A basic tab group would have the following markup.
6+
```html
7+
<md-tab-group>
8+
<md-tab>
9+
<template md-tab-label>One</template>
10+
<template md-tab-content>
11+
<h1>Some tab content</h1>
12+
<p>...</p>
13+
</template>
14+
</md-tab>
15+
<md-tab>
16+
<template md-tab-label>Two</template>
17+
<template md-tab-content>
18+
<h1>Some more tab content</h1>
19+
<p>...</p>
20+
</template>
21+
</md-tab>
22+
</md-tab-group>
23+
```
24+
25+
## `<md-tab-group>`
26+
### Properties
27+
28+
| Name | Type | Description |
29+
| --- | --- | --- |
30+
| `selectedIndex` | `number` | The index of the currently active tab. |

0 commit comments

Comments
 (0)