UNPKG

carbon-components-angular

Version:
1,183 lines (1,094 loc) 124 kB
<!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 &#39;carbon-components-angular&#39;;</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html">&lt;cds-code-snippet&gt;Code&lt;/cds-code-snippet&gt;</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">&lt;ng-container *ngIf&#x3D;&quot;display &#x3D;&#x3D;&#x3D; &#x27;inline&#x27;; else notInline&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!hideCopyButton; else noBtnInline&quot;&gt; &lt;ng-container *ngTemplateOutlet&#x3D;&quot;buttonTemplate&quot;&gt;&lt;/ng-container&gt; &lt;/ng-container&gt; &lt;ng-template #noBtnInline&gt; &lt;span class&#x3D;&quot;cds--snippet cds--snippet--inline cds--snippet--no-copy&quot; [ngClass]&#x3D;&quot;{ &#x27;cds--snippet--light&#x27;: theme &#x3D;&#x3D;&#x3D; &#x27;light&#x27; }&quot;&gt; &lt;code #code&gt; &lt;ng-container *ngTemplateOutlet&#x3D;&quot;codeTemplate&quot;&gt;&lt;/ng-container&gt; &lt;/code&gt; &lt;/span&gt; &lt;/ng-template&gt; &lt;/ng-container&gt; &lt;ng-template #notInline&gt; &lt;div #codeContainer class&#x3D;&quot;cds--snippet-container&quot; [attr.aria-label]&#x3D;&quot;translations.CODE_SNIPPET_TEXT&quot; [attr.tabindex]&#x3D;&quot;display &#x3D;&#x3D;&#x3D; &#x27;single&#x27; &amp;&amp; !disabled ? &#x27;0&#x27; : null&quot; [attr.role]&#x3D;&quot;display&#x3D;&#x3D;&#x3D;&#x27;single&#x27; ? &#x27;textarea&#x27; : null&quot; [ngStyle]&#x3D;&quot;styles&quot; (scroll)&#x3D;&quot;(display &#x3D;&#x3D;&#x3D; &#x27;single&#x27; ? handleScroll() : null)&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;skeleton&quot;&gt; &lt;span *ngIf&#x3D;&quot;display &#x3D;&#x3D;&#x3D; &#x27;single&#x27;; else multiSkeleton&quot;&gt;&lt;/span&gt; &lt;ng-template #multiSkeleton&gt; &lt;span&gt;&lt;/span&gt; &lt;span&gt;&lt;/span&gt; &lt;span&gt;&lt;/span&gt; &lt;/ng-template&gt; &lt;/ng-container&gt; &lt;pre #codeContent *ngIf&#x3D;&quot;!skeleton&quot; (scroll)&#x3D;&quot;(display &#x3D;&#x3D;&#x3D; &#x27;multi&#x27; ? handleScroll() : null)&quot;&gt;&lt;code #code&gt;&lt;ng-container *ngTemplateOutlet&#x3D;&quot;codeTemplate&quot;&gt;&lt;/ng-container&gt;&lt;/code&gt;&lt;/pre&gt; &lt;/div&gt; &lt;div *ngIf&#x3D;&quot;hasLeft&quot; class&#x3D;&quot;cds--snippet__overflow-indicator--left&quot;&gt;&lt;/div&gt; &lt;div *ngIf&#x3D;&quot;hasRight&quot; class&#x3D;&quot;cds--snippet__overflow-indicator--right&quot;&gt;&lt;/div&gt; &lt;ng-container *ngIf&#x3D;&quot;!hideCopyButton;&quot;&gt; &lt;ng-container *ngTemplateOutlet&#x3D;&quot;buttonTemplate&quot;&gt;&lt;/ng-container&gt; &lt;/ng-container&gt; &lt;button *ngIf&#x3D;&quot;isExpandable&quot; class&#x3D;&quot;cds--btn cds--btn--ghost cds--btn--sm cds--snippet-btn--expand&quot; (click)&#x3D;&quot;toggleSnippetExpansion()&quot; type&#x3D;&quot;button&quot;&gt; &lt;span class&#x3D;&quot;cds--snippet-btn--text&quot;&gt;{{expanded ? translations.SHOW_LESS : translations.SHOW_MORE}}&lt;/span&gt; &lt;svg cdsIcon&#x3D;&quot;chevron--down&quot; size&#x3D;&quot;16&quot; class&#x3D;&quot;cds--icon-chevron--down&quot; [attr.aria-label]&#x3D;&quot;translations.SHOW_MORE_ICON&quot;&gt;&lt;/svg&gt; &lt;/button&gt; &lt;/ng-template&gt; &lt;ng-template #buttonTemplate&gt; &lt;cds-icon-button *ngIf&#x3D;&quot;!skeleton&quot; [description]&#x3D;&quot;showFeedback ? feedbackText : copyButtonDescription&quot; [align]&#x3D;&quot;align&quot; [autoAlign]&#x3D;&quot;autoAlign&quot; [dropShadow]&#x3D;&quot;dropShadow&quot; [caret]&#x3D;&quot;caret&quot; [highContrast]&#x3D;&quot;highContrast&quot; [isOpen]&#x3D;&quot;isOpen&quot; [enterDelayMs]&#x3D;&quot;enterDelayMs&quot; [leaveDelayMs]&#x3D;&quot;leaveDelayMs&quot; type&#x3D;&quot;button&quot; kind&#x3D;&quot;primary&quot; size&#x3D;&quot;md&quot; (click)&#x3D;&quot;onCopyButtonClicked($event)&quot; [buttonNgClass]&#x3D;&quot;{ &#x27;cds--snippet--light&#x27;: theme &#x3D;&#x3D;&#x3D; &#x27;light&#x27;, &#x27;cds--snippet--inline&#x27;: display &#x3D;&#x3D;&#x3D; &#x27;inline&#x27;, &#x27;cds--btn--icon-only&#x27;: display !&#x3D;&#x3D; &#x27;inline&#x27;, &#x27;cds--copy-btn&#x27;: display !&#x3D;&#x3D; &#x27;inline&#x27;, &#x27;cds--copy-btn--animating&#x27;: animating, &#x27;cds--copy-btn--fade-in&#x27;: showFeedback, &#x27;cds--copy-btn--fade-out&#x27;: !showFeedback &amp;&amp; animating, &#x27;cds--snippet cds--copy&#x27;: true }&quot; [buttonAttributes]&#x3D;&quot;{ &#x27;aria-label&#x27;: translations.COPY_CODE, &#x27;aria-live&#x27;: &#x27;polite&#x27;, &#x27;tabindex&#x27;: &#x27;0&#x27; }&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;display &#x3D;&#x3D;&#x3D; &#x27;inline&#x27;&quot;&gt; &lt;code #code&gt; &lt;ng-container *ngTemplateOutlet&#x3D;&quot;codeTemplate&quot;&gt;&lt;/ng-container&gt; &lt;/code&gt; &lt;/ng-container&gt; &lt;ng-container *ngIf&#x3D;&quot;display !&#x3D;&#x3D; &#x27;inline&#x27;&quot;&gt; &lt;svg cdsIcon&#x3D;&quot;copy&quot; size&#x3D;&quot;16&quot; class&#x3D;&quot;cds--snippet__icon&quot;&gt;&lt;/svg&gt; &lt;/ng-container&gt; &lt;/cds-icon-button&gt; &lt;/ng-template&gt; &lt;ng-template #codeTemplate&gt; &lt;ng-content&gt;&lt;/ng-content&gt; &lt;/ng-template&gt; </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>&quot;single&quot;</code>, <code>&quot;multi&quot;</code> or <code>&quot;inline&quot;</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>&quot;light&quot; | &quot;dark&quot;</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>&quot;dark&quot;</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>&quot;top&quot; | &quot;top-left&quot; | &quot;top-right&quot; | &quot;bottom&quot; | &quot;bottom-left&quot; | &quot;bottom-right&quot; | &quot;left&quot; | &quot;left-bottom&quot; | &quot;left-top&quot; | &quot;right&quot; | &quot;right-bottom&quot; | &quot;right-top&quot;</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>&quot;bottom&quot;</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>