React Gallery API
The Gallery is a UI component that displays a collection of images in a carousel. The UI component is supplied with various navigation controls that allow a user to switch between images.
See Also
jQuery
Angular
Vue
React
Props
An object defining configuration properties for the Gallery UI component.
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the UI component. |
| animationDuration | The time, in milliseconds, spent on slide animation. |
| animationEnabled | Specifies whether or not to animate the displayed item change. |
| dataSource | Binds the UI component to data. |
| disabled | Specifies whether the UI component responds to user interaction. |
| elementAttr | Specifies the global attributes to be attached to the UI component's container element. |
| focusStateEnabled | Specifies whether the UI component can be focused using keyboard navigation. |
| height | Specifies the UI component's height. |
| hint | Specifies text for a hint that appears when a user pauses on the UI component. |
| hoverStateEnabled | Specifies whether the UI component changes its state when a user pauses on it. |
| indicatorEnabled | A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. |
| initialItemWidth | Specifies the width of an area used to display a single image. |
| itemComponent | An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemHoldTimeout | The time period in milliseconds before the onItemHold event is raised. |
| itemRender | An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items | An array of items displayed by the UI component. |
| itemTemplate | Specifies a custom template for items. |
| loop | A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. |
| noDataText | Specifies the text or HTML markup displayed by the UI component if the item collection is empty. |
| onContentReady | A function that is executed when the UI component is rendered and each time the component is repainted. |
| onDisposing | A function that is executed before the UI component is disposed of. |
| onInitialized | A function used in JavaScript frameworks to save the UI component instance. |
| onItemClick | A function that is executed when a collection item is clicked or tapped. |
| onItemContextMenu | A function that is executed when a collection item is right-clicked or pressed. |
| onItemHold | A function that is executed when a collection item has been held for a specified period. |
| onItemRendered | A function that is executed after a collection item is rendered. |
| onOptionChanged | A function that is executed after a UI component property is changed. |
| onSelectionChanged | A function that is executed when a collection item is selected or selection is canceled. |
| rtlEnabled | Switches the UI component to a right-to-left representation. |
| selectedIndex | The index of the currently active gallery item. |
| selectedItem | The selected item object. |
| showIndicator | A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. |
| showNavButtons | A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. |
| slideshowDelay | The time interval in milliseconds, after which the gallery switches to the next item. |
| stretchImages | Specifies if the UI component stretches images to fit the total gallery width. |
| swipeEnabled | A Boolean value specifying whether or not to allow users to switch between items by swiping. |
| tabIndex | Specifies the number of the element when the Tab key is used for navigating. |
| visible | Specifies whether the UI component is visible. |
| width | Specifies the UI component's width. |
| wrapAround | Specifies whether or not to display parts of previous and next images along the sides of the current image. |
See Also
Methods
This section describes members used to manipulate the UI component.
| Name | Description |
|---|---|
| beginUpdate() | Prevents the UI component from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
| dispose() | Disposes of all the resources allocated to the Gallery instance. |
| element() | Gets the root UI component element. |
| endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
| focus() | Sets focus on the UI component. |
| getDataSource() | Gets the DataSource instance. |
| getInstance(element) | Gets the instance of a UI component found using its DOM node. |
| goToItem(itemIndex, animation) | Shows a specific image. |
| instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
| nextItem(animation) | Shows the next image. |
| off(eventName) | Detaches all event handlers from a single event. |
| off(eventName, eventHandler) | Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) | Subscribes to an event. |
| on(events) | Subscribes to events. |
| option() | Gets all UI component properties. |
| option(optionName) | Gets the value of a single property. |
| option(optionName, optionValue) | Updates the value of a single property. |
| option(options) | Updates the values of several properties. |
| prevItem(animation) | Shows the previous image. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Repaints the UI component without reloading data. Call it to update the UI component's markup. |
| resetOption(optionName) | Resets a property to its default value. |
See Also
Events
This section describes events fired by this UI component.
| Name | Description |
|---|---|
| contentReady | Raised when the UI component's content is ready. |
| disposing | Raised before the UI component is disposed of. |
| initialized | Raised only once, after the UI component is initialized. |
| itemClick | Raised when a collection item is clicked or tapped. |
| itemContextMenu | Raised when a collection item is right-clicked or pressed. |
| itemHold | Raised when a collection item has been held for a specified period. |
| itemRendered | Raised after a collection item is rendered. |
| optionChanged | Raised after a UI component property is changed. |
| selectionChanged | Raised when a collection item is selected or selection is canceled. |
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.