UNPKG

carbon-components-angular

Version:
1,226 lines (1,141 loc) 150 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" > NumberComponent</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/number-input/number.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 { NumberModule } from &#39;carbon-components-angular&#39;;</code></pre></div><p><a href="../../?path=/story/components-number--basic">See demo</a></p> </p> <p class="comment"> <h3>Implements</h3> </p> <p class="comment"> <code>ControlValueAccessor</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">providers</td> <td class="col-md-9"> <code><a href="../components/NumberComponent.html" target="_self" >{ provide: NG_VALUE_ACCESSOR, useExisting: NumberComponent, multi: true }</a></code> </td> </tr> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>cds-number, ibm-number</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;label *ngIf&#x3D;&quot;skeleton &amp;&amp; label&quot; class&#x3D;&quot;cds--label cds--skeleton&quot;&gt;&lt;/label&gt; &lt;div data-numberinput [attr.data-invalid]&#x3D;&quot;(invalid ? true : null)&quot; class&#x3D;&quot;cds--number&quot; [ngClass]&#x3D;&quot;{ &#x27;cds--number--light&#x27;: theme &#x3D;&#x3D;&#x3D; &#x27;light&#x27;, &#x27;cds--number--nolabel&#x27;: !label, &#x27;cds--number--helpertext&#x27;: helperText, &#x27;cds--skeleton&#x27; : skeleton, &#x27;cds--number--sm&#x27;: size &#x3D;&#x3D;&#x3D; &#x27;sm&#x27;, &#x27;cds--number--md&#x27;: size &#x3D;&#x3D;&#x3D; &#x27;md&#x27;, &#x27;cds--number--lg&#x27;: size &#x3D;&#x3D;&#x3D; &#x27;lg&#x27; }&quot;&gt; &lt;label *ngIf&#x3D;&quot;!skeleton &amp;&amp; label&quot; [for]&#x3D;&quot;id&quot; class&#x3D;&quot;cds--label&quot; [ngClass]&#x3D;&quot;{&#x27;cds--label--disabled&#x27;: disabled}&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!isTemplate(label)&quot;&gt;{{label}}&lt;/ng-container&gt; &lt;ng-template *ngIf&#x3D;&quot;isTemplate(label)&quot; [ngTemplateOutlet]&#x3D;&quot;label&quot;&gt;&lt;/ng-template&gt; &lt;/label&gt; &lt;div class&#x3D;&quot;cds--number__input-wrapper&quot; [ngClass]&#x3D;&quot;{ &#x27;cds--number__input-wrapper--warning&#x27;: warn }&quot;&gt; &lt;input type&#x3D;&quot;number&quot; [id]&#x3D;&quot;id&quot; [value]&#x3D;&quot;value&quot; [attr.min]&#x3D;&quot;min&quot; [attr.max]&#x3D;&quot;max&quot; [attr.step]&#x3D;&quot;step&quot; [disabled]&#x3D;&quot;disabled&quot; [readonly]&#x3D;&quot;readonly&quot; [required]&#x3D;&quot;required&quot; [attr.aria-label]&#x3D;&quot;ariaLabel&quot; [attr.data-invalid]&#x3D;&quot;invalid ? invalid : null&quot; [placeholder]&#x3D;&quot;placeholder&quot; (focus)&#x3D;&quot;fluid ? handleFocus($event): null&quot; (blur)&#x3D;&quot;fluid ? handleFocus($event): null&quot; (change)&#x3D;&quot;onNumberInputChange($event)&quot;/&gt; &lt;svg *ngIf&#x3D;&quot;!skeleton &amp;&amp; invalid&quot; cdsIcon&#x3D;&quot;warning--filled&quot; size&#x3D;&quot;16&quot; class&#x3D;&quot;cds--number__invalid&quot;&gt; &lt;/svg&gt; &lt;svg *ngIf&#x3D;&quot;!skeleton &amp;&amp; !invalid &amp;&amp; warn&quot; cdsIcon&#x3D;&quot;warning--alt--filled&quot; size&#x3D;&quot;16&quot; class&#x3D;&quot;cds--number__invalid cds--number__invalid--warning&quot;&gt; &lt;/svg&gt; &lt;div *ngIf&#x3D;&quot;!skeleton&quot; class&#x3D;&quot;cds--number__controls&quot;&gt; &lt;button class&#x3D;&quot;cds--number__control-btn down-icon&quot; type&#x3D;&quot;button&quot; [attr.disabled]&#x3D;&quot;disabled ? true : null&quot; aria-live&#x3D;&quot;polite&quot; aria-atomic&#x3D;&quot;true&quot; [attr.aria-label]&#x3D;&quot;getDecrementLabel() | async&quot; (click)&#x3D;&quot;onDecrement()&quot;&gt; &lt;svg cdsIcon&#x3D;&quot;subtract&quot; size&#x3D;&quot;16&quot;&gt;&lt;/svg&gt; &lt;/button&gt; &lt;div class&#x3D;&quot;cds--number__rule-divider&quot;&gt;&lt;/div&gt; &lt;button class&#x3D;&quot;cds--number__control-btn up-icon&quot; type&#x3D;&quot;button&quot; [attr.disabled]&#x3D;&quot;disabled ? true : null&quot; aria-live&#x3D;&quot;polite&quot; aria-atomic&#x3D;&quot;true&quot; [attr.aria-label]&#x3D;&quot;getIncrementLabel() | async&quot; (click)&#x3D;&quot;onIncrement()&quot;&gt; &lt;svg cdsIcon&#x3D;&quot;add&quot; size&#x3D;&quot;16&quot;&gt;&lt;/svg&gt; &lt;/button&gt; &lt;div class&#x3D;&quot;cds--number__rule-divider&quot;&gt;&lt;/div&gt; &lt;/div&gt; &lt;/div&gt; &lt;hr *ngIf&#x3D;&quot;fluid&quot; class&#x3D;&quot;cds--number-input__divider&quot; /&gt; &lt;div *ngIf&#x3D;&quot;helperText &amp;&amp; !invalid &amp;&amp; !warn &amp;&amp; !fluid&quot; class&#x3D;&quot;cds--form__helper-text&quot; [ngClass]&#x3D;&quot;{ &#x27;cds--form__helper-text--disabled&#x27;: disabled }&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!isTemplate(helperText)&quot;&gt;{{helperText}}&lt;/ng-container&gt; &lt;ng-template *ngIf&#x3D;&quot;isTemplate(helperText)&quot; [ngTemplateOutlet]&#x3D;&quot;helperText&quot;&gt;&lt;/ng-template&gt; &lt;/div&gt; &lt;div *ngIf&#x3D;&quot;invalid&quot; class&#x3D;&quot;cds--form-requirement&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!isTemplate(invalidText)&quot;&gt;{{invalidText}}&lt;/ng-container&gt; &lt;ng-template *ngIf&#x3D;&quot;isTemplate(invalidText)&quot; [ngTemplateOutlet]&#x3D;&quot;invalidText&quot;&gt;&lt;/ng-template&gt; &lt;/div&gt; &lt;div *ngIf&#x3D;&quot;!invalid &amp;&amp; warn&quot; class&#x3D;&quot;cds--form-requirement&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!isTemplate(warnText)&quot;&gt;{{warnText}}&lt;/ng-container&gt; &lt;ng-template *ngIf&#x3D;&quot;isTemplate(warnText)&quot; [ngTemplateOutlet]&#x3D;&quot;warnText&quot;&gt;&lt;/ng-template&gt; &lt;/div&gt; &lt;/div&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> <span class="modifier">Protected</span> <a href="#_decrementLabel" >_decrementLabel</a> </li> <li> <span class="modifier">Protected</span> <a href="#_incrementLabel" >_incrementLabel</a> </li> <li> <span class="modifier">Protected</span> <a href="#_isFocused" >_isFocused</a> </li> <li> <span class="modifier">Protected</span> <a href="#_value" >_value</a> </li> <li> <span class="modifier"></span> <a href="#containerClass" >containerClass</a> </li> <li> <span class="modifier">Static</span> <a href="#numberCount" >numberCount</a> </li> <li> <a href="#onTouched" >onTouched</a> </li> <li> <a href="#propagateChange" >propagateChange</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="#emitChangeEvent" >emitChangeEvent</a> </li> <li> <span class="modifier"></span> <a href="#focusOut" >focusOut</a> </li> <li> <a href="#getDecrementLabel" >getDecrementLabel</a> </li> <li> <a href="#getIncrementLabel" >getIncrementLabel</a> </li> <li> <a href="#handleFocus" >handleFocus</a> </li> <li> <span class="modifier">Public</span> <a href="#isTemplate" >isTemplate</a> </li> <li> <a href="#onDecrement" >onDecrement</a> </li> <li> <a href="#onIncrement" >onIncrement</a> </li> <li> <a href="#onNumberInputChange" >onNumberInputChange</a> </li> <li> <span class="modifier">Public</span> <a href="#registerOnChange" >registerOnChange</a> </li> <li> <span class="modifier">Public</span> <a href="#registerOnTouched" >registerOnTouched</a> </li> <li> <a href="#setDisabledState" >setDisabledState</a> </li> <li> <span class="modifier">Public</span> <a href="#writeValue" >writeValue</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Inputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#ariaLabel" >ariaLabel</a> </li> <li> <a href="#decrementLabel" >decrementLabel</a> </li> <li> <a href="#disabled" >disabled</a> </li> <li> <a href="#fluid" >fluid</a> </li> <li> <a href="#helperText" >helperText</a> </li> <li> <a href="#id" >id</a> </li> <li> <a href="#incrementLabel" >incrementLabel</a> </li> <li> <a href="#invalid" >invalid</a> </li> <li> <a href="#invalidText" >invalidText</a> </li> <li> <a href="#label" >label</a> </li> <li> <a href="#max" >max</a> </li> <li> <a href="#min" >min</a> </li> <li> <a href="#placeholder" >placeholder</a> </li> <li> <a href="#precision" >precision</a> </li> <li> <a href="#readonly" >readonly</a> </li> <li> <a href="#required" >required</a> </li> <li> <a href="#size" >size</a> </li> <li> <a href="#skeleton" >skeleton</a> </li> <li> <a href="#step" >step</a> </li> <li> <a href="#theme" class="deprecated-name">theme</a> </li> <li> <a href="#value" >value</a> </li> <li> <a href="#warn" >warn</a> </li> <li> <a href="#warnText" >warnText</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Outputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#change" >change</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--form-item" >class.cds--form-item</a> </li> <li> <a href="#class.cds--number-input--fluid--disabled" >class.cds--number-input--fluid--disabled</a> </li> <li> <a href="#class.cds--number-input--fluid--focus" >class.cds--number-input--fluid--focus</a> </li> <li> <a href="#class.cds--number-input--fluid--invalid" >class.cds--number-input--fluid--invalid</a> </li> <li> <a href="#class.cds--text-input--fluid__skeleton" >class.cds--text-input--fluid__skeleton</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>HostListeners</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#focusout" >focusout</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="#value" >value</a> </li> <li> <a href="#decrementLabel" >decrementLabel</a> </li> <li> <a href="#incrementLabel" >incrementLabel</a> </li> <li> <a href="#fluidInvalid" >fluidInvalid</a> </li> <li> <a href="#fluidDisabled" >fluidDisabled</a> </li> <li> <a href="#fluidFocus" >fluidFocus</a> </li> <li> <a href="#fluidSkeleton" >fluidSkeleton</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>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="297" class="link-to-prism">src/number-input/number.component.ts:297</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Creates an instance of <code>Number</code>.</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> </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="ariaLabel"></a> <b>ariaLabel</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="247" class="link-to-prism">src/number-input/number.component.ts:247</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the arialabel for input</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="decrementLabel"></a> <b>decrementLabel</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | Observable</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="254" class="link-to-prism">src/number-input/number.component.ts:254</a></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="169" class="link-to-prism">src/number-input/number.component.ts:169</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> for a disabled number input.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="fluid"></a> <b>fluid</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="274" class="link-to-prism">src/number-input/number.component.ts:274</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Experimental: enable fluid state</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="helperText"></a> <b>helperText</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | TemplateRef&lt;any&gt;</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="223" class="link-to-prism">src/number-input/number.component.ts:223</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the optional helper text.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="id"></a> <b>id</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-4"> <i>Default value : </i><code>&#x60;number-${NumberComponent.numberCount}&#x60;</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="181" class="link-to-prism">src/number-input/number.component.ts:181</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>The unique id for the number component.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="incrementLabel"></a> <b>incrementLabel</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | Observable</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="263" class="link-to-prism">src/number-input/number.component.ts:263</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="invalid"></a> <b>invalid</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="177" class="link-to-prism">src/number-input/number.component.ts:177</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> for an invalid number component.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="invalidText"></a> <b>invalidText</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | TemplateRef&lt;any&gt;</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="227" class="link-to-prism">src/number-input/number.component.ts:227</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the invalid text.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="label"></a> <b>label</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | TemplateRef&lt;any&gt;</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="219" class="link-to-prism">src/number-input/number.component.ts:219</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the text inside the <code>label</code> tag.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="max"></a> <b>max</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>null</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="215" class="link-to-prism">src/number-input/number.component.ts:215</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the max attribute on the <code>input</code> element.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="min"></a> <b>min</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>null</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="211" class="link-to-prism">src/number-input/number.component.ts:211</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the min attribute on the <code>input</code> element.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="placeholder"></a> <b>placeholder</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-4"> <i>Default value : </i><code>&quot;&quot;</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="185" class="link-to-prism">src/number-input/number.component.ts:185</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the placeholder attribute on the <code>input</code> element.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="precision"></a> <b>precision</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-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="235" class="link-to-prism">src/number-input/number.component.ts:235</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>If <code>step</code> is a decimal, we may want precision to be set to go around floating point precision.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="readonly"></a> <b>readonly</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="160" class="link-to-prism">src/number-input/number.component.ts:160</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> for readonly state.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="required"></a> <b>required</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-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="193" class="link-to-prism">src/number-input/number.component.ts:193</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Reflects the required attribute of the <code>input</code> element.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="size"></a> <b>size</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>&quot;sm&quot; | &quot;md&quot; | &quot;lg&quot;</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>&quot;md&quot;</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="189" class="link-to-prism">src/number-input/number.component.ts:189</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Number input field render size</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="173" class="link-to-prism">src/number-input/number.component.ts:173</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> for a loading number component.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="step"></a> <b>step</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>1</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="231" class="link-to-prism">src/number-input/number.component.ts:231</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the amount the number controls increment and decrement by.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="theme"></a> <b>theme</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>&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="165" class="link-to-prism">src/number-input/number.component.ts:165</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="value"></a> <b>value</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>