devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
738 lines (640 loc) • 25.1 kB
JavaScript
import * as i0 from '@angular/core';
import { forwardRef, PLATFORM_ID, Component, Inject, Input, Output, HostListener, NgModule } from '@angular/core';
import DxCheckBox from 'devextreme/ui/check_box';
import { NG_VALUE_ACCESSOR } from '@angular/forms';
import * as i1 from 'devextreme-angular/core';
import { DxComponent, DxTemplateHost, WatcherHelper, NestedOptionHost, IterableDifferHelper, DxIntegrationModule, DxTemplateModule } from 'devextreme-angular/core';
/*!
* devextreme-angular
* Version: 25.1.4
* Build date: Tue Aug 05 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-angular
*/
/* tslint:disable:max-line-length */
const CUSTOM_VALUE_ACCESSOR_PROVIDER = {
provide: NG_VALUE_ACCESSOR,
useExisting: forwardRef(() => DxCheckBoxComponent),
multi: true
};
/**
* The CheckBox is a small box, which when selected by the end user, shows that a particular feature has been enabled or a specific property has been chosen.
*/
class DxCheckBoxComponent extends DxComponent {
_watcherHelper;
_idh;
instance = null;
/**
* Specifies the shortcut key that sets focus on the UI component.
*/
get accessKey() {
return this._getOption('accessKey');
}
set accessKey(value) {
this._setOption('accessKey', value);
}
/**
* Specifies whether the UI component changes its visual state as a result of user interaction.
*/
get activeStateEnabled() {
return this._getOption('activeStateEnabled');
}
set activeStateEnabled(value) {
this._setOption('activeStateEnabled', value);
}
/**
* Specifies whether the UI component responds to user interaction.
*/
get disabled() {
return this._getOption('disabled');
}
set disabled(value) {
this._setOption('disabled', value);
}
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
get elementAttr() {
return this._getOption('elementAttr');
}
set elementAttr(value) {
this._setOption('elementAttr', value);
}
/**
* Specifies whether users can set the CheckBox state to indeterminate.
*/
get enableThreeStateBehavior() {
return this._getOption('enableThreeStateBehavior');
}
set enableThreeStateBehavior(value) {
this._setOption('enableThreeStateBehavior', value);
}
/**
* Specifies whether the UI component can be focused using keyboard navigation.
*/
get focusStateEnabled() {
return this._getOption('focusStateEnabled');
}
set focusStateEnabled(value) {
this._setOption('focusStateEnabled', value);
}
/**
* Specifies the UI component's height.
*/
get height() {
return this._getOption('height');
}
set height(value) {
this._setOption('height', value);
}
/**
* Specifies text for a hint that appears when a user pauses on the UI component.
*/
get hint() {
return this._getOption('hint');
}
set hint(value) {
this._setOption('hint', value);
}
/**
* Specifies whether the UI component changes its state when a user pauses on it.
*/
get hoverStateEnabled() {
return this._getOption('hoverStateEnabled');
}
set hoverStateEnabled(value) {
this._setOption('hoverStateEnabled', value);
}
/**
* Specifies the check box icon's width and height.
*/
get iconSize() {
return this._getOption('iconSize');
}
set iconSize(value) {
this._setOption('iconSize', value);
}
/**
* Specifies whether the component's current value differs from the initial value.
*/
get isDirty() {
return this._getOption('isDirty');
}
set isDirty(value) {
this._setOption('isDirty', value);
}
/**
* Specifies or indicates whether the editor's value is valid.
*/
get isValid() {
return this._getOption('isValid');
}
set isValid(value) {
this._setOption('isValid', value);
}
/**
* The value to be assigned to the `name` attribute of the underlying HTML element.
*/
get name() {
return this._getOption('name');
}
set name(value) {
this._setOption('name', value);
}
/**
* Specifies whether the editor is read-only.
*/
get readOnly() {
return this._getOption('readOnly');
}
set readOnly(value) {
this._setOption('readOnly', value);
}
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled() {
return this._getOption('rtlEnabled');
}
set rtlEnabled(value) {
this._setOption('rtlEnabled', value);
}
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
get tabIndex() {
return this._getOption('tabIndex');
}
set tabIndex(value) {
this._setOption('tabIndex', value);
}
/**
* Specifies the text displayed by the check box.
*/
get text() {
return this._getOption('text');
}
set text(value) {
this._setOption('text', value);
}
/**
* Information on the broken validation rule. Contains the first item from the validationErrors array.
*/
get validationError() {
return this._getOption('validationError');
}
set validationError(value) {
this._setOption('validationError', value);
}
/**
* An array of validation errors.
*/
get validationErrors() {
return this._getOption('validationErrors');
}
set validationErrors(value) {
this._setOption('validationErrors', value);
}
/**
* Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
*/
get validationMessageMode() {
return this._getOption('validationMessageMode');
}
set validationMessageMode(value) {
this._setOption('validationMessageMode', value);
}
/**
* Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.
*/
get validationMessagePosition() {
return this._getOption('validationMessagePosition');
}
set validationMessagePosition(value) {
this._setOption('validationMessagePosition', value);
}
/**
* Indicates or specifies the current validation status.
*/
get validationStatus() {
return this._getOption('validationStatus');
}
set validationStatus(value) {
this._setOption('validationStatus', value);
}
/**
* Specifies the UI component state.
*/
get value() {
return this._getOption('value');
}
set value(value) {
this._setOption('value', value);
}
/**
* Specifies whether the UI component is visible.
*/
get visible() {
return this._getOption('visible');
}
set visible(value) {
this._setOption('visible', value);
}
/**
* Specifies the UI component's width.
*/
get width() {
return this._getOption('width');
}
set width(value) {
this._setOption('width', value);
}
/**
* A function that is executed when the UI component is rendered and each time the component is repainted.
*/
onContentReady;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged;
/**
* A function that is executed after the UI component's value is changed.
*/
onValueChanged;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
accessKeyChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
activeStateEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
disabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
elementAttrChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
enableThreeStateBehaviorChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
focusStateEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
heightChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hintChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hoverStateEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
iconSizeChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
isDirtyChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
isValidChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
nameChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
readOnlyChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
rtlEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
tabIndexChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
textChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationErrorChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationErrorsChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationMessageModeChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationMessagePositionChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationStatusChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
valueChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
visibleChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
widthChange;
/**
*
*/
onBlur;
change(_) { }
touched = (_) => { };
constructor(elementRef, ngZone, templateHost, _watcherHelper, _idh, optionHost, transferState, platformId) {
super(elementRef, ngZone, templateHost, _watcherHelper, transferState, platformId);
this._watcherHelper = _watcherHelper;
this._idh = _idh;
this._createEventEmitters([
{ subscribe: 'contentReady', emit: 'onContentReady' },
{ subscribe: 'disposing', emit: 'onDisposing' },
{ subscribe: 'initialized', emit: 'onInitialized' },
{ subscribe: 'optionChanged', emit: 'onOptionChanged' },
{ subscribe: 'valueChanged', emit: 'onValueChanged' },
{ emit: 'accessKeyChange' },
{ emit: 'activeStateEnabledChange' },
{ emit: 'disabledChange' },
{ emit: 'elementAttrChange' },
{ emit: 'enableThreeStateBehaviorChange' },
{ emit: 'focusStateEnabledChange' },
{ emit: 'heightChange' },
{ emit: 'hintChange' },
{ emit: 'hoverStateEnabledChange' },
{ emit: 'iconSizeChange' },
{ emit: 'isDirtyChange' },
{ emit: 'isValidChange' },
{ emit: 'nameChange' },
{ emit: 'readOnlyChange' },
{ emit: 'rtlEnabledChange' },
{ emit: 'tabIndexChange' },
{ emit: 'textChange' },
{ emit: 'validationErrorChange' },
{ emit: 'validationErrorsChange' },
{ emit: 'validationMessageModeChange' },
{ emit: 'validationMessagePositionChange' },
{ emit: 'validationStatusChange' },
{ emit: 'valueChange' },
{ emit: 'visibleChange' },
{ emit: 'widthChange' },
{ emit: 'onBlur' }
]);
this._idh.setHost(this);
optionHost.setHost(this);
}
_createInstance(element, options) {
return new DxCheckBox(element, options);
}
writeValue(value) {
this.eventHelper.lockedValueChangeEvent = true;
this.value = value;
this.eventHelper.lockedValueChangeEvent = false;
}
setDisabledState(isDisabled) {
this.disabled = isDisabled;
}
registerOnChange(fn) { this.change = fn; }
registerOnTouched(fn) { this.touched = fn; }
_createWidget(element) {
super._createWidget(element);
this.instance.on('focusOut', (e) => {
this.eventHelper.fireNgEvent('onBlur', [e]);
});
}
ngOnDestroy() {
this._destroyWidget();
}
ngOnChanges(changes) {
super.ngOnChanges(changes);
this.setupChanges('validationErrors', changes);
}
setupChanges(prop, changes) {
if (!(prop in this._optionsToUpdate)) {
this._idh.setup(prop, changes);
}
}
ngDoCheck() {
this._idh.doCheck('validationErrors');
this._watcherHelper.checkWatchers();
super.ngDoCheck();
super.clearChangedOptions();
}
_setOption(name, value) {
let isSetup = this._idh.setupSingle(name, value);
let isChanged = this._idh.getChanges(name, value) !== null;
if (isSetup || isChanged) {
super._setOption(name, value);
}
}
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxCheckBoxComponent, deps: [{ token: i0.ElementRef }, { token: i0.NgZone }, { token: i1.DxTemplateHost }, { token: i1.WatcherHelper }, { token: i1.IterableDifferHelper }, { token: i1.NestedOptionHost }, { token: i0.TransferState }, { token: PLATFORM_ID }], target: i0.ɵɵFactoryTarget.Component });
/** @nocollapse */ static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "17.3.12", type: DxCheckBoxComponent, isStandalone: true, selector: "dx-check-box", inputs: { accessKey: "accessKey", activeStateEnabled: "activeStateEnabled", disabled: "disabled", elementAttr: "elementAttr", enableThreeStateBehavior: "enableThreeStateBehavior", focusStateEnabled: "focusStateEnabled", height: "height", hint: "hint", hoverStateEnabled: "hoverStateEnabled", iconSize: "iconSize", isDirty: "isDirty", isValid: "isValid", name: "name", readOnly: "readOnly", rtlEnabled: "rtlEnabled", tabIndex: "tabIndex", text: "text", validationError: "validationError", validationErrors: "validationErrors", validationMessageMode: "validationMessageMode", validationMessagePosition: "validationMessagePosition", validationStatus: "validationStatus", value: "value", visible: "visible", width: "width" }, outputs: { onContentReady: "onContentReady", onDisposing: "onDisposing", onInitialized: "onInitialized", onOptionChanged: "onOptionChanged", onValueChanged: "onValueChanged", accessKeyChange: "accessKeyChange", activeStateEnabledChange: "activeStateEnabledChange", disabledChange: "disabledChange", elementAttrChange: "elementAttrChange", enableThreeStateBehaviorChange: "enableThreeStateBehaviorChange", focusStateEnabledChange: "focusStateEnabledChange", heightChange: "heightChange", hintChange: "hintChange", hoverStateEnabledChange: "hoverStateEnabledChange", iconSizeChange: "iconSizeChange", isDirtyChange: "isDirtyChange", isValidChange: "isValidChange", nameChange: "nameChange", readOnlyChange: "readOnlyChange", rtlEnabledChange: "rtlEnabledChange", tabIndexChange: "tabIndexChange", textChange: "textChange", validationErrorChange: "validationErrorChange", validationErrorsChange: "validationErrorsChange", validationMessageModeChange: "validationMessageModeChange", validationMessagePositionChange: "validationMessagePositionChange", validationStatusChange: "validationStatusChange", valueChange: "valueChange", visibleChange: "visibleChange", widthChange: "widthChange", onBlur: "onBlur" }, host: { attributes: { "ngSkipHydration": "true" }, listeners: { "valueChange": "change($event)", "onBlur": "touched($event)" } }, providers: [
DxTemplateHost,
WatcherHelper,
CUSTOM_VALUE_ACCESSOR_PROVIDER,
NestedOptionHost,
IterableDifferHelper
], usesInheritance: true, usesOnChanges: true, ngImport: i0, template: '', isInline: true, dependencies: [{ kind: "ngmodule", type: DxIntegrationModule }] });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxCheckBoxComponent, decorators: [{
type: Component,
args: [{
selector: 'dx-check-box',
standalone: true,
template: '',
host: { ngSkipHydration: 'true' },
imports: [DxIntegrationModule],
providers: [
DxTemplateHost,
WatcherHelper,
CUSTOM_VALUE_ACCESSOR_PROVIDER,
NestedOptionHost,
IterableDifferHelper
]
}]
}], ctorParameters: () => [{ type: i0.ElementRef }, { type: i0.NgZone }, { type: i1.DxTemplateHost }, { type: i1.WatcherHelper }, { type: i1.IterableDifferHelper }, { type: i1.NestedOptionHost }, { type: i0.TransferState }, { type: undefined, decorators: [{
type: Inject,
args: [PLATFORM_ID]
}] }], propDecorators: { accessKey: [{
type: Input
}], activeStateEnabled: [{
type: Input
}], disabled: [{
type: Input
}], elementAttr: [{
type: Input
}], enableThreeStateBehavior: [{
type: Input
}], focusStateEnabled: [{
type: Input
}], height: [{
type: Input
}], hint: [{
type: Input
}], hoverStateEnabled: [{
type: Input
}], iconSize: [{
type: Input
}], isDirty: [{
type: Input
}], isValid: [{
type: Input
}], name: [{
type: Input
}], readOnly: [{
type: Input
}], rtlEnabled: [{
type: Input
}], tabIndex: [{
type: Input
}], text: [{
type: Input
}], validationError: [{
type: Input
}], validationErrors: [{
type: Input
}], validationMessageMode: [{
type: Input
}], validationMessagePosition: [{
type: Input
}], validationStatus: [{
type: Input
}], value: [{
type: Input
}], visible: [{
type: Input
}], width: [{
type: Input
}], onContentReady: [{
type: Output
}], onDisposing: [{
type: Output
}], onInitialized: [{
type: Output
}], onOptionChanged: [{
type: Output
}], onValueChanged: [{
type: Output
}], accessKeyChange: [{
type: Output
}], activeStateEnabledChange: [{
type: Output
}], disabledChange: [{
type: Output
}], elementAttrChange: [{
type: Output
}], enableThreeStateBehaviorChange: [{
type: Output
}], focusStateEnabledChange: [{
type: Output
}], heightChange: [{
type: Output
}], hintChange: [{
type: Output
}], hoverStateEnabledChange: [{
type: Output
}], iconSizeChange: [{
type: Output
}], isDirtyChange: [{
type: Output
}], isValidChange: [{
type: Output
}], nameChange: [{
type: Output
}], readOnlyChange: [{
type: Output
}], rtlEnabledChange: [{
type: Output
}], tabIndexChange: [{
type: Output
}], textChange: [{
type: Output
}], validationErrorChange: [{
type: Output
}], validationErrorsChange: [{
type: Output
}], validationMessageModeChange: [{
type: Output
}], validationMessagePositionChange: [{
type: Output
}], validationStatusChange: [{
type: Output
}], valueChange: [{
type: Output
}], visibleChange: [{
type: Output
}], widthChange: [{
type: Output
}], onBlur: [{
type: Output
}], change: [{
type: HostListener,
args: ['valueChange', ['$event']]
}], touched: [{
type: HostListener,
args: ['onBlur', ['$event']]
}] } });
class DxCheckBoxModule {
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxCheckBoxModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
/** @nocollapse */ static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "17.3.12", ngImport: i0, type: DxCheckBoxModule, imports: [DxCheckBoxComponent, DxIntegrationModule,
DxTemplateModule], exports: [DxCheckBoxComponent, DxTemplateModule] });
/** @nocollapse */ static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxCheckBoxModule, imports: [DxCheckBoxComponent,
DxIntegrationModule,
DxTemplateModule, DxTemplateModule] });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxCheckBoxModule, decorators: [{
type: NgModule,
args: [{
imports: [
DxCheckBoxComponent,
DxIntegrationModule,
DxTemplateModule
],
exports: [
DxCheckBoxComponent,
DxTemplateModule
]
}]
}] });
/**
* Generated bundle index. Do not edit.
*/
export { DxCheckBoxComponent, DxCheckBoxModule };
//# sourceMappingURL=devextreme-angular-ui-check-box.mjs.map