Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the Galleria widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.

Hierarchy

Index

Properties

activeIndex: number

Index of the first item.

autoPlay: boolean

Items are displayed with a slideshow in autoPlay mode.

behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

changeItemOnIndicatorHover: boolean

When enabled, item is changed on indicator item's hover.

circular: boolean

Defines if scrolling would be infinite.

closeIcon: string

Close icon on fullscreen mode.

formId?: string

ID of the form to use for AJAX requests.

fullScreen: boolean

Whether to display the component on fullscreen.

id: string | string[]

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

indicatorsPosition: string

Position of indicators. Valid values are "bottom", "top", "left" and "right".

numVisible: number

Number of items per page.

postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g., when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

responsiveOptions: { breakpoint: string; numVisible: number }[]

A model of options for responsive design.

showCaption: boolean

Whether to display caption container.

showIndicators: boolean

Whether to display indicator container.

showIndicatorsOnItem: boolean

When enabled, indicator container is displayed on item container.

showItemNavigators: boolean

Whether to display navigation buttons in item container.

showItemNavigatorsOnHover: boolean

Whether to display navigation buttons on item container's hover.

showThumbnailNavigators: boolean

Whether to display navigation buttons in thumbnail container.

showThumbnails: boolean

Whether to display thumbnail container.

thumbnailsPosition: string

Position of thumbnails. Valid values are "bottom", "top", "left" and "right".

transitionInterval: number

Time in milliseconds to scroll items.

verticalViewPortHeight: string

Height of the viewport in vertical layout.

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Generated using TypeDoc