A newer version of this page is available. Switch to the current version.

jQuery Gallery - items

An array of items displayed by the UI component.

Type:

Array<String | dxGalleryItem | any>

Raised Events: onOptionChanged

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:

JavaScript
galleryInstance.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.

NOTE
Do not use the items property if you use dataSource, and vice versa.

disabled

Specifies whether the UI component item responds to user interaction.

Type:

Boolean

Default Value: false

html

Specifies the HTML markup to be inserted into the item element.

Type:

String

The Gallery component evaluates the html property's value. This evaluation, however, makes the Gallery 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.

imageAlt

Specifies the text passed to the alt attribute of the image markup element.

Type:

String

imageSrc

Specifies the URL of the image displayed by the item.

Type:

String

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data: any

The item object to be rendered.

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. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render property.

jQuery
index.js
$(function() {
    $("#galleryContainer").dxGallery({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-gallery ... >
    <dxi-item ... >
        <div *dxTemplate>
            <div>Custom Item</div>
        </div>
    </dxi-item>
</dx-gallery>
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 { DxGalleryModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxGalleryModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxGallery ... >
        <dxItem ... >
            <div>Custom Item</div>
        </dxItem>
    </DxGallery>
</template>

<script>

import DxGallery, {
    DxItem
} from 'devextreme-vue/gallery';

export default {
    components: {
        DxGallery,
        DxItem
    },
    // ...
}
</script>
React
App.js
import React from 'react';

import Gallery, {
    Item
} from 'devextreme-react/gallery';

const renderCustomItem = () => {
    return <div>Custom Item</div>;
}

class App extends React.Component {
    render() {
        return (
            <Gallery ... >
                <Item ...
                    render={renderCustomItem}
                >
                </Item>
            </Gallery>
        );
    }
}
export default App;
See Also

text

Specifies text displayed for the UI component item.

Type:

String