Interface IGalleryConfig

Provides gallery properties. You can use these properties in params of the AuWidgetGallery class.

{
  "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}}"
      }
    }
  ]
}

Package: ui-framework

Properties

applyEmptyValues

Indicates if gallery should allow empty items array

Declaration

applyEmptyValues: boolean

Property Value

Type	Description
boolean	Indicates if gallery should allow empty items array

description

The tooltip.

Declaration

description?: string

Property Value

Type	Description
string	The tooltip.

emptyValuesText

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

Declaration

emptyValuesText: string

Property Value

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

endpoint

Deprecated, use AuWidgetAjax instead.

Declaration

endpoint?: string

Property Value

Type	Description
string	Deprecated, use AuWidgetAjax instead.

forceSelection

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

Declaration

forceSelection?: boolean

Property Value

Type	Description
boolean	if true, the first element will be automatically selected when the gallery opens.

headers

Deprecated, use AuWidgetAjax instead.

Declaration

headers?: any

Property Value

Type	Description
any	Deprecated, use AuWidgetAjax instead.

items

An array of images to display in the gallery.

Declaration

items?: IGalleryItem[]

Property Value

Type	Description
IGalleryItem[]	An array of images to display in the gallery.

itemsExpression

Declaration

itemsExpression?: string

Property Value

Type	Description
string

itemWidth

This item width allows you to override the default width.

Declaration

itemWidth?: string

Property Value

Type	Description
string	This item width allows you to override the default width.

method

Deprecated, use AuWidgetAjax instead.

Declaration

method?: string

Property Value

Type	Description
string	Deprecated, use AuWidgetAjax instead.

onChange

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

Declaration

onChange: Function | Array<Function>

Property Value

Type	Description
Function | Array<Function>	A single function or an array of functions that will be executed when an item is clicked.

preselected

The name of preselected item.

Declaration

preselected?: string

Property Value

Type	Description
string	The name of preselected item.

prompt

The prompt encouraging users to select an image.

Declaration

prompt?: string

Property Value

Type	Description
string	The prompt encouraging users to select an image.

showTitle

If true, displays the title.

Declaration

showTitle?: boolean

Property Value

Type	Description
boolean	If true, displays the title.