Angular Check Box

When you add the CheckBox component to an application, specify its value property to set its state. The CheckBox can have one of the following states:

Checked (value is true).
Unchecked (value is false).
Indeterminate (value is null or undefined).

DevExtreme Accessibility Compliance

DevExtreme component libraries meet a variety of WCAG and Section 508 compliance standards. To assess this demo’s accessibility level, click the Run AXE^® Validation button to launch the AXE^® web accessibility evaluation tool.

All trademarks or registered trademarks are property of their respective owners. AXE^® Terms of Use

The overall accessibility level of your application depends on the CheckBox features used.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

​x
 
<div class="form">
  <div class="dx-fieldset">    <div class="dx-field">      <div class="dx-field-label">Checked</div>      <div class="dx-field-value">        <dx-check-box          [value]="true"          [elementAttr]="{ 'aria-label': 'Checked' }"        ></dx-check-box>      </div>    </div>    <div class="dx-field">      <div class="dx-field-label">Unchecked</div>      <div class="dx-field-value">        <dx-check-box          [value]="false"          [elementAttr]="{ 'aria-label': 'Unchecked' }"        ></dx-check-box>      </div>    </div>    <div class="dx-field">      <div class="dx-field-label">Indeterminate</div>      <div class="dx-field-value">        <dx-check-box          [value]="null"          [elementAttr]="{ 'aria-label': 'Indeterminate' }"        ></dx-check-box>      </div>    </div>    <div class="dx-field">      <div class="dx-field-label">Three state mode</div>      <div class="dx-field-value">        <dx-check-box          [enableThreeStateBehavior]="true"          [value]="null"          [elementAttr]="{ 'aria-label': 'Three state mode' }"        ></dx-check-box>      </div>    </div>    <div class="dx-field">      <div class="dx-field-label">Handle value change</div>      <div class="dx-field-value">        <dx-check-box          [(value)]="checkBoxValue"          [elementAttr]="{ 'aria-label': 'Handle value change' }"        ></dx-check-box>      </div>    </div>    <div class="dx-field">      <div class="dx-field-label">Disabled</div>      <div class="dx-field-value">        <dx-check-box          [disabled]="true"          [value]="checkBoxValue"          [elementAttr]="{ 'aria-label': 'Disabled' }"        ></dx-check-box>      </div>    </div>    <div class="dx-field">      <div class="dx-field-label">Custom size</div>      <div class="dx-field-value">        <dx-check-box          [value]="null"          [iconSize]="30"          [elementAttr]="{ 'aria-label': 'Disabled' }"        ></dx-check-box>      </div>    </div>    <div class="dx-field">      <div class="dx-field-label">With label</div>      <div class="dx-field-value">        <dx-check-box [value]="true" text="Label"></dx-check-box>      </div>    </div>  </div></div>​

xxxxxxxxxx
 
import { NgModule, Component, enableProdMode } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';import { DxCheckBoxModule } from 'devextreme-angular';​if (!/localhost/.test(document.location.host)) {  enableProdMode();}​let modulePrefix = '';// @ts-ignoreif (window && window.config?.packageConfigPaths) {  modulePrefix = '/app';}​@Component({  selector: 'demo-app',  templateUrl: `app/app.component.html`,  styleUrls: [`app/app.component.css`],})export class AppComponent {  checkBoxValue: boolean | null = null;}​@NgModule({  imports: [    BrowserModule,    DxCheckBoxModule,  ],  declarations: [AppComponent],  bootstrap: [AppComponent],})export class AppModule { }​platformBrowserDynamic().bootstrapModule(AppModule);​

xxxxxxxxxx

xxxxxxxxxx
 
// In real applications, you should not transpile code in the browser.
// You can see how to create your own application with Angular and DevExtreme here:// https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/const componentNames = [  'accordion',  'action-sheet',  'autocomplete',  'bar-gauge',  'box',  'bullet',  'button-group',  'button',  'calendar',  'chart',  'chat',  'check-box',  'circular-gauge',  'color-box',  'context-menu',  'data-grid',  'date-box',  'date-range-box',  'defer-rendering',  'diagram',  'draggable',  'drawer',  'drop-down-box',  'drop-down-button',  'file-manager',  'file-uploader',  'filter-builder',  'form',  'funnel',  'gallery',  'gantt',  'html-editor',  'linear-gauge',  'list',  'load-indicator',  'load-panel',  'lookup',  'map',  'menu',  'multi-view',  'nested',  'number-box',  'pagination',  'pie-chart',  'pivot-grid-field-chooser',  'pivot-grid',  'polar-chart',  'popover',  'popup',  'progress-bar',  'radio-group',  'range-selector',  'range-slider',  'recurrence-editor',  'resizable',  'responsive-box',  'sankey',  'scheduler',  'scroll-view',  'select-box',  'slider',  'sortable',  'sparkline',  'speed-dial-action',  'splitter',  'switch',  'tab-panel',  'tabs',  'tag-box',  'text-area',  'text-box',  'tile-view',  'toast',  'toolbar',  'tooltip',  'tree-list',  'tree-map',  'tree-view',  'validation-group',  'validation-summary',  'validator',  'vector-map',];window.exports = window.exports || {};window.config = {  transpiler: 'ts',  typescriptOptions: {    module: 'system',    emitDecoratorMetadata: true,    experimentalDecorators: true,  },  meta: {    'typescript': {      'exports': 'ts',    },    'devextreme/time_zone_utils.js': {      'esModule': true,    },    'devextreme/localization.js': {      'esModule': true,    },    'devextreme/viz/palette.js': {      'esModule': true,    },    '@angular/platform-browser-dynamic': {      'esModule': true,    },    '@angular/platform-browser': {      'esModule': true,    },    '@angular/core': {      'esModule': true,    },    '@angular/common': {      'esModule': true,    },    '@angular/common/http': {      'esModule': true,    },    '@angular/animations': {      'esModule': true,    },    '@angular/forms': {      'esModule': true,    },    'openai': {      'esModule': true,    },  },  paths: {    'npm:': 'https://unpkg.com/',    'bundles:': 'bundles/',    'externals:': 'bundles/externals/',  },  map: {    'ts': 'npm:plugin-typescript@8.0.0/lib/plugin.js',    'typescript': 'npm:typescript@4.2.4/lib/typescript.js',    'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js',    /* @angular */    '@angular/compiler': 'bundles:@angular/compiler.umd.js',    '@angular/platform-browser-dynamic': 'bundles:@angular/platform-browser-dynamic.umd.js',    '@angular/core': 'bundles:@angular/core.umd.js',    '@angular/core/primitives/signals': 'bundles:@angular/core.primitives.signals.umd.js',    '@angular/common': 'bundles:@angular/common.umd.js',    '@angular/common/http': 'bundles:@angular/common-http.umd.js',    '@angular/platform-browser': 'bundles:@angular/platform-browser.umd.js',    '@angular/platform-browser/animations': 'bundles:@angular/platform-browser.umd.js',    '@angular/forms': 'bundles:@angular/forms.umd.js',    /* devextreme */    'devextreme': 'npm:devextreme@24.2.6/cjs',    '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12',    'devextreme/bundles/dx.all': 'npm:devextreme@24.2.6/bundles/dx.all.js',    'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js',    'devexpress-diagram': 'npm:devexpress-diagram@2.2.15',    'devexpress-gantt': 'npm:devexpress-gantt@4.1.60',    /* devextreme-angular umd maps */    'devextreme-angular': 'bundles:devextreme-angular/devextreme-angular.umd.js',    'devextreme-angular/core': 'bundles:devextreme-angular/devextreme-angular-core.umd.js',    'devextreme-angular/http': 'bundles:devextreme-angular/devextreme-angular-http.umd.js',    ...componentNames.reduce((acc, name) => {      acc[`devextreme-angular/ui/${name}`] = `bundles:devextreme-angular/devextreme-angular-ui-${name}.umd.js`;      acc[`devextreme-angular/ui/${name}/nested`] = `bundles:devextreme-angular/devextreme-angular-ui-${name}-nested.umd.js`;      return acc;    }, {}),    'tslib': 'npm:tslib/tslib.js',    'rxjs': 'npm:rxjs@7.5.3/dist/bundles/rxjs.umd.js',    'rxjs/operators': 'npm:rxjs@7.5.3/dist/cjs/operators/index.js',    'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js',    'luxon': 'npm:luxon@3.4.4/build/global/luxon.min.js',    'es6-object-assign': 'npm:es6-object-assign',    'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js',    'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js',    'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js',    'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js',    'inferno-hydrate': 'npm:inferno-hydrate/dist/inferno-hydrate.min.js',    'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js',    'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js',    'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js',    // Prettier    'prettier/standalone': 'npm:prettier@2.8.8/standalone.js',    'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js',  },  packages: {    'app': {      main: './app.component.ts',      defaultExtension: 'ts',    },    'devextreme': {      defaultExtension: 'js',    },    'devextreme/events/utils': {      main: 'index',    },    'devextreme/common/core/events/utils': {      main: 'index',    },    'devextreme/events': {      main: 'index',    },    'es6-object-assign': {      main: './index.js',      defaultExtension: 'js',    },    'rxjs': {      defaultExtension: 'js',    },    'rxjs/operators': {      defaultExtension: 'js',    },  },  packageConfigPaths: [    'npm:@devextreme/*/package.json',    'npm:@devextreme/runtime@3.0.12/inferno/package.json',    'npm:rxjs@7.5.3/package.json',    'npm:rxjs@7.5.3/operators/package.json',    'npm:devexpress-diagram@2.2.15/package.json',    'npm:devexpress-gantt@4.1.60/package.json',  ],};System.config(window.config);// System.import('@angular/compiler').catch(console.error.bind(console));​

xxxxxxxxxx
 
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">  <head>↔</head>​  <body class="dx-viewport">    <div class="demo-container">      <demo-app>Loading...</demo-app>    </div>  </body></html>​

The component supports the three state mode. In this demo, the enableThreeStateBehavior property of the "Three state mode" CheckBox is enabled. You can cycle through the states of this CheckBox in the following order:

Indeterminate → Checked → Unchecked → Indeterminate → ...

To handle value changes, use two-way binding to bind the value property to a component property. The value of the component property depends on the value of the CheckBox. In this demo, the value properties of the "Handle value change" and "Disabled" CheckBox components are bound to the same component property. Click the first CheckBox to see how it affects the second one. You can also use the onValueChanged property to handle value changes. For example, this technique can be useful if you need to use the previous value.

You can use the iconSize property to specify custom dimensions for the CheckBox. To add a label to the CheckBox, set the text property.