RibbonGallerySettings API in JavaScript (ES5) Ribbon API control

Defines the ribbon gallery settings.

Properties

groups

RibbonGalleryGroupModel[]

Defines the properties for collection of gallery items in the Ribbon.

Defaults to []

itemCount

number

Defines the number of items to be displayed in the Ribbon Gallery.

Defaults to 3

popupHeight

string

Defines the height of the ribbon gallery popup.

Defaults to ‘auto’

popupTemplate

string | Function

Defines the template for gallery items in popup. The current gallery item model passed as context to build the content.

Defaults to ”

popupWidth

string

Defines the width of the ribbon gallery popup.

Defaults to ‘auto’

selectedItemIndex

number

Defines the index of current selected gallery item.

Defaults to null

template

string | Function

Defines the template for gallery items contents. The current gallery item model passed as context to build the content.

Defaults to ”

Events

beforeItemRender

EmitType<GalleryItemEventArgs>

Event triggers before rendering each gallery item.

beforeSelect

EmitType<GalleryBeforeSelectEventArgs>

Event triggers before the gallery items selects.

itemHover

EmitType<GalleryHoverEventArgs>

Event triggers when a user hovers over a gallery item.

popupClose

EmitType<GalleryPopupEventArgs>

Event triggers when the gallery popup closes.

popupOpen

EmitType<GalleryPopupEventArgs>

Event triggers when the gallery popup opens.

select

EmitType<GallerySelectEventArgs>

Event triggers when the gallery items selects.