Gallery

An image gallery widget.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js

The dxGallery widget displays images in a horizontally scrolled view.

This widget, like any other DevExtreme UI widget, can be created using one of three possible approaches: jQuery, Knockout or AngularJS. The following code demonstrates how to create the dxGallery widget using the Knockout approach.

HTML
<div data-bind="dxGallery: { dataSource: galleryData }"></div>

Gallery images are loaded from an array specified via the dataSource configuration option. You can specify a DataSource object, a simple array, or an array of objects as the widget data source.

JavaScript
var galleryData = [
    "images/img1.png",
    "images/img2.png",
    "images/img3.png",
    "images/img4.png"
];

To display widget items, a default template is applied based on the following fields of the data source item objects.

  • disabled
    Specifies whether or not the gallery item is disabled.
  • visible
    Specifies whether or not the gallery item is visible.
  • html
    Specifies the html code inserted into the item element.
  • text
    Specifies the text inserted into the item element.

To learn more about the fields used in the default item template, refer to the Default Item Template reference section of the widget.

You can introduce a custom template for widget items. For this purpose, add a div element with the data-options attribute set to dxTemplate. Assign item to the template name. In this instance, the template will be applied automatically. See the Customize Widget Item Appearance topic to learn more about templates.

See Also
  • To learn how to create widgets in detail, refer to the Create a Widget article.
  • The dxGallery widget is related to the Collection Containers category. So read an overview of the features that are common for collection container widgets in the Common Tasks topic of the Collection Containers article.
Show Example:
jQuery

Configuration

An object defining configuration options for the dxGallery widget.

Methods

This section describes members used to manipulate the widget.

Events

This section describes events fired by this component.

Default Item Template

This section lists the data source fields that are used in a default item template.

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 the 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. For details refer to the Customize Widget Item Appearance topic.