Angular Box API

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.

import { DxBoxModule } from "devextreme-angular"
Type: DxBoxTypes.default

View Demo Read Guides

See Also

Configuration

An object defining configuration properties for the Box UI component.

Name Description
align

Specifies how UI component items are aligned along the main direction.
crossAlign

Specifies how UI component items are aligned cross-wise.
dataSource

Binds the UI component to data.
direction

Specifies the direction of item positioning in the UI component.
disabled

Specifies whether the UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
height

Specifies the UI component's height.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
itemComponent

An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.
itemRender

An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
items

An array of items displayed by the UI component.
itemTemplate

Specifies a custom template for items.
onContentReady

A function that is executed when the UI component's content is ready and each time the content is changed.
onDisposing

A function that is executed before the UI component is disposed of.
onInitialized

A function used in JavaScript frameworks to save the UI component instance.
onItemClick

A function that is executed when a collection item is clicked or tapped.
onItemContextMenu

A function that is executed when a collection item is right-clicked or pressed.
onItemHold

A function that is executed when a collection item has been held for a specified period.
onItemRendered

A function that is executed after a collection item is rendered.
onOptionChanged

A function that is executed after a UI component property is changed.
rtlEnabled

Switches the UI component to a right-to-left representation.
visible

Specifies whether the UI component is visible.
width

Specifies the UI component's width.

See Also

Methods

This section describes members used to manipulate the UI component.

Name Description
beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the Box instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
getDataSource()

Gets the DataSource instance.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)

Resets a property to its default value.

See Also

Events

Name Description
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
itemClick

Raised when a collection item is clicked or tapped.
itemContextMenu

Raised when a collection item is right-clicked or pressed.
itemHold

Raised when a collection item has been held for a specified period.
itemRendered

Raised after a collection item is rendered.
optionChanged

Raised after a UI component property is changed.

See Also