Skip to content

Commit 340a42a

Browse files
andrewseguintinayuangao
authored andcommitted
docs(tabs): make non-exported comps as docs private (#3510)
1 parent cbdf1a9 commit 340a42a

File tree

5 files changed

+30
-5
lines changed

5 files changed

+30
-5
lines changed

src/lib/tabs/index.ts

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,26 @@ import {SCROLL_DISPATCHER_PROVIDER} from '../core/overlay/scroll/scroll-dispatch
1818
@NgModule({
1919
imports: [CommonModule, PortalModule, MdRippleModule, ObserveContentModule],
2020
// Don't export all components because some are only to be used internally.
21-
exports: [MdTabGroup, MdTabLabel, MdTab, MdTabNavBar, MdTabLink, MdTabLinkRipple],
22-
declarations: [MdTabGroup, MdTabLabel, MdTab, MdInkBar, MdTabLabelWrapper,
23-
MdTabNavBar, MdTabLink, MdTabBody, MdTabLinkRipple, MdTabHeader],
21+
exports: [
22+
MdTabGroup,
23+
MdTabLabel,
24+
MdTab,
25+
MdTabNavBar,
26+
MdTabLink,
27+
MdTabLinkRipple
28+
],
29+
declarations: [
30+
MdTabGroup,
31+
MdTabLabel,
32+
MdTab,
33+
MdInkBar,
34+
MdTabLabelWrapper,
35+
MdTabNavBar,
36+
MdTabLink,
37+
MdTabBody,
38+
MdTabLinkRipple,
39+
MdTabHeader
40+
],
2441
providers: [VIEWPORT_RULER_PROVIDER, SCROLL_DISPATCHER_PROVIDER],
2542
})
2643
export class MdTabsModule {

src/lib/tabs/ink-bar.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
import {Directive, Renderer, ElementRef} from '@angular/core';
22

33

4-
/** The ink-bar is used to display and animate the line underneath the current active tab label. */
4+
/**
5+
* The ink-bar is used to display and animate the line underneath the current active tab label.
6+
* @docs-private
7+
*/
58
@Directive({
69
selector: 'md-ink-bar, mat-ink-bar',
710
host: {

src/lib/tabs/tab-body.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ export type MdTabBodyOriginState = 'left' | 'right';
4343

4444
/**
4545
* Wrapper for the contents of a tab.
46+
* @docs-private
4647
*/
4748
@Component({
4849
moduleId: module.id,

src/lib/tabs/tab-header.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ const EXAGGERATED_OVERSCROLL = 60;
3737
* an ink bar that follows the currently selected tab. When the tabs list's width exceeds the
3838
* width of the header container, then arrows will be displayed to allow the user to scroll
3939
* left and right across the header.
40+
* @docs-private
4041
*/
4142
@Component({
4243
moduleId: module.id,

src/lib/tabs/tab-label-wrapper.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@ import {Directive, ElementRef, Renderer, Input} from '@angular/core';
22
import {coerceBooleanProperty} from '../core/coercion/boolean-property';
33

44

5-
/** Used in the `md-tab-group` view to display tab labels */
5+
/**
6+
* Used in the `md-tab-group` view to display tab labels.
7+
* @docs-private
8+
*/
69
@Directive({
710
selector: '[md-tab-label-wrapper], [mat-tab-label-wrapper]',
811
host: {

0 commit comments

Comments
 (0)