carbon-components-angular
Version:
Next generation components
2,718 lines • 124 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"
>
CodeSnippet</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/code-snippet/code-snippet.component.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Get started with importing the module:</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">import { CodeSnippetModule } from 'carbon-components-angular';</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html"><cds-code-snippet>Code</cds-code-snippet></code></pre></div><p><a href="../../?path=/story/components-code-snippet--basic">See demo</a></p>
</p>
<p class="comment">
<h3>Extends</h3>
</p>
<p class="comment">
<code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</p>
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code>OnInit</code>
<code>AfterViewInit</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-code-snippet, ibm-code-snippet</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="display === 'inline'; else notInline">
<ng-container *ngIf="!hideCopyButton; else noBtnInline">
<ng-container *ngTemplateOutlet="buttonTemplate"></ng-container>
</ng-container>
<ng-template #noBtnInline>
<span
class="cds--snippet cds--snippet--inline cds--snippet--no-copy"
[ngClass]="{
'cds--snippet--light': theme === 'light'
}">
<code #code>
<ng-container *ngTemplateOutlet="codeTemplate"></ng-container>
</code>
</span>
</ng-template>
</ng-container>
<ng-template #notInline>
<div
#codeContainer
class="cds--snippet-container"
[attr.aria-label]="translations.CODE_SNIPPET_TEXT"
[attr.tabindex]="display === 'single' && !disabled ? '0' : null"
[attr.role]="display==='single' ? 'textarea' : null"
[ngStyle]="styles"
(scroll)="(display === 'single' ? handleScroll() : null)">
<ng-container *ngIf="skeleton">
<span *ngIf="display === 'single'; else multiSkeleton"></span>
<ng-template #multiSkeleton>
<span></span>
<span></span>
<span></span>
</ng-template>
</ng-container>
<pre
#codeContent
*ngIf="!skeleton"
(scroll)="(display === 'multi' ? handleScroll() : null)"><code #code><ng-container *ngTemplateOutlet="codeTemplate"></ng-container></code></pre>
</div>
<div *ngIf="hasLeft" class="cds--snippet__overflow-indicator--left"></div>
<div *ngIf="hasRight" class="cds--snippet__overflow-indicator--right"></div>
<ng-container *ngIf="!hideCopyButton;">
<ng-container *ngTemplateOutlet="buttonTemplate"></ng-container>
</ng-container>
<button
*ngIf="isExpandable"
class="cds--btn cds--btn--ghost cds--btn--sm cds--snippet-btn--expand"
(click)="toggleSnippetExpansion()"
type="button">
<span class="cds--snippet-btn--text">{{expanded ? translations.SHOW_LESS : translations.SHOW_MORE}}</span>
<svg cdsIcon="chevron--down" size="16" class="cds--icon-chevron--down" [attr.aria-label]="translations.SHOW_MORE_ICON"></svg>
</button>
</ng-template>
<ng-template #buttonTemplate>
<cds-icon-button
*ngIf="!skeleton"
[description]="showFeedback ? feedbackText : copyButtonDescription"
[align]="align"
[autoAlign]="autoAlign"
[dropShadow]="dropShadow"
[caret]="caret"
[highContrast]="highContrast"
[isOpen]="isOpen"
[enterDelayMs]="enterDelayMs"
[leaveDelayMs]="leaveDelayMs"
type="button"
kind="primary"
size="md"
(click)="onCopyButtonClicked($event)"
[buttonNgClass]="{
'cds--snippet--light': theme === 'light',
'cds--snippet--inline': display === 'inline',
'cds--btn--icon-only': display !== 'inline',
'cds--copy-btn': display !== 'inline',
'cds--copy-btn--animating': animating,
'cds--copy-btn--fade-in': showFeedback,
'cds--copy-btn--fade-out': !showFeedback && animating,
'cds--snippet cds--copy': true
}"
[buttonAttributes]="{
'aria-label': translations.COPY_CODE,
'aria-live': 'polite',
'tabindex': '0'
}">
<ng-container *ngIf="display === 'inline'">
<code #code>
<ng-container *ngTemplateOutlet="codeTemplate"></ng-container>
</code>
</ng-container>
<ng-container *ngIf="display !== 'inline'">
<svg cdsIcon="copy" size="16" class="cds--snippet__icon"></svg>
</ng-container>
</cds-icon-button>
</ng-template>
<ng-template #codeTemplate>
<ng-content></ng-content>
</ng-template>
</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>
<a href="#animating" >animating</a>
</li>
<li>
<span class="modifier"></span>
<a href="#code" >code</a>
</li>
<li>
<span class="modifier"></span>
<a href="#codeContainer" >codeContainer</a>
</li>
<li>
<span class="modifier"></span>
<a href="#codeContent" >codeContent</a>
</li>
<li>
<a href="#hasExpandButton" >hasExpandButton</a>
</li>
<li>
<a href="#hasLeft" >hasLeft</a>
</li>
<li>
<a href="#hasRight" >hasRight</a>
</li>
<li>
<a href="#hasRightOverflow" >hasRightOverflow</a>
</li>
<li>
<a href="#isExpandable" >isExpandable</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#rowHeightInPixel" >rowHeightInPixel</a>
</li>
<li>
<a href="#showFeedback" >showFeedback</a>
</li>
<li>
<a href="#styles" >styles</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="#calculateContainerHeight" >calculateContainerHeight</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#canExpand" >canExpand</a>
</li>
<li>
<a href="#handleScroll" >handleScroll</a>
</li>
<li>
<a href="#ngAfterViewInit" >ngAfterViewInit</a>
</li>
<li>
<a href="#ngOnInit" >ngOnInit</a>
</li>
<li>
<a href="#onCopyButtonClicked" >onCopyButtonClicked</a>
</li>
<li>
<a href="#toggleSnippetExpansion" >toggleSnippetExpansion</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="#copyButtonDescription" >copyButtonDescription</a>
</li>
<li>
<a href="#disabled" >disabled</a>
</li>
<li>
<a href="#display" >display</a>
</li>
<li>
<a href="#expanded" >expanded</a>
</li>
<li>
<a href="#feedbackText" >feedbackText</a>
</li>
<li>
<a href="#feedbackTimeout" >feedbackTimeout</a>
</li>
<li>
<a href="#hideCopyButton" >hideCopyButton</a>
</li>
<li>
<a href="#maxCollapsedNumberOfRows" >maxCollapsedNumberOfRows</a>
</li>
<li>
<a href="#maxExpandedNumberOfRows" >maxExpandedNumberOfRows</a>
</li>
<li>
<a href="#minCollapsedNumberOfRows" >minCollapsedNumberOfRows</a>
</li>
<li>
<a href="#minExpandedNumberOfRows" >minExpandedNumberOfRows</a>
</li>
<li>
<a href="#skeleton" >skeleton</a>
</li>
<li>
<a href="#theme" class="deprecated-name">theme</a>
</li>
<li>
<a href="#translations" >translations</a>
</li>
<li>
<a href="#wrapText" >wrapText</a>
</li>
<li>
<a href="#align" >align</a>
</li>
<li>
<a href="#autoAlign" >autoAlign</a>
</li>
<li>
<a href="#caret" >caret</a>
</li>
<li>
<a href="#dropShadow" >dropShadow</a>
</li>
<li>
<a href="#enterDelayMs" >enterDelayMs</a>
</li>
<li>
<a href="#highContrast" >highContrast</a>
</li>
<li>
<a href="#isOpen" >isOpen</a>
</li>
<li>
<a href="#leaveDelayMs" >leaveDelayMs</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>HostBindings</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#class.cds--snippet" >class.cds--snippet</a>
</li>
<li>
<a href="#class.cds--snippet--disabled" >class.cds--snippet--disabled</a>
</li>
<li>
<a href="#class.cds--snippet--light" >class.cds--snippet--light</a>
</li>
<li>
<a href="#class.cds--snippet--multi" >class.cds--snippet--multi</a>
</li>
<li>
<a href="#class.cds--snippet--single" >class.cds--snippet--single</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#snippetClass" >snippetClass</a>
</li>
<li>
<a href="#snippetSingleClass" >snippetSingleClass</a>
</li>
<li>
<a href="#snippetMultiClass" >snippetMultiClass</a>
</li>
<li>
<a href="#snippetDisabledClass" >snippetDisabledClass</a>
</li>
<li>
<a href="#snippetInlineLightClass" >snippetInlineLightClass</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(i18n: <a href="../injectables/I18n.html" target="_self">I18n</a>, eventService: <a href="../injectables/EventService.html" target="_self">EventService</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="227" class="link-to-prism">src/code-snippet/code-snippet.component.ts:227</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Creates an instance of CodeSnippet.</p>
</div>
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>i18n</td>
<td>
<code><a href="../injectables/I18n.html" target="_self" >I18n</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>eventService</td>
<td>
<code><a href="../injectables/EventService.html" target="_self" >EventService</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</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="copyButtonDescription"></a>
<b>copyButtonDescription</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="164" class="link-to-prism">src/code-snippet/code-snippet.component.ts:164</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>copy button description to show on hover</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="disabled"></a>
<b>disabled</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="172" class="link-to-prism">src/code-snippet/code-snippet.component.ts:172</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to disable the code snippet</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="display"></a>
<b>display</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../miscellaneous/enumerations.html#SnippetType" target="_self" >SnippetType</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>SnippetType.single</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="159" class="link-to-prism">src/code-snippet/code-snippet.component.ts:159</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>It can be <code>"single"</code>, <code>"multi"</code> or <code>"inline"</code></p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="expanded"></a>
<b>expanded</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="212" class="link-to-prism">src/code-snippet/code-snippet.component.ts:212</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="feedbackText"></a>
<b>feedbackText</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.translations.COPIED</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="205" class="link-to-prism">src/code-snippet/code-snippet.component.ts:205</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Text displayed in the tooltip when user clicks button to copy code.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="feedbackTimeout"></a>
<b>feedbackTimeout</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>2000</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="210" class="link-to-prism">src/code-snippet/code-snippet.component.ts:210</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Time in miliseconds to keep the feedback tooltip displayed.
Defaults to 2 seconds</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hideCopyButton"></a>
<b>hideCopyButton</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="168" class="link-to-prism">src/code-snippet/code-snippet.component.ts:168</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to hide copy button</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="maxCollapsedNumberOfRows"></a>
<b>maxCollapsedNumberOfRows</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>15</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="177" class="link-to-prism">src/code-snippet/code-snippet.component.ts:177</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Specify the max number of rows to show when collapsed
Default is <code>15</code></p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="maxExpandedNumberOfRows"></a>
<b>maxExpandedNumberOfRows</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>0</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="187" class="link-to-prism">src/code-snippet/code-snippet.component.ts:187</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Specify the max number of rows to show when expanded
Default is <code>0</code>, hence all content will be visible when expanded</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="minCollapsedNumberOfRows"></a>
<b>minCollapsedNumberOfRows</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>3</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="182" class="link-to-prism">src/code-snippet/code-snippet.component.ts:182</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Specify the min number of rows to show when collapsed
Default is <code>3</code></p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="minExpandedNumberOfRows"></a>
<b>minExpandedNumberOfRows</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>16</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="192" class="link-to-prism">src/code-snippet/code-snippet.component.ts:192</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Specify the min number of rows to show when expanded
Default is <code>16</code>, hence height of expanded row will be 16 * rowHeightInPixel (16) = 256px</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="213" class="link-to-prism">src/code-snippet/code-snippet.component.ts:213</a></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="201" class="link-to-prism">src/code-snippet/code-snippet.component.ts:201</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="translations"></a>
<b>translations</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.i18n.get().CODE_SNIPPET</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="160" class="link-to-prism">src/code-snippet/code-snippet.component.ts:160</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="wrapText"></a>
<b>wrapText</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="196" class="link-to-prism">src/code-snippet/code-snippet.component.ts:196</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to wrap the text</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="align"></a>
<b>align</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right" | "left" | "left-bottom" | "left-top" | "right" | "right-bottom" | "right-top"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"bottom"</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:32</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set popover alignment</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="autoAlign"></a>
<b>autoAlign</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-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:40</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p><strong>Experimental</strong>: Use floating-ui to position the tooltip
This is not toggleable - should be assigned once</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="caret"></a>
<b>caret</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-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:16</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>false</code> to hide caret</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dropShadow"></a>
<b>dropShadow</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-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:20</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>false</code> to hide shadow</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="enterDelayMs"></a>
<b>enterDelayMs</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>100</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:44</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set delay before tooltip is shown</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="highContrast"></a>
<b>highContrast</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-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:24</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to enable high contrast</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isOpen"></a>
<b>isOpen</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-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:28</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to have the popover open by default</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="leaveDelayMs"></a>
<b>leaveDelayMs</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>300</code>
</td>
</tr>
<tr>
<td class="col-md-4" colspan="2">
<div class="io-line">Inherited from <code><a href="../components/BaseIconButton.html" target="_self" >BaseIconButton</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <code><a href="../components/BaseIconButton.html#source" target="_self" >BaseIconButton:48</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set delay when tooltip disappears</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3>HostBindings</h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--snippet"></a>
<span class="name">
<span ><b>class.cds--snippet</b></span>
<a href="#class.cds--snippet"><span class="icon ion-ios-link"></span></a>
</span>
</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">
<div class="io-line">Defined in <a href="" data-line="138" class="link-to-prism">src/code-snippet/code-snippet.component.ts:138</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--snippet--disabled"></a>
<span class="name">
<span ><b>class.cds--snippet--disabled</b></span>
<a href="#class.cds--snippet--disabled"><span class="icon ion-ios-link"></span></a>
</span>
</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">
<div class="io-line">Defined in <a href="" data-line="147" class="link-to-prism">src/code-snippet/code-snippet.component.ts:147</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--snippet--light"></a>
<span class="name">
<span ><b>class.cds--snippet--light</b></span>
<a href="#class.cds--snippet--light"><span class="icon ion-ios-link"></span></a>
</span>
</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">
<div class="io-line">Defined in <a href="" data-line="150" class="link-to-prism">src/code-snippet/code-snippet.component.ts:150</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--snippet--multi"></a>
<span class="name">
<span ><b>class.cds--snippet--multi</b></span>
<a href="#class.cds--snippet--multi"><span class="icon ion-ios-link"></span></a>
</span>
</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">
<div class="io-line">Defined in <a href="" data-line="144" class="link-to-prism">src/code-snippet/code-snippet.component.ts:144</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--snippet--single"></a>
<span class="name">
<span ><b>class.cds--snippet--single</b></span>
<a href="#class.cds--snippet--single"><span class="icon ion-ios-link"></span></a>
</span>
</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">
<div class="io-line">Defined in <a href="" data-line="141" class="link-to-prism">src/code-snippet/code-snippet.component.ts:141</a></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="calculateContainerHeight"></a>
<span class="name">
<span ><b>calculateContainerHeight</b></span>
<a href="#calculateContainerHeight"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>calculateContainerHeight()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="299"
class="link-to-prism">src/code-snippet/code-snippet.component.ts:299</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<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="canExpand"></a>
<span class="name">
<span class="modifier">Protected</span>
<span ><b>canExpand</b></span>
<a href="#canExpand"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>canExpand()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="320"
class="link-to-prism">src/code-snippet/code-snippet.component.ts:320</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<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="handleScroll"></a>
<span class="name">
<span ><b>handleScroll</b></span>
<a href="#handleScroll"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>handleScroll()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="237"
class="link-to-prism">src/code-snippet/code-snippet.component.ts:237</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<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="ngAfterViewInit"></a>
<span class="name">
<span ><b>ngAfterViewInit</b></span>
<a href="#ngAfterViewInit"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ngAfterViewInit()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="288"
class="link-to-prism">src/code-snippet/code-snippet.component.ts:288</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<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="ngOnInit"></a>
<span class="name">
<span ><b>ngOnInit</b></span>
<a href="#ngOnInit"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ngOnInit()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="284"
class="link-to-prism">src/code-snippet/code-snippet.component.ts:284</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<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="onCopyButtonClicked"></a>
<span class="name">
<span ><b>onCopyButtonClicked</b></span>
<a href="#onCopyButtonClicked"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>onCopyButtonClicked()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="270"
class="link-to-prism">src/code-snippet/code-snippet.component.ts:270</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<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="toggleSnippetExpansion"></a>
<span class="name">
<span ><b>toggleSnippetExpansion</b></span>
<a href="#toggleSnippetExpansion"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>toggleSnippetExpansion()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="265"
class="link-to-prism">src/code-snippet/code-snippet.component.ts:265</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<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>
</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="animating"></a>
<span class="name">
<span ><b>animating</b></span>
<a href="#animating"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="221" class="link-to-prism">src/code-snippet/code-snippet.component.ts:221</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="code"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>code</b></span>
<a href="#code"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@ViewChild('code')<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="216" class="link-to-prism">src/code-snippet/code-snippet.component.ts:216</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="codeContainer"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>codeContainer</b></span>
<a href="#codeContainer"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@ViewChild('codeContainer')<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="218" class="link-to-prism">src/code-snippet/code-snippet.component.ts:218</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="codeContent"></a>
<span class="name">
<span class="modifier"></span>
<span ><b>codeContent</b></span>
<a href="#codeContent"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@ViewChild('codeContent')<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="217" class="link-to-prism">src/code-snippet/code-snippet.component.ts:217</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hasExpandButton"></a>
<span class="name">
<span ><b>hasExpandButton</b></span>
<a href="#hasExpandButton"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>null</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>null</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="222" class="link-to-prism">src/code-snippet/code-snippet.component.ts:222</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hasLeft"></a>
<span class="name">
<span ><b>hasLeft</b></span>
<a href="#hasLeft"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="227" class="link-to-prism">src/code-snippet/code-snippet.component.ts:227</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hasRight"></a>
<span class="name">
<span ><b>hasRight</b></span>
<a href="#hasRight"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="226" class="link-to-prism">src/code-snippet/code-snippet.component.ts:226</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="hasRightOverflow"></a>
<span class="name">
<span ><b>hasRightOverflow</b></span>
<a href="#hasRightOverflow"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="224" class="link-to-prism">src/code-snippet/code-snippet.component.ts:224</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isExpandable"></a>
<span class="name">
<span ><b>isExpandable</b></span>
<a href="#isExpandable"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="223" class="link-to-prism">src/code-snippet/code-snippet.component.ts:223</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="rowHeightInPixel"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>rowHeightInPixel</b></span>
<a href="#rowHeightInPixel"><span class="icon ion-ios-link"></span></a>
</span>
</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>16</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="154" class="link-to-prism">src/code-snippet/code-snippet.component.ts:154</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="showFeedback"></a>
<span class="name">
<span ><b>showFeedback</b></span>
<a href="#showFeedback"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="220" class="link-to-prism">src/code-snippet/code-snippet.component.ts:220</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="styles"></a>
<span class="name">
<span ><b>styles</b></span>
<a href="#styles"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{}</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="214" class="link-to-prism">src/code-snippet/code-snippet.component.ts:214</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-accessors">
<h3 id="accessors">
Accessors
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="snippetClass"></a>
<span class="name"><b>snippetClass</b><a href="#snippetClass"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>snippetClass()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="138" class="link-to-prism">src/code-snippet/code-snippet.component.ts:138</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="snippetSingleClass"></a>
<span class="name"><b>snippetSingleClass</b><a href="#snippetSingleClass"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>snippetSingleClass()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="141" class="link-to-prism">src/code-snippet/code-snippet.component.ts:141</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="snippetMultiClass"></a>
<span class="name"><b>snippetMultiClass</b><a href="#snippetMultiClass"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>snippetMultiClass()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="144" class="link-to-prism">src/code-snippet/code-snippet.component.ts:144</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="snippetDisabledClass"></a>
<span class="name"><b>snippetDisabledClass</b><a href="#snippetDisabledClass"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>snippetDisabledClass()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="147" class="link-to-prism">src/code-snippet/code-snippet.component.ts:147</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="snippetInlineLightClass"></a>
<span class="name"><b>snippetInlineLightClass</b><a href="#snippetInlineLightClass"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>snippetInlineLightClass()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="150" class="link-to-prism">src/code-snippet/code-snippet.component.ts:150</a></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,
HostBinding,
ViewChild,
AfterViewInit,
OnInit
} from "@angular/core";
import { I18n } from "carbon-components-angular/i18n";
import { EventService } from "carbon-components-angular/utils";
import { BaseIconButton } from "carbon-components-angular/button";
export enum SnippetType {
single = "single",
multi = "multi",
inline = "inline"
}
/**
* Get started with importing the module:
*
* ```typescript
* import { CodeSnippetModule } from 'carbon-components-angular';
* ```
*
* ```html
* <cds-code-snippet>Code</cds-code-snippet>
* ```
*
* [See demo](../../?path=/story/components-code-snippet--basic)
*/
@Component({
selector: "cds-code-snippet, ibm-code-snippet",
template: `
<ng-container *ngIf="display === 'inline'; else notInline">
<ng-container *ngIf="!hideCopyButton; else noBtnInline">
<ng-container *ngTemplateOutlet="buttonTemplate"></ng-container>
</ng-container>
<ng-template #noBtnInline>
<span
class="cds--snippet cds--snippet--inline cds--snippet--no-copy"
[ngClass]="{
'cds--snippet--light': theme === 'light'
}">
<code #code>
<ng-container *ngTemplateOutlet="codeTemplate"></ng-container>
</code>
</span>
</ng-template>
</ng-container>
<ng-template #notInline>
<div
#codeContainer
class="cds--snippet-container"
[attr.aria-label]="translations.CODE_SNIPPET_TEXT"
[attr.tabindex]="display === 'single' && !disabled ? '0' : null"
[attr.role]="display==='single' ? 'textarea' : null"
[ngStyle]="styles"
(scroll)="(display === 'single' ? handleScroll() : null)">
<ng-container *ngIf="skeleton">
<span *ngIf="display === 'single'; else multiSkeleton"></span>
<ng-template #multiSkeleton>
<span></span>
<span></span>
<span></span>
</ng-template>
</ng-container>
<pre
#codeContent
*ngIf="!skeleton"
(scroll)="(display === 'multi' ? handleScroll() : null)"><code #code><ng-container *ngTemplateOutlet="codeTemplate"></ng-container></code></pre>
</div>
<div *ngIf="hasLeft" class="cds--snippet__overflow-indicator--left"></div>
<div *ngIf="hasRight" class="cds--snippet__overflow-indicator--right"></div>
<ng-container *ngIf="!hideCopyButton;">
<ng-container *ngTemplateOutlet="buttonTemplate"></ng-container>
</ng-container>
<button
*ngIf="isExpandable"
class="cds--btn cds--btn--ghost cds--btn--sm cds--snippet-btn--expand"
(click)="toggleSnippetExpansion()"
type="button">
<span class="cds--snippet-btn--text">{{expanded ? translations.SHOW_LESS : translations.SHOW_MORE}}</span>
<svg cdsIcon="chevron--down" size="16" class="cds--icon-chevron--down" [attr.aria-label]="translations.SHOW_MORE_ICON"></svg>
</button>
</ng-template>
<ng-template #buttonTemplate>
<cds-icon-button
*ngIf="!skeleton"
[description]="showFeedback ? feedbackText : copyButtonDescription"
[align]="align"
[autoAlign]="autoAlign"
[dropShadow]="dropShadow"
[caret]="caret"
[highContrast]="highContrast"
[isOpen]="isOpen"
[enterDelayMs]="enterDelayMs"
[leaveDelayMs]="leaveDelayMs"
type="button"
kind="primary"
size="md"
(click)="onCopyButtonClicked($event)"
[buttonNgClass]="{
'cds--snippet--light': theme === 'light',
'cds--snippet--inline': display === 'inline',
'cds--btn--icon-only': display !== 'inline',
'cds--copy-btn': display !== 'inline',
'cds--copy-btn--animating': animating,
'cds--copy-btn--fade-in': showFeedback,
'cds--copy-btn--fade-out': !showFeedback && animating,
'cds--snippet cds--copy': true
}"
[buttonAttributes]="{
'aria-label': translations.COPY_CODE,
'aria-live': 'polite',
'tabindex': '0'
}">
<ng-container *ngIf="display === 'inline'">
<code #code>
<ng-container *ngTemplateOutlet="codeTemplate"></ng-container>
</code>
</ng-container>
<ng-container *ngIf="display !== 'inline'">
<svg cdsIcon="copy" size="16" class="cds--snippet__icon"></svg>
</ng-container>
</cds-icon-button>
</ng-template>
<ng-template #codeTemplate>
<ng-content></ng-content>
</ng-template>
`
})
export class CodeSnippet extends BaseIconButton implements OnInit, AfterViewInit {
@HostBinding("class.cds--snippet") get snippetClass() {
return this.display !== SnippetType.inline;
}
@HostBinding("class.cds--snippet--single") get snippetSingleClass() {
return this.display === SnippetType.single;
}
@HostBinding("class.cds--snippet--multi") get snippetMultiClass() {
return this.display === SnippetType.multi;
}
@HostBinding("class.cds--snippet--disabled") get snippetDisabledClass() {
return this.display !== "inline" && this.disabled;
}
@HostBinding("class.cds--snippet--light") get snippetInlineLightClass() {
return this.theme === "light";
}
readonly rowHeightInPixel: number = 16;
/**
* It can be `"single"`, `"multi"` or `"inline"`
*/
@Input() display: SnippetType = SnippetType.single;
@Input() translations = this.i18n.get().CODE_SNIPPET;
/**
* copy button description to show on hover
*/
@Input() copyButtonDescription: string;
/**
* Set to `true` to hide copy button
*/
@Input() hideCopyButton = false;
/**
* Set to `true` to disable the code snippet
*/
@Input() disabled = false;
/**
* Specify the max number of rows to show when collapsed
* Default is `15`
*/
@Input() maxCollapsedNumberOfRows = 15;
/**
* Specify the min number of rows to show when collapsed
* Default is `3`
*/
@Input() minCollapsedNumberOfRows = 3;
/**
* Specify the max number of rows to show when expanded
* Default is `0`, hence all content will be visible when expanded
*/
@Input() maxExpandedNumberOfRows = 0;
/**
* Specify the min number of rows to show when expanded
* Default is `16`, hence height of expanded row will be 16 * rowHeightInPixel (16) = 256px
*/
@Input() minExpandedNumberOfRows = 16;
/**
* Set to `true` to wrap the text
*/
@HostBinding("class.cds--snippet--wraptext") @Input() wrapText = false;
/**
* @deprecated since v5 - Use `cdsLayer` directive instead
* Set to `"light"` to apply the light style
*/
@Input() theme: "light" | "dark" = "dark";
/**
* Text displayed in the tooltip when user clicks button to copy code.
*/
@Input() feedbackText = this.translations.COPIED;
/**
* Time in miliseconds to keep the feedback tooltip displayed.
* Defaults to 2 seconds
*/
@Input() feedbackTimeout = 2000;
@HostBinding("class.cds--snippet--expand") @Input() expanded = false;
@HostBinding("class.cds--skeleton") @Input() skeleton = false;
styles: any = {};
@ViewChild("code") code;
@ViewChild("codeContent") codeContent;
@ViewChild("codeContainer") codeContainer;
showFeedback = false;
animating = false;
hasExpandButton = null;
isExpandable = false;
hasRightOverflow = false;
hasRight = false;
hasLeft = false;
/**
* Creates an instance of CodeSnippet.
*/
constructor(protected i18n: I18n, protected eventService: EventService) {
super();
this.dropShadow = false;
}
handleScroll() {
if (this.skeleton) {
return;
}
let ref;
switch (this.display) {
case "multi":
ref = this.codeContent.nativeElement;
break;
case "single":
ref = this.codeContainer.nativeElement;
break;
default:
return;
}
if (ref) {
const {
scrollWidth,
clientWidth,
scrollLeft
} = ref;
const horizontalOverflow = scrollWidth > clientWidth;
this.hasLeft = horizontalOverflow && !!scrollLeft;
this.hasRight = horizontalOverflow && scrollLeft + clientWidth !== scrollWidth;
}
}
toggleSnippetExpansion() {
this.expanded = !this.expanded;
this.calculateContainerHeight();
}
onCopyButtonClicked() {
if (!this.disabled) {
window.navigator.clipboard
.writeText(this.code.nativeElement.innerText || this.code.nativeElement.textContent).then(() => {
this.showFeedback = true;
this.animating = true;
setTimeout(() => {
this.showFeedback = false;
this.animating = false;
}, this.feedbackTimeout);
});
}
}
ngOnInit() {
this.calculateContainerHeight();
}
ngAfterViewInit() {
this.canExpand();
this.handleScroll();
if (window) {
this.eventService.on(window as any, "resize", () => {
this.canExpand();
this.handleScroll();
});
}
}
calculateContainerHeight() {
if (this.display === "multi" && !this.skeleton) {
this.styles = {};
if (this.expanded) {
if (this.maxExpandedNumberOfRows > 0) {
this.styles["max-height"] = `${this.maxExpandedNumberOfRows * this.rowHeightInPixel}px`;
}
if (this.minExpandedNumberOfRows > 0) {
this.styles["min-height"] = `${this.minExpandedNumberOfRows * this.rowHeightInPixel}px`;
}
} else {
if (this.maxCollapsedNumberOfRows > 0) {
this.styles["max-height"] = `${this.maxCollapsedNumberOfRows * this.rowHeightInPixel}px`;
}
if (this.minCollapsedNumberOfRows > 0) {
this.styles["min-height"] = `${this.minCollapsedNumberOfRows * this.rowHeightInPixel}px`;
}
}
}
}
protected canExpand() {
if (this.display === "multi" && !this.skeleton) {
const height = this.codeContent.nativeElement.getBoundingClientRect().height;
if (
this.maxCollapsedNumberOfRows > 0 &&
(this.maxExpandedNumberOfRows <= 0 ||
this.maxExpandedNumberOfRows > this.maxCollapsedNumberOfRows) &&
height > this.maxCollapsedNumberOfRows * this.rowHeightInPixel
) {
this.isExpandable = true;
} else {
this.isExpandable = false;
}
if (
this.expanded &&
this.minExpandedNumberOfRows > 0 &&
height <= this.minExpandedNumberOfRows * this.rowHeightInPixel
) {
this.isExpandable = false;
}
}
}
}
</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="display === \'inline\'; else notInline"> <ng-container *ngIf="!hideCopyButton; else noBtnInline"> <ng-container *ngTemplateOutlet="buttonTemplate"></ng-container> </ng-container> <ng-template #noBtnInline> <span class="cds--snippet cds--snippet--inline cds--snippet--no-copy" [ngClass]="{ \'cds--snippet--light\': theme === \'light\' }"> <code #code> <ng-container *ngTemplateOutlet="codeTemplate"></ng-container> </code> </span> </ng-template></ng-container><ng-template #notInline> <div #codeContainer class="cds--snippet-container" [attr.aria-label]="translations.CODE_SNIPPET_TEXT" [attr.tabindex]="display === \'single\' && !disabled ? \'0\' : null" [attr.role]="display===\'single\' ? \'textarea\' : null" [ngStyle]="styles" (scroll)="(display === \'single\' ? handleScroll() : null)"> <ng-container *ngIf="skeleton"> <span *ngIf="display === \'single\'; else multiSkeleton"></span> <ng-template #multiSkeleton> <span></span> <span></span> <span></span> </ng-template> </ng-container> <pre #codeContent *ngIf="!skeleton" (scroll)="(display === \'multi\' ? handleScroll() : null)"><code #code><ng-container *ngTemplateOutlet="codeTemplate"></ng-container></code></pre> </div> <div *ngIf="hasLeft" class="cds--snippet__overflow-indicator--left"></div> <div *ngIf="hasRight" class="cds--snippet__overflow-indicator--right"></div> <ng-container *ngIf="!hideCopyButton;"> <ng-container *ngTemplateOutlet="buttonTemplate"></ng-container> </ng-container> <button *ngIf="isExpandable" class="cds--btn cds--btn--ghost cds--btn--sm cds--snippet-btn--expand" (click)="toggleSnippetExpansion()" type="button"> <span class="cds--snippet-btn--text">{{expanded ? translations.SHOW_LESS : translations.SHOW_MORE}}</span> <svg cdsIcon="chevron--down" size="16" class="cds--icon-chevron--down" [attr.aria-label]="translations.SHOW_MORE_ICON"></svg> </button></ng-template><ng-template #buttonTemplate> <cds-icon-button *ngIf="!skeleton" [description]="showFeedback ? feedbackText : copyButtonDescription" [align]="align" [autoAlign]="autoAlign" [dropShadow]="dropShadow" [caret]="caret" [highContrast]="highContrast" [isOpen]="isOpen" [enterDelayMs]="enterDelayMs" [leaveDelayMs]="leaveDelayMs" type="button" kind="primary" size="md" (click)="onCopyButtonClicked($event)" [buttonNgClass]="{ \'cds--snippet--light\': theme === \'light\', \'cds--snippet--inline\': display === \'inline\', \'cds--btn--icon-only\': display !== \'inline\', \'cds--copy-btn\': display !== \'inline\', \'cds--copy-btn--animating\': animating, \'cds--copy-btn--fade-in\': showFeedback, \'cds--copy-btn--fade-out\': !showFeedback && animating, \'cds--snippet cds--copy\': true }" [buttonAttributes]="{ \'aria-label\': translations.COPY_CODE, \'aria-live\': \'polite\', \'tabindex\': \'0\' }"> <ng-container *ngIf="display === \'inline\'"> <code #code> <ng-container *ngTemplateOutlet="codeTemplate"></ng-container> </code> </ng-container> <ng-container *ngIf="display !== \'inline\'"> <svg cdsIcon="copy" size="16" class="cds--snippet__icon"></svg> </ng-container> </cds-icon-button></ng-template><ng-template #codeTemplate> <ng-content></ng-content></ng-template> </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': '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': 'cds-breadcrumb-item, ibm-breadcrumb-item'},{'name': 'ButtonSet', 'selector': 'cds-button-set, ibm-button-set'},{'name': 'Checkbox', 'selector': 'cds-checkbox, ibm-checkbox'},{'name': 'ClickableTile', 'selector': 'cds-clickable-tile, ibm-clickable-tile'},{'name': 'CodeSnippet', 'selector': 'cds-code-snippet, ibm-code-snippet'},{'name': 'ComboBox', 'selector': 'cds-combo-box, ibm-combo-box'},{'name': 'ComboButtonComponent', 'selector': 'cds-combo-button'},{'name': 'ContainedList', 'selector': 'cds-contained-list, ibm-contained-list'},{'name': 'ContainedListItem', 'selector': 'cds-contained-list-item, ibm-contained-list-item'},{'name': 'ContentSwitcher', 'selector': 'cds-content-switcher, ibm-content-switcher'},{'name': 'ContextMenuComponent', 'selector': 'cds-menu, cds-context-menu, ibm-context-menu'},{'name': 'ContextMenuDividerComponent', 'selector': 'cds-menu-divider, cds-context-menu-divider, ibm-context-menu-divider'},{'name': 'ContextMenuGroupComponent', 'selector': 'cds-menu-group, cds-context-menu-group, ibm-context-menu-group'},{'name': 'ContextMenuItemComponent', 'selector': 'cds-menu-item, cds-context-menu-item, ibm-context-menu-item'},{'name': 'DatePicker', 'selector': 'cds-date-picker, ibm-date-picker'},{'name': 'DatePickerInput', 'selector': 'cds-date-picker-input, ibm-date-picker-input'},{'name': 'Dialog', 'selector': 'cds-dialog, ibm-dialog'},{'name': 'Documentation', 'selector': 'cds-documentation'},{'name': 'Dropdown', 'selector': 'cds-dropdown, ibm-dropdown'},{'name': 'DropdownList', 'selector': 'cds-dropdown-list, ibm-dropdown-list'},{'name': 'ExpandableTile', 'selector': 'cds-expandable-tile, ibm-expandable-tile'},{'name': 'FileComponent', 'selector': 'cds-file, ibm-file'},{'name': 'FileUploader', 'selector': 'cds-file-uploader, ibm-file-uploader'},{'name': 'Hamburger', 'selector': 'cds-hamburger, ibm-hamburger'},{'name': 'Header', 'selector': 'cds-header, ibm-header'},{'name': 'HeaderAction', 'selector': 'cds-header-action, ibm-header-action'},{'name': 'HeaderGlobal', 'selector': 'cds-header-global, ibm-header-global'},{'name': 'HeaderItem', 'selector': 'cds-header-item, ibm-header-item'},{'name': 'HeaderMenu', 'selector': 'cds-header-menu, ibm-header-menu'},{'name': 'HeaderNavigation', 'selector': 'cds-header-navigation, ibm-header-navigation'},{'name': 'IconButton', 'selector': 'cds-icon-button, ibm-icon-button'},{'name': 'InlineLoading', 'selector': 'cds-inline-loading, ibm-inline-loading'},{'name': 'Label', 'selector': 'cds-label, ibm-label'},{'name': 'ListColumn', 'selector': 'cds-list-column, ibm-list-column'},{'name': 'ListHeader', 'selector': 'cds-list-header, ibm-list-header'},{'name': 'ListRow', 'selector': 'cds-list-row, ibm-list-row'},{'name': 'Loading', 'selector': 'cds-loading, ibm-loading'},{'name': 'MenuButtonComponent', 'selector': 'cds-menu-button'},{'name': 'Modal', 'selector': 'cds-modal, ibm-modal'},{'name': 'ModalFooter', 'selector': 'cds-modal-footer, ibm-modal-footer'},{'name': 'ModalHeader', 'selector': 'cds-modal-header, ibm-modal-header'},{'name': 'Notification', 'selector': 'cds-notification, cds-inline-notification, ibm-notification, ibm-inline-notification'},{'name': 'NumberComponent', 'selector': 'cds-number, ibm-number'},{'name': 'OverflowMenu', 'selector': 'cds-overflow-menu, ibm-overflow-menu'},{'name': 'OverflowMenuCustomPane', 'selector': 'cds-overflow-custom-menu-pane, ibm-overflow-custom-menu-pane'},{'name': 'OverflowMenuOption', 'selector': 'cds-overflow-menu-option, ibm-overflow-menu-option'},{'name': 'OverflowMenuPane', 'selector': 'cds-overflow-menu-pane, ibm-overflow-menu-pane'},{'name': 'Overlay', 'selector': 'cds-overlay, ibm-overlay'},{'name': 'Pagination', 'selector': 'cds-pagination, ibm-pagination'},{'name': 'PaginationNav', 'selector': 'cds-pagination-nav, ibm-pagination-navm'},{'name': 'PaginationNavItem', 'selector': 'cds-pagination-nav-item, ibm-pagination-nav-item'},{'name': 'PaginationOverflow', 'selector': 'cds-pagination-overflow, ibm-pagination-overflow'},{'name': 'Panel', 'selector': 'cds-panel, ibm-panel'},{'name': 'PasswordInputLabelComponent', 'selector': 'cds-password-label, ibm-password-label'},{'name': 'Placeholder', 'selector': 'cds-placeholder, ibm-placeholder'},{'name': 'PopoverContent', 'selector': 'cds-popover-content, ibm-popover-content'},{'name': 'ProgressBar', 'selector': 'cds-progress-bar, ibm-progress-bar'},{'name': 'ProgressIndicator', 'selector': 'cds-progress-indicator, ibm-progress-indicator'},{'name': 'Radio', 'selector': 'cds-radio, ibm-radio'},{'name': 'RadioGroup', 'selector': 'cds-radio-group, ibm-radio-group'},{'name': 'Search', 'selector': 'cds-search, ibm-search'},{'name': 'Select', 'selector': 'cds-select, ibm-select'},{'name': 'SelectionTile', 'selector': 'cds-selection-tile, ibm-selection-tile'},{'name': 'SideNav', 'selector': 'cds-sidenav, ibm-sidenav'},{'name': 'SideNavItem', 'selector': 'cds-sidenav-item, ibm-sidenav-item'},{'name': 'SideNavMenu', 'selector': 'cds-sidenav-menu, ibm-sidenav-menu'},{'name': 'SkeletonPlaceholder', 'selector': 'cds-skeleton-placeholder, ibm-skeleton-placeholder'},{'name': 'SkeletonText', 'selector': 'cds-skeleton-text, ibm-skeleton-text'},{'name': 'Slider', 'selector': 'cds-slider, ibm-slider'},{'name': 'StructuredList', 'selector': 'cds-structured-list, ibm-structured-list'},{'name': 'SwitcherList', 'selector': 'cds-switcher-list, ibm-switcher-list'},{'name': 'SwitcherListItem', 'selector': 'cds-switcher-list-item, ibm-switcher-list-item'},{'name': 'Tab', 'selector': 'cds-tab, ibm-tab'},{'name': 'TabHeaderGroup', 'selector': 'cds-tab-header-group, ibm-tab-header-group'},{'name': 'TabHeaders', 'selector': 'cds-tab-headers, ibm-tab-headers'},{'name': 'Table', 'selector': 'cds-table, ibm-table'},{'name': 'TableBody', 'selector': '[cdsTableBody], [ibmTableBody]'},{'name': 'TableCheckbox', 'selector': '[cdsTableCheckbox], [ibmTableCheckbox]'},{'name': 'TableContainer', 'selector': 'cds-table-container, ibm-table-container'},{'name': 'TableData', 'selector': '[cdsTableData], [ibmTableData]'},{'name': 'TableExpandButton', 'selector': '[cdsTableExpandButton], [ibmTableExpandButton]'},{'name': 'TableExpandedRow', 'selector': '[cdsTableExpandedRow], [ibmTableExpandedRow]'},{'name': 'TableHead', 'selector': '[cdsTableHead], [ibmTableHead]'},{'name': 'TableHeadCell', 'selector': '[cdsTableHeadCell], [ibmTableHeadCell]'},{'name': 'TableHeadCheckbox', 'selector': '[cdsTableHeadCheckbox], [ibmTableHeadCheckbox]'},{'name': 'TableHeader', 'selector': 'cds-table-header, ibm-table-header'},{'name': 'TableHeadExpand', 'selector': '[cdsTableHeadExpand], [ibmTableHeadExpand]'},{'name': 'TableRadio', 'selector': '[cdsTableRadio], [ibmTableRadio]'},{'name': 'TableRowComponent', 'selector': '[cdsTableRow], [ibmTableRow]'},{'name': 'TableToolbar', 'selector': 'cds-table-toolbar, ibm-table-toolbar'},{'name': 'TableToolbarActions', 'selector': 'cds-table-toolbar-actions, ibm-table-toolbar-actions'},{'name': 'TableToolbarContent', 'selector': 'cds-table-toolbar-content, ibm-table-toolbar-content'},{'name': 'TableToolbarSearch', 'selector': 'cds-table-toolbar-search, ibm-table-toolbar-search'},{'name': 'Tabs', 'selector': 'cds-tabs, ibm-tabs'},{'name': 'TabSkeleton', 'selector': 'cds-tabs-skeleton, ibm-tabs-skeleton'},{'name': 'Tag', 'selector': 'cds-tag, ibm-tag'},{'name': 'TagFilter', 'selector': 'cds-tag-filter, ibm-tag-filter'},{'name': 'TagOperationalComponent', 'selector': 'cds-tag-operational, ibm-tag-operational'},{'name': 'TagSelectableComponent', 'selector': 'cds-tag-selectable, ibm-tag-selectable'},{'name': 'TextareaLabelComponent', 'selector': 'cds-textarea-label, ibm-textarea-label'},{'name': 'TextInputLabelComponent', 'selector': 'cds-text-label, ibm-text-label'},{'name': 'Tile', 'selector': 'cds-tile, ibm-tile'},{'name': 'TileGroup', 'selector': 'cds-tile-group, ibm-tile-group'},{'name': 'TimePicker', 'selector': 'cds-timepicker, ibm-timepicker'},{'name': 'TimePickerSelect', 'selector': 'cds-timepicker-select, ibm-timepicker-select'},{'name': 'Toast', 'selector': 'cds-toast, ibm-toast'},{'name': 'Toggle', 'selector': 'cds-toggle, ibm-toggle'},{'name': 'Toggletip', 'selector': 'cds-toggletip, ibm-toggletip'},{'name': 'Tooltip', 'selector': 'cds-tooltip, ibm-tooltip'},{'name': 'TooltipDefinition', 'selector': 'cds-tooltip-definition, ibm-tooltip-definition'},{'name': 'TreeNodeComponent', 'selector': 'cds-tree-node'},{'name': 'TreeViewComponent', 'selector': 'cds-tree-view'}];
var DIRECTIVES = [{'name': 'AbstractDropdownView', 'selector': '[cdsAbstractDropdownView], [ibmAbstractDropdownView]'},{'name': 'ActionableButton', 'selector': '[cdsActionableButton], [ibmActionableButton]'},{'name': 'ActionableSubtitle', 'selector': '[cdsActionableSubtitle], [ibmActionableSubtitle]'},{'name': 'ActionableTitle', 'selector': '[cdsActionableTitle], [ibmActionableTitle]'},{'name': 'BaseModal', 'selector': '[cdsBaseModal], [ibmBaseModal]'},{'name': 'Button', 'selector': '[cdsButton], [ibmButton]'},{'name': 'ClickableTileIconDirective', 'selector': '[cdsClickableTileIcon], [ibmClickableTileIcon]'},{'name': 'ColumnDirective', 'selector': '[cdsCol], [ibmCol]'},{'name': 'ContentSwitcherOption', 'selector': '[cdsContentOption], [ibmContentOption]'},{'name': 'DialogDirective', 'selector': '[cdsDialog], [ibmDialog]'},{'name': 'ExpandableTileAboveFoldDirective', 'selector': '[cdsAboveFold], [ibmAboveFold]'},{'name': 'ExpandableTileBelowFoldDirective', 'selector': '[cdsBelowFold], [ibmBelowFold]'},{'name': 'ExpandedRowHover', 'selector': '[cdsExpandedRowHover], [ibmExpandedRowHover]'},{'name': 'GridDirective', 'selector': '[cdsGrid], [ibmGrid]'},{'name': 'IconDirective', 'selector': '[cdsIcon], [ibmIcon]'},{'name': 'LayerDirective', 'selector': '[cdsLayer], [ibmLayer]'},{'name': 'Link', 'selector': '[cdsLink], [ibmLink]'},{'name': 'LinkIconDirective', 'selector': '[ibmLinkIcon], [cdsLinkIcon]'},{'name': 'List', 'selector': '[cdsList], [ibmList]'},{'name': 'ListItemDirective', 'selector': '[cdsListItem], [ibmListItem]'},{'name': 'ModalContent', 'selector': '[cdsModalContent], [ibmModalContent]'},{'name': 'ModalContentText', 'selector': '[cdsModalContentText], [ibmModalContentText]'},{'name': 'ModalHeaderHeading', 'selector': '[cdsModalHeaderHeading], [ibmModalHeaderHeading]'},{'name': 'ModalHeaderLabel', 'selector': '[cdsModalHeaderLabel], [ibmModalHeaderLabel]'},{'name': 'NotificationSubtitle', 'selector': '[cdsNotificationSubtitle], [ibmNotificationSubtitle]'},{'name': 'NotificationTitle', 'selector': '[cdsNotificationTitle], [ibmNotificationTitle]'},{'name': 'OptGroup', 'selector': 'optgroup'},{'name': 'Option', 'selector': 'option'},{'name': 'OverflowMenuDirective', 'selector': '[cdsOverflowMenu], [ibmOverflowMenu]'},{'name': 'PasswordInput', 'selector': '[cdsPassword], [ibmPassword]'},{'name': 'PopoverContainer', 'selector': '[cdsPopover], [ibmPopover]'},{'name': 'RouterLinkExtendedDirective', 'selector': '[routerLink]'},{'name': 'RowDirective', 'selector': '[cdsRow], [ibmRow]'},{'name': 'ScrollableList', 'selector': '[cdsScrollableList], [ibmScrollableList]'},{'name': 'StackDirective', 'selector': '[cdsStack], [ibmStack]'},{'name': 'TabHeader', 'selector': '[cdsTabHeader], [ibmTabHeader]'},{'name': 'TableDirective', 'selector': '[cdsTable], [ibmTable]'},{'name': 'TableHeadCellLabel', 'selector': '[cdsTableHeadCellLabel], [ibmTableHeadCellLabel]'},{'name': 'TableHeaderDescription', 'selector': '[cdsTableHeaderDescription], [ibmTableHeaderDescription]'},{'name': 'TableHeaderTitle', 'selector': '[cdsTableHeaderTitle], [ibmTableHeaderTitle]'},{'name': 'TagIconDirective', 'selector': '[cdsTagIcon], [ibmTagIcon]'},{'name': 'TextArea', 'selector': '[cdsTextArea], [ibmTextArea]'},{'name': 'TextInput', 'selector': '[cdsText], [ibmText]'},{'name': 'ThemeDirective', 'selector': '[cdsTheme], [ibmTheme]'},{'name': 'ToastCaption', 'selector': '[cdsToastCaption], [ibmToastCaption]'},{'name': 'ToastSubtitle', 'selector': '[cdsToastSubtitle], [ibmToastSubtitle]'},{'name': 'ToastTitle', 'selector': '[cdsToastTitle], [ibmToastTitle]'},{'name': 'ToggletipAction', 'selector': '[cdsToggletipAction], [ibmToggletipAction]'},{'name': 'ToggletipButton', 'selector': '[cdsToggletipButton], [ibmToggletipButton]'},{'name': 'ToggletipContent', 'selector': '[cdsToggletipContent], [ibmToggletipContent]'},{'name': 'ToggletipLabel', 'selector': '[cdsToggletipLabel], [ibmToggletipLabel]'}];
var ACTUAL_COMPONENT = {'name': 'CodeSnippet'};
</script>
<script src="../js/tree.js"></script>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'component';
var COMPODOC_CURRENT_PAGE_URL = 'CodeSnippet.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
<footer class="carbon">
<dds-footer-container key="footer" disable-locale-button="true" size="micro" />
</footer>
<script
key="8"
type="module"
src="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/footer.min.js">
</script>
<!-- Storybook override -->
<script>
document.title = "Carbon Components Angular";
</script>
<script
src="//1.www.s81c.com/common/stats/ibm-common.js"
type="text/javascript"
async="async">
</script>
</body>
</html>