devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
534 lines (463 loc) • 18.2 kB
JavaScript
import * as i0 from '@angular/core';
import { PLATFORM_ID, Component, Inject, Input, Output, ContentChildren, NgModule } from '@angular/core';
import DxBox from 'devextreme/ui/box';
import * as i1 from 'devextreme-angular/core';
import { DxComponent, DxTemplateHost, WatcherHelper, NestedOptionHost, IterableDifferHelper, DxIntegrationModule, DxTemplateModule } from 'devextreme-angular/core';
import { DxiItemComponent, DxiItemModule, DxoBoxModule } from 'devextreme-angular/ui/nested';
import { DxiBoxItemComponent, DxiBoxItemModule } from 'devextreme-angular/ui/box/nested';
/*!
* devextreme-angular
* Version: 24.2.6
* Build date: Mon Mar 17 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 */
/**
* The Box UI component allows you to arrange various elements within it. Separate and adaptive, the Box UI component acts as a building block for the layout.
*/
class DxBoxComponent extends DxComponent {
_watcherHelper;
_idh;
instance = null;
/**
* Specifies how UI component items are aligned along the main direction.
*/
get align() {
return this._getOption('align');
}
set align(value) {
this._setOption('align', value);
}
/**
* Specifies how UI component items are aligned cross-wise.
*/
get crossAlign() {
return this._getOption('crossAlign');
}
set crossAlign(value) {
this._setOption('crossAlign', value);
}
/**
* Binds the UI component to data.
*/
get dataSource() {
return this._getOption('dataSource');
}
set dataSource(value) {
this._setOption('dataSource', value);
}
/**
* Specifies the direction of item positioning in the UI component.
*/
get direction() {
return this._getOption('direction');
}
set direction(value) {
this._setOption('direction', 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 the UI component's height.
*/
get height() {
return this._getOption('height');
}
set height(value) {
this._setOption('height', 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);
}
/**
* The time period in milliseconds before the onItemHold event is raised.
*/
get itemHoldTimeout() {
return this._getOption('itemHoldTimeout');
}
set itemHoldTimeout(value) {
this._setOption('itemHoldTimeout', value);
}
/**
* An array of items displayed by the UI component.
*/
get items() {
return this._getOption('items');
}
set items(value) {
this._setOption('items', value);
}
/**
* Specifies a custom template for items.
*/
get itemTemplate() {
return this._getOption('itemTemplate');
}
set itemTemplate(value) {
this._setOption('itemTemplate', 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 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 when a collection item is clicked or tapped.
*/
onItemClick;
/**
* A function that is executed when a collection item is right-clicked or pressed.
*/
onItemContextMenu;
/**
* A function that is executed when a collection item has been held for a specified period.
*/
onItemHold;
/**
* A function that is executed after a collection item is rendered.
*/
onItemRendered;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
alignChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
crossAlignChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataSourceChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
directionChange;
/**
* 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.
*/
heightChange;
/**
* 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.
*/
itemHoldTimeoutChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
itemsChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
itemTemplateChange;
/**
* 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.
*/
visibleChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
widthChange;
get itemsChildren() {
return this._getOption('items');
}
set itemsChildren(value) {
this._setChildren('items', value, 'DxiBoxItemComponent');
}
get itemsLegacyChildren() {
return this._getOption('items');
}
set itemsLegacyChildren(value) {
this._setChildren('items', value, 'DxiItemComponent');
}
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: 'itemClick', emit: 'onItemClick' },
{ subscribe: 'itemContextMenu', emit: 'onItemContextMenu' },
{ subscribe: 'itemHold', emit: 'onItemHold' },
{ subscribe: 'itemRendered', emit: 'onItemRendered' },
{ subscribe: 'optionChanged', emit: 'onOptionChanged' },
{ emit: 'alignChange' },
{ emit: 'crossAlignChange' },
{ emit: 'dataSourceChange' },
{ emit: 'directionChange' },
{ emit: 'disabledChange' },
{ emit: 'elementAttrChange' },
{ emit: 'heightChange' },
{ emit: 'hoverStateEnabledChange' },
{ emit: 'itemHoldTimeoutChange' },
{ emit: 'itemsChange' },
{ emit: 'itemTemplateChange' },
{ emit: 'rtlEnabledChange' },
{ emit: 'visibleChange' },
{ emit: 'widthChange' }
]);
this._idh.setHost(this);
optionHost.setHost(this);
}
_createInstance(element, options) {
return new DxBox(element, options);
}
ngOnDestroy() {
this._destroyWidget();
}
ngOnChanges(changes) {
super.ngOnChanges(changes);
this.setupChanges('dataSource', changes);
this.setupChanges('items', changes);
}
setupChanges(prop, changes) {
if (!(prop in this._optionsToUpdate)) {
this._idh.setup(prop, changes);
}
}
ngDoCheck() {
this._idh.doCheck('dataSource');
this._idh.doCheck('items');
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: DxBoxComponent, 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: DxBoxComponent, selector: "dx-box", inputs: { align: "align", crossAlign: "crossAlign", dataSource: "dataSource", direction: "direction", disabled: "disabled", elementAttr: "elementAttr", height: "height", hoverStateEnabled: "hoverStateEnabled", itemHoldTimeout: "itemHoldTimeout", items: "items", itemTemplate: "itemTemplate", rtlEnabled: "rtlEnabled", visible: "visible", width: "width" }, outputs: { onContentReady: "onContentReady", onDisposing: "onDisposing", onInitialized: "onInitialized", onItemClick: "onItemClick", onItemContextMenu: "onItemContextMenu", onItemHold: "onItemHold", onItemRendered: "onItemRendered", onOptionChanged: "onOptionChanged", alignChange: "alignChange", crossAlignChange: "crossAlignChange", dataSourceChange: "dataSourceChange", directionChange: "directionChange", disabledChange: "disabledChange", elementAttrChange: "elementAttrChange", heightChange: "heightChange", hoverStateEnabledChange: "hoverStateEnabledChange", itemHoldTimeoutChange: "itemHoldTimeoutChange", itemsChange: "itemsChange", itemTemplateChange: "itemTemplateChange", rtlEnabledChange: "rtlEnabledChange", visibleChange: "visibleChange", widthChange: "widthChange" }, host: { attributes: { "ngSkipHydration": "true" } }, providers: [
DxTemplateHost,
WatcherHelper,
NestedOptionHost,
IterableDifferHelper
], queries: [{ propertyName: "itemsChildren", predicate: DxiBoxItemComponent }, { propertyName: "itemsLegacyChildren", predicate: DxiItemComponent }], usesInheritance: true, usesOnChanges: true, ngImport: i0, template: '', isInline: true });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxBoxComponent, decorators: [{
type: Component,
args: [{
selector: 'dx-box',
template: '',
host: { ngSkipHydration: 'true' },
providers: [
DxTemplateHost,
WatcherHelper,
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: { align: [{
type: Input
}], crossAlign: [{
type: Input
}], dataSource: [{
type: Input
}], direction: [{
type: Input
}], disabled: [{
type: Input
}], elementAttr: [{
type: Input
}], height: [{
type: Input
}], hoverStateEnabled: [{
type: Input
}], itemHoldTimeout: [{
type: Input
}], items: [{
type: Input
}], itemTemplate: [{
type: Input
}], rtlEnabled: [{
type: Input
}], visible: [{
type: Input
}], width: [{
type: Input
}], onContentReady: [{
type: Output
}], onDisposing: [{
type: Output
}], onInitialized: [{
type: Output
}], onItemClick: [{
type: Output
}], onItemContextMenu: [{
type: Output
}], onItemHold: [{
type: Output
}], onItemRendered: [{
type: Output
}], onOptionChanged: [{
type: Output
}], alignChange: [{
type: Output
}], crossAlignChange: [{
type: Output
}], dataSourceChange: [{
type: Output
}], directionChange: [{
type: Output
}], disabledChange: [{
type: Output
}], elementAttrChange: [{
type: Output
}], heightChange: [{
type: Output
}], hoverStateEnabledChange: [{
type: Output
}], itemHoldTimeoutChange: [{
type: Output
}], itemsChange: [{
type: Output
}], itemTemplateChange: [{
type: Output
}], rtlEnabledChange: [{
type: Output
}], visibleChange: [{
type: Output
}], widthChange: [{
type: Output
}], itemsChildren: [{
type: ContentChildren,
args: [DxiBoxItemComponent]
}], itemsLegacyChildren: [{
type: ContentChildren,
args: [DxiItemComponent]
}] } });
class DxBoxModule {
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxBoxModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
/** @nocollapse */ static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "17.3.12", ngImport: i0, type: DxBoxModule, declarations: [DxBoxComponent], imports: [DxiItemModule,
DxoBoxModule,
DxiBoxItemModule,
DxIntegrationModule,
DxTemplateModule], exports: [DxBoxComponent, DxiItemModule,
DxoBoxModule,
DxiBoxItemModule,
DxTemplateModule] });
/** @nocollapse */ static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxBoxModule, imports: [DxiItemModule,
DxoBoxModule,
DxiBoxItemModule,
DxIntegrationModule,
DxTemplateModule, DxiItemModule,
DxoBoxModule,
DxiBoxItemModule,
DxTemplateModule] });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxBoxModule, decorators: [{
type: NgModule,
args: [{
imports: [
DxiItemModule,
DxoBoxModule,
DxiBoxItemModule,
DxIntegrationModule,
DxTemplateModule
],
declarations: [
DxBoxComponent
],
exports: [
DxBoxComponent,
DxiItemModule,
DxoBoxModule,
DxiBoxItemModule,
DxTemplateModule
]
}]
}] });
/**
* Generated bundle index. Do not edit.
*/
export { DxBoxComponent, DxBoxModule };
//# sourceMappingURL=devextreme-angular-ui-box.mjs.map