carbon-components-angular
Version:
Next generation components
1,304 lines (1,182 loc) • 67.1 kB
HTML
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>carbon-components-angular documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
<style>
footer.carbon {
position: absolute;
bottom: 0;
width: 100%;
z-index: 9999;
}
#root > div {
/*
* Subtracting the height of the footer to prevent
* overlaying the footer ontop of content
*/
height: calc(100vh - 48px);
}
</style>
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">carbon-components-angular documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content component">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Components</li>
<li class="breadcrumb-item"
>
Tabs</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info" class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source" class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
<li class="nav-item">
<a href="#tree" class="nav-link"
role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info"><p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/tabs/tabs.component.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Build out your application's tabs using this component.
This is the parent of the <code>Tab</code> and <code>TabHeader</code> components.</p>
<p><a href="../../?path=/story/components-tabs--basic">See demo</a></p>
<p><code>Tabs</code> expects a set of <code>n-tab</code> elements</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-html"><cds-tabs>
<cds-tab heading='tab1'>
tab 1 content
</cds-tab>
<cds-tab heading='tab1'>
tab 2 content
</cds-tab>
<!-- ... -->
<cds-tab heading='tab1'>
tab n content
</cds-tab>
</cds-tabs></code></pre></div>
</p>
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code>AfterContentInit</code>
<code>OnChanges</code>
</p>
<section data-compodoc="block-metadata">
<h3>Metadata</h3>
<table class="table table-sm table-hover metadata">
<tbody>
<tr>
<td class="col-md-3">selector</td>
<td class="col-md-9"><code>cds-tabs, ibm-tabs</code></td>
</tr>
<tr>
<td class="col-md-3">template</td>
<td class="col-md-9"><pre class="line-numbers"><code class="language-html"><ng-container *ngIf="skeleton">
<cds-tabs-skeleton [contained]="type === 'contained'"></cds-tabs-skeleton>
</ng-container>
<ng-container *ngIf="!skeleton">
<cds-tab-headers
*ngIf="hasTabHeaders() && position === 'top'"
[theme]="theme"
[tabs]="tabs"
[followFocus]="followFocus"
[cacheActive]="cacheActive"
[contentBefore]="before"
[contentAfter]="after"
[ariaLabel]="ariaLabel"
[ariaLabelledby]="ariaLabelledby"
[type]="type"
[iconSize]="iconSize"
[fullWidth]="fullWidth"
[dismissable]="dismissable"
[scrollIntoView]="scrollIntoView"
[scrollDebounceWait]="scrollDebounceWait"
(tabClose)="tabClose.emit($event)">
</cds-tab-headers>
<ng-content></ng-content>
<ng-template #before>
<ng-content select="[before]"></ng-content>
</ng-template>
<ng-template #after>
<ng-content select="[after]"></ng-content>
</ng-template>
<cds-tab-headers
*ngIf="hasTabHeaders() && position === 'bottom'"
[tabs]="tabs"
[cacheActive]="cacheActive"
[type]="type"
[iconSize]="iconSize"
[fullWidth]="fullWidth"
[dismissable]="dismissable"
[scrollIntoView]="scrollIntoView"
[scrollDebounceWait]="scrollDebounceWait"
(tabClose)="tabClose.emit($event)">
</cds-tab-headers>
</ng-container>
</code></pre></td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier"></span>
<a href="#tabHeaders" >tabHeaders</a>
</li>
<li>
<span class="modifier"></span>
<a href="#tabs" >tabs</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#hasTabHeaders" >hasTabHeaders</a>
</li>
<li>
<a href="#ngAfterContentInit" >ngAfterContentInit</a>
</li>
<li>
<a href="#ngOnChanges" >ngOnChanges</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Inputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#ariaLabel" >ariaLabel</a>
</li>
<li>
<a href="#ariaLabelledby" >ariaLabelledby</a>
</li>
<li>
<a href="#cacheActive" >cacheActive</a>
</li>
<li>
<a href="#dismissable" >dismissable</a>
</li>
<li>
<a href="#followFocus" >followFocus</a>
</li>
<li>
<a href="#fullWidth" >fullWidth</a>
</li>
<li>
<a href="#iconSize" >iconSize</a>
</li>
<li>
<a href="#isNavigation" >isNavigation</a>
</li>
<li>
<a href="#position" >position</a>
</li>
<li>
<a href="#scrollDebounceWait" >scrollDebounceWait</a>
</li>
<li>
<a href="#scrollIntoView" >scrollIntoView</a>
</li>
<li>
<a href="#skeleton" >skeleton</a>
</li>
<li>
<a href="#theme" >theme</a>
</li>
<li>
<a href="#type" >type</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Outputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#tabClose" >tabClose</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-inputs">
<h3 id="inputs">Inputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ariaLabel"></a>
<b>ariaLabel</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="106" class="link-to-prism">src/tabs/tabs.component.ts:106</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Sets the aria label on the <code>TabHeader</code>s nav element.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ariaLabelledby"></a>
<b>ariaLabelledby</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="110" class="link-to-prism">src/tabs/tabs.component.ts:110</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Sets the aria labelledby on the <code>TabHeader</code>s nav element.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="cacheActive"></a>
<b>cacheActive</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="94" class="link-to-prism">src/tabs/tabs.component.ts:94</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to have <code>Tab</code> items cached and not reloaded on tab switching.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dismissable"></a>
<b>dismissable</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="134" class="link-to-prism">src/tabs/tabs.component.ts:134</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Show a close control on each tab.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="followFocus"></a>
<b>followFocus</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>true</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="98" class="link-to-prism">src/tabs/tabs.component.ts:98</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to 'true' to have tabs automatically activated and have their content displayed when they receive focus.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="fullWidth"></a>
<b>fullWidth</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="130" class="link-to-prism">src/tabs/tabs.component.ts:130</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Evenly sized tabs across the row (contained, fewer than 9 tabs).</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="iconSize"></a>
<b>iconSize</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"default" | "lg"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="126" class="link-to-prism">src/tabs/tabs.component.ts:126</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>When using icon-only tabs, icon size: <code>default</code> (16px) or <code>lg</code> (20px).</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isNavigation"></a>
<b>isNavigation</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="102" class="link-to-prism">src/tabs/tabs.component.ts:102</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>When <code>true</code>, sets each tab panel <code>tabindex</code> to <code>-1</code> for navigation-style usage.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="position"></a>
<b>position</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"top" | "bottom"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"top"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="90" class="link-to-prism">src/tabs/tabs.component.ts:90</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Takes either <code>top</code> or <code>bottom</code> to place <code>TabHeader</code> relative to the tab panels.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="scrollDebounceWait"></a>
<b>scrollDebounceWait</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>200</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="142" class="link-to-prism">src/tabs/tabs.component.ts:142</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Debounce (ms) for tab list scroll events; affects overflow chevron updates.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="scrollIntoView"></a>
<b>scrollIntoView</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="138" class="link-to-prism">src/tabs/tabs.component.ts:138</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Scroll the active tab into view on focus/select.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="skeleton"></a>
<b>skeleton</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="122" class="link-to-prism">src/tabs/tabs.component.ts:122</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>When <code>true</code>, renders the tabs skeleton loading state.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="theme"></a>
<b>theme</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"light" | "dark"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"dark"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="118" class="link-to-prism">src/tabs/tabs.component.ts:118</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Theme for tab headers: <code>light</code> or <code>dark</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="type"></a>
<b>type</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"line" | "contained"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"line"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="114" class="link-to-prism">src/tabs/tabs.component.ts:114</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Visual style of the tab headers: <code>line</code> or <code>contained</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-outputs">
<h3 id="outputs">Outputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="tabClose"></a>
<b>tabClose</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>EventEmitter<number></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="148" class="link-to-prism">src/tabs/tabs.component.ts:148</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Emits when a tab close control is used (with <code>dismissable</code>).
The emitted value is the tab index.</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hasTabHeaders"></a>
<span class="name">
<span ><b>hasTabHeaders</b></span>
<a href="#hasTabHeaders"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>hasTabHeaders()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="188"
class="link-to-prism">src/tabs/tabs.component.ts:188</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>true if the cds-tab's are passed directly to the component as children</p>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ngAfterContentInit"></a>
<span class="name">
<span ><b>ngAfterContentInit</b></span>
<a href="#ngAfterContentInit"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ngAfterContentInit()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="163"
class="link-to-prism">src/tabs/tabs.component.ts:163</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>After content is initialized update <code>Tab</code>s to cache (if turned on) and set the initial
selected Tab item.</p>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ngOnChanges"></a>
<span class="name">
<span ><b>ngOnChanges</b></span>
<a href="#ngOnChanges"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ngOnChanges(changes: SimpleChanges)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="173"
class="link-to-prism">src/tabs/tabs.component.ts:173</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>changes</td>
<td>
<code>SimpleChanges</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="tabHeaders"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>tabHeaders</b></span>
<a href="#tabHeaders"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@ContentChild(TabHeaders)<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="157" class="link-to-prism">src/tabs/tabs.component.ts:157</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Content child of the projected header component</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="tabs"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>tabs</b></span>
<a href="#tabs"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../components/Tab.html" target="_self" >QueryList<Tab></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@ContentChildren(Tab, {descendants: false})<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="153" class="link-to-prism">src/tabs/tabs.component.ts:153</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Maintains a <code>QueryList</code> of the <code>Tab</code> elements and updates if <code>Tab</code>s are added or removed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
Component,
Input,
Output,
EventEmitter,
ContentChildren,
QueryList,
AfterContentInit,
ContentChild,
OnChanges,
SimpleChanges
} from "@angular/core";
import { Tab } from "./tab.component";
import { TabHeaders } from "./tab-headers.component";
/**
* Build out your application's tabs using this component.
* This is the parent of the `Tab` and `TabHeader` components.
*
* [See demo](../../?path=/story/components-tabs--basic)
*
* `Tabs` expects a set of `n-tab` elements
*
* ```html
* <cds-tabs>
* <cds-tab heading='tab1'>
* tab 1 content
* </cds-tab>
* <cds-tab heading='tab1'>
* tab 2 content
* </cds-tab>
* <!-- ... -->
* <cds-tab heading='tab1'>
* tab n content
* </cds-tab>
* </cds-tabs>
* ```
*/
@Component({
selector: "cds-tabs, ibm-tabs",
template: `
<ng-container *ngIf="skeleton">
<cds-tabs-skeleton [contained]="type === 'contained'"></cds-tabs-skeleton>
</ng-container>
<ng-container *ngIf="!skeleton">
<cds-tab-headers
*ngIf="hasTabHeaders() && position === 'top'"
[theme]="theme"
[tabs]="tabs"
[followFocus]="followFocus"
[cacheActive]="cacheActive"
[contentBefore]="before"
[contentAfter]="after"
[ariaLabel]="ariaLabel"
[ariaLabelledby]="ariaLabelledby"
[type]="type"
[iconSize]="iconSize"
[fullWidth]="fullWidth"
[dismissable]="dismissable"
[scrollIntoView]="scrollIntoView"
[scrollDebounceWait]="scrollDebounceWait"
(tabClose)="tabClose.emit($event)">
</cds-tab-headers>
<ng-content></ng-content>
<ng-template #before>
<ng-content select="[before]"></ng-content>
</ng-template>
<ng-template #after>
<ng-content select="[after]"></ng-content>
</ng-template>
<cds-tab-headers
*ngIf="hasTabHeaders() && position === 'bottom'"
[tabs]="tabs"
[cacheActive]="cacheActive"
[type]="type"
[iconSize]="iconSize"
[fullWidth]="fullWidth"
[dismissable]="dismissable"
[scrollIntoView]="scrollIntoView"
[scrollDebounceWait]="scrollDebounceWait"
(tabClose)="tabClose.emit($event)">
</cds-tab-headers>
</ng-container>
`
})
export class Tabs implements AfterContentInit, OnChanges {
/**
* Takes either `top` or `bottom` to place `TabHeader` relative to the tab panels.
*/
@Input() position: "top" | "bottom" = "top";
/**
* Set to `true` to have `Tab` items cached and not reloaded on tab switching.
*/
@Input() cacheActive = false;
/**
* Set to 'true' to have tabs automatically activated and have their content displayed when they receive focus.
*/
@Input() followFocus = true;
/**
* When `true`, sets each tab panel `tabindex` to `-1` for navigation-style usage.
*/
@Input() isNavigation = false;
/**
* Sets the aria label on the `TabHeader`s nav element.
*/
@Input() ariaLabel: string;
/**
* Sets the aria labelledby on the `TabHeader`s nav element.
*/
@Input() ariaLabelledby: string;
/**
* Visual style of the tab headers: `line` or `contained`.
*/
@Input() type: "line" | "contained" = "line";
/**
* Theme for tab headers: `light` or `dark`.
*/
@Input() theme: "light" | "dark" = "dark";
/**
* When `true`, renders the tabs skeleton loading state.
*/
@Input() skeleton = false;
/**
* When using icon-only tabs, icon size: `default` (16px) or `lg` (20px).
*/
@Input() iconSize: "default" | "lg";
/**
* Evenly sized tabs across the row (contained, fewer than 9 tabs).
*/
@Input() fullWidth = false;
/**
* Show a close control on each tab.
*/
@Input() dismissable = false;
/**
* Scroll the active tab into view on focus/select.
*/
@Input() scrollIntoView = false;
/**
* Debounce (ms) for tab list scroll events; affects overflow chevron updates.
*/
@Input() scrollDebounceWait = 200;
/**
* Emits when a tab close control is used (with `dismissable`).
* The emitted value is the tab index.
*/
@Output() tabClose: EventEmitter<number> = new EventEmitter<number>();
/**
* Maintains a `QueryList` of the `Tab` elements and updates if `Tab`s are added or removed.
*/
@ContentChildren(Tab, { descendants: false }) tabs: QueryList<Tab>;
/**
* Content child of the projected header component
*/
@ContentChild(TabHeaders) tabHeaders;
/**
* After content is initialized update `Tab`s to cache (if turned on) and set the initial
* selected Tab item.
*/
ngAfterContentInit() {
if (this.tabHeaders) {
this.tabHeaders.cacheActive = this.cacheActive;
}
this.tabs.forEach(tab => {
tab.tabIndex = this.isNavigation ? null : 0;
});
}
ngOnChanges(changes: SimpleChanges) {
if (this.tabHeaders && changes.cacheActive) {
this.tabHeaders.cacheActive = this.cacheActive;
}
if (this.tabs && changes.isNavigation) {
this.tabs.forEach(tab => {
tab.tabIndex = this.isNavigation ? null : 0;
});
}
}
/**
* true if the cds-tab's are passed directly to the component as children
*/
hasTabHeaders() {
return this.tabs.length > 0;
}
}
</code></pre>
</div>
<div class="tab-pane fade " id="tree">
<div id="tree-container"></div>
<div class="tree-legend">
<div class="title">
<b>Legend</b>
</div>
<div>
<div class="color htmlelement"></div><span>Html element</span>
</div>
<div>
<div class="color component"></div><span>Component</span>
</div>
<div>
<div class="color directive"></div><span>Html element with directive</span>
</div>
</div>
</div>
</div>
<script src="../js/libs/vis.min.js"></script>
<script src="../js/libs/htmlparser.js"></script>
<script src="../js/libs/deep-iterator.js"></script>
<script>
var COMPONENT_TEMPLATE = '<div><ng-container *ngIf="skeleton"> <cds-tabs-skeleton [contained]="type === \'contained\'"></cds-tabs-skeleton></ng-container><ng-container *ngIf="!skeleton"> <cds-tab-headers *ngIf="hasTabHeaders() && position === \'top\'" [theme]="theme" [tabs]="tabs" [followFocus]="followFocus" [cacheActive]="cacheActive" [contentBefore]="before" [contentAfter]="after" [ariaLabel]="ariaLabel" [ariaLabelledby]="ariaLabelledby" [type]="type" [iconSize]="iconSize" [fullWidth]="fullWidth" [dismissable]="dismissable" [scrollIntoView]="scrollIntoView" [scrollDebounceWait]="scrollDebounceWait" (tabClose)="tabClose.emit($event)"> </cds-tab-headers> <ng-content></ng-content> <ng-template #before> <ng-content select="[before]"></ng-content> </ng-template> <ng-template #after> <ng-content select="[after]"></ng-content> </ng-template> <cds-tab-headers *ngIf="hasTabHeaders() && position === \'bottom\'" [tabs]="tabs" [cacheActive]="cacheActive" [type]="type" [iconSize]="iconSize" [fullWidth]="fullWidth" [dismissable]="dismissable" [scrollIntoView]="scrollIntoView" [scrollDebounceWait]="scrollDebounceWait" (tabClose)="tabClose.emit($event)"> </cds-tab-headers></ng-container> </div>'
var COMPONENTS = [{'name': 'Accordion', 'selector': 'cds-accordion, ibm-accordion'},{'name': 'AccordionItem', 'selector': 'cds-accordion-item, ibm-accordion-item'},{'name': 'ActionableNotification', 'selector': 'cds-actionable-notification, ibm-actionable-notification'},{'name': 'AILabelComponent', 'selector': 'cds-ai-label, ibm-ai-label'},{'name': 'AlertModal', 'selector': 'cds-alert-modal, ibm-alert-modal'},{'name': 'BaseIconButton', 'selector': ''},{'name': 'BaseNotification', 'selector': ''},{'name': 'BaseTabHeader', 'selector': ''},{'name': 'Breadcrumb', 'selector': 'cds-breadcrumb, ibm-breadcrumb'},{'name': 'BreadcrumbItemComponent', 'selector': 'c