JavaScript/jQuery Box - items
An array of items displayed by the UI component.
The items array can contain:
- Strings
- Objects with fields described in this section
- Objects with any other fields. In this case, specify the itemTemplate.
If you need to update the UI component items, reassign the entire items array as shown in the following example:
boxInstance.option('items', newItems);
As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.
baseSize
Specifies the base size of an item element along the main direction.
This property accepts one of the following types of values:
Number
The base size in pixels.String
A CSS measurement for the base size as used in flex-basis.
See Also
box
Holds a Box configuration object for the item.
Use this field to make the item a nested Box UI component.
disabled
Specifies whether the UI component item responds to user interaction.
html
Specifies the HTML markup to be inserted into the item element.
The Box component evaluates the html property's value. This evaluation, however, makes the Box potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the html property. Refer to the following help topic for more information: Potentially Vulnerable API - html.
You can use the text property as a safe alternative.
ratio
Specifies the ratio value used to count the item element size along the main direction.
We do not recommend changing this option at runtime. If you want to create a responsive layout in your application, use ResponsiveBox instead.
See Also
shrink
A factor that defines how much an item shrinks relative to the rest of the items in the container.
template
Specifies a template that should be used to render this item only.
jQuery
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a jQuery object of the template's container.
- Assign a DOM Node of the template's container.
- Assign a function that returns the jQuery object or a DOM Node of the template's container.
The following example adds a custom item to the component.
$(function() { $("#boxContainer").dxBox({ // ... items: [ { // ... template: '<div>Custom Item</div>' } ] }); });
Angular
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a DOM Node of the template's container.
The following example adds a custom item to the component. Note that Angular uses custom templates instead of the template property.
<dx-box ... > <dxi-item ... > <div *dxTemplate> <div>Custom Item</div> </div> </dxi-item> </dx-box>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxBoxModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxBoxModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a DOM Node of the template's container.
The following example adds a custom item to the component. Note that Vue uses custom templates instead of the template property.
<template> <DxBox ... > <dxItem ... > <div>Custom Item</div> </dxItem> </DxBox> </template> <script> import DxBox, { DxItem } from 'devextreme-vue/box'; export default { components: { DxBox, DxItem }, // ... } </script>
React
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a DOM Node of the template's container.
The following example adds a custom item to the component. In React, specify the render or component properties.
import React from 'react'; import Box, { Item } from 'devextreme-react/box'; const renderCustomItem = () => { return <div>Custom Item</div>; } const App() = () => { return ( <Box ... > <Item ... render={renderCustomItem} > </Item> </Box> ); } export default App;
See Also
text
Specifies text displayed for the UI component item.
If you use both this property and a template, the template overrides the text.
If you have technical questions, please create a support ticket in the DevExpress Support Center.