---
title: "au-widget-gallery/IGalleryConfig | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-gallery.IGalleryConfig/"
---

# au-widget-gallery/IGalleryConfig

> Provides gallery properties.

## Interfaces

### IGalleryConfig

You can use these properties in **params** of the `AuWidgetGallery` class.
```json
{
  "widgets": [
    {
      "name": "bg-request",
      "type": "ajax",
      "params": {
        "url": "http://example.com/api/backgrounds/christmas",
        "method": "GET"
      }
    },
    {
      "name": "bg-gallery",
      "type": "gallery",
      "params": {
        "prompt": "Choose a background",
        "items": "{{$['bg-request'].response}}"
      }
    }
  ]
}
```

#### Properties

##### applyEmptyValues

```ts
applyEmptyValues: boolean;
```

Indicates if gallery should allow empty items array

##### description?

```ts
optional description?: string;
```

The tooltip.

##### emptyValuesText

```ts
emptyValuesText: string;
```

Warning message that should be displaying if widget get empty items array

##### endpoint?

```ts
optional endpoint?: string;
```

_Deprecated, use `AuWidgetAjax` instead._

##### forceSelection?

```ts
optional forceSelection?: boolean;
```

if `true`, the first element will be automatically selected when the gallery opens.

##### headers?

```ts
optional headers?: any;
```

_Deprecated, use `AuWidgetAjax` instead._

##### items?

```ts
optional items?: IGalleryItem[];
```

An array of images to display in the gallery.

##### itemsExpression?

```ts
optional itemsExpression?: string;
```

##### itemWidth?

```ts
optional itemWidth?: string;
```

This item width allows you to override the default width.

##### method?

```ts
optional method?: string;
```

_Deprecated, use `AuWidgetAjax` instead._

##### onChange

```ts
onChange: Function | Function[];
```

A single function or an array of functions that will be executed when an item is clicked.

##### preselected?

```ts
optional preselected?: string;
```

The name of preselected item.

##### prompt?

```ts
optional prompt?: string;
```

The prompt encouraging users to select an image.

##### showTitle?

```ts
optional showTitle?: boolean;
```

If `true`, displays the title.

***

### IGalleryItem

Provides properties for a gallery item.

#### Properties

##### data

```ts
data: any;
```

A JSON object containing arbitrary data associated with this image.

##### name

```ts
name: string;
```

A unique _machine-readable_ name.

##### previewUrl

```ts
previewUrl: string;
```

A URL to the image to display.

##### title

```ts
title: string;
```

A display name of an item.