Box

The Box widget allows you to arrange various elements within it. Separate and adaptive, the Box widget acts as a building block for the layout.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/box

You can create a widget using one of the following approaches.

  • jQuery
    Use the dxBox jQuery plug-in.

    HTML
    <div id="box">
        <div id="item1" data-options="dxItem:{ ratio: 1, baseSize: 10}">
            . . .
        </div>
        <div id="item2" data-options="dxItem:{ ratio: 3, baseSize: 40}">
            . . .
        </div>
        <div id="item3" data-options="dxItem:{ ratio: 2, baseSize: 20}">
            . . .
        </div>
    </div>
    JavaScript
    $("#box").dxBox({
        direction: 'row',
        height: '70%',
        width: '90%'
    });
  • Knockout
    Add a div element and apply the dxBox binding to this element.

    HTML
    <div data-bind="dxBox: {
        direction: 'row',
        height: '70%',
        width: '90%'
    }">
        <div id="item1" data-options="dxItem:{ ratio: 1, baseSize: 10}">
            . . .
        </div>
        <div id="item2" data-options="dxItem:{ ratio: 3, baseSize: 40}">
            . . .
        </div>
        <div id="item3" data-options="dxItem:{ ratio: 2, baseSize: 20}">
            . . .
        </div>
    </div>
  • AngularJS
    Add a div element and apply the dx-box directive to this element.

    HTML
    <div dx-box="{
        direction: 'row',
        height: '70%',
        width: '90%'
    }">
        <div id="item1" data-options="dxItem:{ ratio: 1, baseSize: 10}">
            . . .
        </div>
        <div id="item2" data-options="dxItem:{ ratio: 3, baseSize: 40}">
            . . .
        </div>
        <div id="item3" data-options="dxItem:{ ratio: 2, baseSize: 20}">
            . . .
        </div>
    </div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

Refer to the Layout Widgets guide for more information on working with the Box widget.

View Demo

Watch Video

Show Example:
AngularJS
Knockout
jQuery

Configuration

An object defining configuration options for the Box widget.

Methods

This section describes members used to manipulate the widget.

Events

This section describes events fired by this widget.

Default Item Template

This section lists the data source fields that are used in a default template for list items.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also