Skip to content

Commit 00063eb

Browse files
committed
Add JSDoc to cdk tabs directives
1 parent 3d3c9ca commit 00063eb

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

src/cdk-experimental/tabs/tabs.ts

+27
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,26 @@ import {TabpanelPattern} from '@angular/cdk-experimental/ui-patterns/tabs/tabpan
2323
import {toSignal} from '@angular/core/rxjs-interop';
2424
import {_IdGenerator} from '@angular/cdk/a11y';
2525

26+
/**
27+
* A Tabs container.
28+
*
29+
* Represents a set of layered sections of content. The CdkTabs is a container meant to be used with
30+
* CdkTablist, CdkTab, and CdkTabpanel as follows:
31+
*
32+
* ```html
33+
* <div cdkTabs>
34+
* <ul cdkTablist>
35+
* <li cdkTab>Tab 1</li>
36+
* <li cdkTab>Tab 2</li>
37+
* <li cdkTab>Tab 3</li>
38+
* </ul>
39+
*
40+
* <div cdkTabpanel>Tab content 1</div>
41+
* <div cdkTabpanel>Tab content 2</div>
42+
* <div cdkTabpanel>Tab content 3</div>
43+
* </div>
44+
* ```
45+
*/
2646
@Directive({
2747
selector: '[cdkTabs]',
2848
exportAs: 'cdkTabs',
@@ -44,6 +64,11 @@ export class CdkTabs {
4464
tabpanels = computed(() => this._cdkTabpanels().map(tabpanel => tabpanel.pattern));
4565
}
4666

67+
/**
68+
* A Tablist container.
69+
*
70+
* Controls a list of CdkTab(s).
71+
*/
4772
@Directive({
4873
selector: '[cdkTablist]',
4974
exportAs: 'cdkTablist',
@@ -105,6 +130,7 @@ export class CdkTablist {
105130
});
106131
}
107132

133+
/** A selectable tab in a tablist. */
108134
@Directive({
109135
selector: '[cdkTab]',
110136
exportAs: 'cdkTab',
@@ -159,6 +185,7 @@ export class CdkTab {
159185
});
160186
}
161187

188+
/** A Tabpanel container for the resources of layered content associated with a tab. */
162189
@Directive({
163190
selector: '[cdkTabpanel]',
164191
exportAs: 'cdkTabpanel',

0 commit comments

Comments
 (0)