Last update: Edit

1 Introduction

The Gallery widget, a replacement for both the template grid and list view, helps you build beautiful lists and grids for desktop, tablet, and mobile devices. Featuring the same filtering and sorting as seen in Data Grid 2, the Gallery widget also provides options for varying columns per device type and gives you the power to create amazing grid and list experiences for every user.

Here is an example of a Gallery widget using filters:

Example of gallery using filter and sort

1.2 Advanced Options

The gallery has an option to enable advanced options. When this option is toggled on, it enables numerous features to customize your gallery:

  • Pagination type
  • Pagination position
  • Empty list option
  • Dynamic item class
  • Filtering
  • Sorting

2 Configuration

Several options can be defined in the Gallery widget:

2.1 Data Source

Data source specifies the source of the data being presented in the Gallery. You can select data from Database, Association, Microflow, Nanoflow, or Xpath.

2.2 Columns

We provide a mechanism that automatically applies a different number of columns based on the device being used. In the gallery widget you can select columns for Desktops, Tablets, or Phone/Mobile.

2.3 Items

In the items group you can define the properties related to the items being presented.

2.3.1 Page size

Defines the amount of data shown for each page or the limit to be presented when using virtual scrolling.

2.3.2 Pagination

You can choose between paging buttons (button being presented below or above the grid) or virtual scrolling (mechanism that automatically loads data when the users reaches the bottom of the scrollbar).

2.3.3 Position of Paging Buttons

This option is only available when Pagination is marked as Paging buttons and defines its position relative to the grid items.

2.3.4 Empty Message

When this option is defined as custom it will show a composable region. Here you can place widgets that will be presented when no items are available to be shown, as well as when the filter does not return any data:

Example of empty message

2.3.5 Dynamic Item Class

In the new Gallery widget we offer an option to dynamically apply a CSS class to a specific item. You can achieve this by adding an expression based on the item values (attributes) like the example below.

In this example we check the value of CountryName, then if the attribute is equal to Spain apply the class .my-custom-class to the items:

Example of dynamic item class

2.4 Events

The new Gallery widget can trigger some events while iterating with it.

2.4.1 On Click Action

Triggers an action (such as a nanoflow, microflow, or Show page action) when the end-user clicks in one of the items. It also adds a pointer cursor to signal that it is clickable. This function also complies with accessibility features and can be reached using only the keyboard.

3 Filtering

Example of filtering

In order to enable filtering within the gallery items you need to select the desired attributes to be filtered in the Filtering tab. You can select attributes of the following types:

  • Autonumber
  • Boolean
  • Date & time
  • Decimal
  • Enumeration
  • Hashed string
  • Integer
  • Long
  • String

The attributes selected here will be used for the matching filter placed inside the composable region. When using multiple attributes, the filters will automatically select the matching attributes and then compose the desired filter value in an OR expression. Make sure you just have one filter widget for each type, for example Text Filter and Number Filter.

An example of filtering configuration:

Example of filtering configuration

An example of text filter being used in the composable region combined with a drop-down sort:

Example of filtering composable region

For more information about filters, see the Filters section of Data Grid 2.

4 Sorting

Example of sorting

In the new Gallery widget it is possible to add sorting widgets to the composable region and use them based on the configurations available in the Sorting tab. In order to make the attributes available for the sorting widgets, you must select an attribute and define the name it will show via the sort button.

Example of sorting configuration

The Drop-Down Sort widget is a widget you can use in combination with the Gallery widget. The Drop-Down Sort widget just needs to be placed inside a composable region of the Gallery widget after defining the sorting attributes in the Gallery widget’s Sorting tab.

The Drop-Down Sort widget has two options you can set:

  • Empty option caption: value to be used when no value is selected
  • Screen reader caption: value to be announced by screen readers when using assistive technology

5 Troubleshooting

The new Gallery widget uses CSS Grid as its base for styling. If you need to combine rows or columns you can achieve this using the following helper classes in the Dynamic item class:

  • widget-gallery-column-span-1 until widget-gallery-column-span-12: these classes merge column spaces, pushing items to a new row when the selected amount is reached for each platform
  • widget-gallery-row-span-1 until widget-gallery-row-span-12: these classes merge row spaces, pushing items into new columns or rows when needed