carbon-components-angular

<!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>  <div class="content component"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Components</li> <li class="breadcrumb-item" > Checkbox</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/checkbox/checkbox.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 { CheckboxModule } from 'carbon-components-angular';</code></pre></div><p><a href="../../?path=/story/components-checkbox--basic">See demo</a></p> </p> <p class="comment"> <h3>Implements</h3> </p> <p class="comment"> <code>ControlValueAccessor</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">changeDetection</td> <td class="col-md-9"><code>ChangeDetectionStrategy.OnPush</code></td> </tr> <tr> <td class="col-md-3">providers</td> <td class="col-md-9"> <code><a href="../components/Checkbox.html" target="_self" >{ provide: NG_VALUE_ACCESSOR, useExisting: Checkbox, multi: true }</a></code> </td> </tr> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>cds-checkbox, ibm-checkbox</code></td> </tr> <tr> <td class="col-md-3">template</td> <td class="col-md-9"><pre class="line-numbers"><code class="language-html"><div class="cds--form-item cds--checkbox-wrapper" [ngClass]="{ 'cds--checkbox-wrapper--invalid': !effectiveReadOnly && effectiveInvalid, 'cds--checkbox-wrapper--warning': !effectiveReadOnly && !effectiveInvalid && effectiveWarn, 'cds--checkbox-wrapper--readonly': effectiveReadOnly, 'cds--checkbox-wrapper--decorator': !!decorator }"> <input #inputCheckbox class="cds--checkbox" type="checkbox" [id]="id + '_input'" [value]="value" [name]="name" [required]="required" [checked]="checked" [disabled]="disabled" [attr.data-invalid]="(!effectiveReadOnly && effectiveInvalid) ? true : null" [attr.aria-readonly]="effectiveReadOnly ? true : null" [attr.aria-labelledby]="ariaLabelledby" [attr.aria-describedby]="(helperText && !effectiveInvalid && !effectiveWarn) ? helperId : null" (change)="onChange($event)" (click)="onClick($event)"> <label [for]="id + '_input'" [attr.aria-label]="ariaLabel" [attr.title]="title || null" class="cds--checkbox-label" [ngClass]="{ 'cds--skeleton' : skeleton }"> <span [ngClass]="{'cds--visually-hidden' : hideLabel}" class="cds--checkbox-label-text"> <ng-content></ng-content> <ng-container *ngIf="decorator"> <div class="cds--checkbox-wrapper-inner--decorator"> <ng-template [ngTemplateOutlet]="decorator"></ng-template> </div> </ng-container> </span> </label> <div class="cds--checkbox__validation-msg"> <ng-container *ngIf="!effectiveReadOnly && effectiveInvalid"> <svg cdsIcon="warning--filled" size="16" class="cds--checkbox__invalid-icon"> </svg> <div class="cds--form-requirement"> <ng-container *ngIf="!isTemplate(invalidText)">{{invalidText}}</ng-container> <ng-template *ngIf="isTemplate(invalidText)" [ngTemplateOutlet]="$any(invalidText)"></ng-template> </div> </ng-container> <ng-container *ngIf="!effectiveReadOnly && !effectiveInvalid && effectiveWarn"> <svg cdsIcon="warning--alt--filled" size="16" class="cds--checkbox__invalid-icon cds--checkbox__invalid-icon--warning"> </svg> <div class="cds--form-requirement"> <ng-container *ngIf="!isTemplate(warnText)">{{warnText}}</ng-container> <ng-template *ngIf="isTemplate(warnText)" [ngTemplateOutlet]="$any(warnText)"></ng-template> </div> </ng-container> </div> <div *ngIf="helperText && !effectiveInvalid && !effectiveWarn" class="cds--form__helper-text" [id]="helperId"> <ng-container *ngIf="!isTemplate(helperText)">{{helperText}}</ng-container> <ng-template *ngIf="isTemplate(helperText)" [ngTemplateOutlet]="$any(helperText)"></ng-template> </div> </div> </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="#_checked" >_checked</a> </li> <li> <a href="#_indeterminate" >_indeterminate</a> </li> <li> <span class="modifier">Static</span> <a href="#checkboxCount" >checkboxCount</a> </li> <li> <a href="#currentCheckboxState" >currentCheckboxState</a> </li> <li> <span class="modifier">Readonly</span> <a href="#helperId" >helperId</a> </li> <li> <span class="modifier">Private</span> <span class="modifier">Static</span> <a href="#helperIdCounter" >helperIdCounter</a> </li> <li> <span class="modifier"></span> <a href="#inputCheckbox" >inputCheckbox</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="#isTemplate" >isTemplate</a> </li> <li> <a href="#markForCheckFromGroup" >markForCheckFromGroup</a> </li> <li> <a href="#ngAfterViewInit" >ngAfterViewInit</a> </li> <li> <a href="#onChange" >onChange</a> </li> <li> <a href="#onClick" >onClick</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> <span class="modifier">Private</span> <a href="#setChecked" >setChecked</a> </li> <li> <a href="#setDisabledState" >setDisabledState</a> </li> <li> <span class="modifier">Public</span> <a href="#toggle" >toggle</a> </li> <li> <a href="#transitionCheckboxState" >transitionCheckboxState</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="#ariaLabelledby" >ariaLabelledby</a> </li> <li> <a href="#checked" >checked</a> </li> <li> <a href="#decorator" >decorator</a> </li> <li> <a href="#disabled" >disabled</a> </li> <li> <a href="#helperText" >helperText</a> </li> <li> <a href="#hideLabel" >hideLabel</a> </li> <li> <a href="#id" >id</a> </li> <li> <a href="#indeterminate" >indeterminate</a> </li> <li> <a href="#invalid" >invalid</a> </li> <li> <a href="#invalidText" >invalidText</a> </li> <li> <a href="#name" >name</a> </li> <li> <a href="#readOnly" >readOnly</a> </li> <li> <a href="#required" >required</a> </li> <li> <a href="#skeleton" >skeleton</a> </li> <li> <a href="#title" >title</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="#checkedChange" >checkedChange</a> </li> <li> <a href="#click" >click</a> </li> <li> <a href="#indeterminateChange" >indeterminateChange</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="#indeterminate" >indeterminate</a> </li> <li> <a href="#checked" >checked</a> </li> <li> <a href="#effectiveReadOnly" >effectiveReadOnly</a> </li> <li> <a href="#effectiveInvalid" >effectiveInvalid</a> </li> <li> <a href="#effectiveWarn" >effectiveWarn</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(changeDetectorRef: ChangeDetectorRef, hostGroup: <a href="../interfaces/CheckboxGroupHost.html" target="_self">CheckboxGroupHost | null</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="292" class="link-to-prism">src/checkbox/checkbox.component.ts:292</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Creates an instance of <code>Checkbox</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>changeDetectorRef</td> <td> <code>ChangeDetectorRef</code> </td> <td> No </td> </tr> <tr> <td>hostGroup</td> <td> <code><a href="../interfaces/CheckboxGroupHost.html" target="_self" >CheckboxGroupHost | null</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="160" class="link-to-prism">src/checkbox/checkbox.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="ariaLabelledby"></a> <b>ariaLabelledby</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="161" class="link-to-prism">src/checkbox/checkbox.component.ts:161</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="checked"></a> <b>checked</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="244" class="link-to-prism">src/checkbox/checkbox.component.ts:244</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the <code>checked</code> state. <code>true</code> for checked, <code>false</code> for unchecked</p> <p>Allows double binding with the <code>checkedChange</code> Output.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="decorator"></a> <b>decorator</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>TemplateRef<any></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/checkbox/checkbox.component.ts:205</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Optional <code>TemplateRef</code> (e.g. AI label) rendered next to the label text.</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="135" class="link-to-prism">src/checkbox/checkbox.component.ts:135</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> for a disabled checkbox.</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<any></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/checkbox/checkbox.component.ts:172</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Optional helper text displayed below the checkbox label. Not shown when <code>invalid</code> or <code>warn</code> is <code>true</code>.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="hideLabel"></a> <b>hideLabel</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="143" class="link-to-prism">src/checkbox/checkbox.component.ts:143</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> to hide the checkbox labels.</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>`checkbox-${Checkbox.checkboxCount}`</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="151" class="link-to-prism">src/checkbox/checkbox.component.ts:151</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>The unique id for the checkbox component.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="indeterminate"></a> <b>indeterminate</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="212" class="link-to-prism">src/checkbox/checkbox.component.ts:212</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set the checkbox's indeterminate state to match the parameter and transition the view to reflect the change.</p> <p>Allows double binding with the <code>indeterminateChange</code> Output.</p> </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-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="178" class="link-to-prism">src/checkbox/checkbox.component.ts:178</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> to show the checkbox in an invalid/error state. When omitted inside a <code>cds-checkbox-group</code>, the group's <code>invalid</code> value applies.</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<any></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="183" class="link-to-prism">src/checkbox/checkbox.component.ts:183</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>The error message displayed when <code>invalid</code> is <code>true</code>.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="name"></a> <b>name</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="147" class="link-to-prism">src/checkbox/checkbox.component.ts:147</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the name 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="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-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="200" class="link-to-prism">src/checkbox/checkbox.component.ts:200</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>When <code>true</code>, the checkbox cannot be toggled (matches <code>readonly</code> attribute semantics for form controls). When omitted inside a <code>cds-checkbox-group</code>, the group's <code>readOnly</code> value applies.</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="155" class="link-to-prism">src/checkbox/checkbox.component.ts:155</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="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="139" class="link-to-prism">src/checkbox/checkbox.component.ts:139</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> for a loading checkbox.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="title"></a> <b>title</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>""</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="166" class="link-to-prism">src/checkbox/checkbox.component.ts:166</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Optional title for the <code><label></code> element.</p> </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="../miscellaneous/typealiases.html#CheckboxValue" target="_self" >CheckboxValue</a></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/checkbox/checkbox.component.ts:159</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Sets the value 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="warn"></a> <b>warn</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="189" class="link-to-prism">src/checkbox/checkbox.component.ts:189</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> to show the checkbox in a warning state. When omitted inside a <code>cds-checkbox-group</code>, the group's <code>warn</code> value applies.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="warnText"></a> <b>warnText</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | TemplateRef<any></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="194" class="link-to-prism">src/checkbox/checkbox.component.ts:194</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>The warning message displayed when <code>warn</code> is <code>true</code> and <code>invalid</code> is <code>false</code>.</p> </div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-outputs"> <h3 id="outputs">Outputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="checkedChange"></a> <b>checkedChange</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="265" class="link-to-prism">src/checkbox/checkbox.component.ts:265</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits an event when the value of the checkbox changes.</p> <p>Allows double biding with the <code>checked</code> Input.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="click"></a> <b>click</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="258" class="link-to-prism">src/checkbox/checkbox.component.ts:258</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits click event.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="indeterminateChange"></a> <b>indeterminateChange</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="271" class="link-to-prism">src/checkbox/checkbox.component.ts:271</a></div> </td> </tr> <tr> <td class="col-md-4"> <div cl