Carousel

The Avonni Carousel provides a customizable slideshow experience with navigation controls, autoplay options, and styling for various use cases.

Configuring the Carousel

Configuring the Data Source is key to effectively utilizing the Avonni Carousel Component. The Data Source is where you define the content of your carousel. It includes three main types of data sources: Manual, Variable, and Query.

Data Source Type	Description	When to Use
Manual	Involves manually entering data for carousel items. Useful for static content or predefined items.	Ideal for content that doesn't change frequently or for quick setup with specific items.
Variable	Links carousel to variable collections in Salesforce. Items change dynamically with the data.	Suitable when carousel content needs to reflect changing data from Salesforce records.
Query	Enables fetching data through a query, pulling various records/data points from Salesforce.	Ideal for complex data retrieval or when sourcing. Using a 'Get Records' collection is not necessary with this method, as the query itself is powerful enough to simplify your flow.

Data Mappings for Carousel Content

In addition to selecting the data source, setting up Data Mappings is vital. Data Mappings allow you to link specific fields in your data source to the carousel's properties, ensuring that the correct data from Salesforce is displayed correctly in the carousel.

How Data Mappings Work:

• Link specific fields from your data source (like image URLs or text descriptions) to the corresponding carousel attributes.

• Customize which data points control aspects like image display, captions, etc.

This feature is handy when using Variable or Query Data Sources, as it allows the carousel to dynamically present the correct content based on the data it receives.

Changing the Properties

Changing the number of items per panel

You can select the number of images that need to be displayed by panel. The item numbers may vary based on the screen size. The component allows you to set the number of images displayed for small, medium, or large devices.

Small is 480px and more, Medium is 768px and more, and Large is 1024px and more. Items per panel allows you to define a default value of items for your carousel.

Changing Carousel Behavior

• Disable Auto-Scrolling: Enable 'disable-auto-scroll' toggle to stop the automatic scrolling of images. Users must use indicator buttons to view images.

• Remove Control Button: Activate the same toggle ('disable-auto-scroll') to remove the control button.

• Disable Continuous Looping: Enable 'disable-auto-refresh' toggle. Images will scroll once and stop at the last image. This works even if 'disable-auto-scroll' is not enabled.

• Set Image Display Duration: Adjust the 'scroll-duration' attribute in advanced options to change how long each image is displayed.

Adding Interactions

Before Interaction Setup

First, add action elements to carousel items using the 'Actions' section in the component builder. Create action buttons here.

How to create Action Buttons

Create the interaction

Interactions define what will happen when users click on an image.

• On Item Click: The event is fired when a user clicks on an item in the Carousel.

• On Action Click: The event is fired when a user clicks on an action.

Related articles

• How to create a record detail page navigation

• How to create an object page navigation

---

Output Variables

The Carousel exposes several output variables you can reference in your flow after the screen. To use them, select the screen element in Flow Builder, then the Carousel component, and pick the output variable you need.

Current Item

As the carousel navigates between panels (auto-scroll or manual navigation), these variables track which item is currently visible.

Output variable	Type	What it returns
Current Item	Record (SObject)	The full Salesforce record of the item currently displayed in the carousel. Updates automatically as the carousel scrolls.
Current Item Name	Text (String)	The name of the currently displayed item.

Example: A product showcase carousel auto-scrolls through featured products. Use Current Item to dynamically update a detail panel next to the carousel showing the current product's description and price.

Item Clicks

When users click on a carousel item (requires Items Clickable to be enabled), these variables tell you which item was clicked.

Output variable	Type	What it returns
Clicked Item	Record (SObject)	The full Salesforce record of the carousel item the user clicked.
Clicked Item Name	Text (String)	The name of the clicked item.

Example: A user clicks on a product image in the carousel. Use Clicked Item to navigate to a product detail screen.

Action Clicks

When users click an action button on a carousel item, these variables identify which action was triggered and on which item.

Output variable	Type	What it returns
Clicked Item Action Item	Record (SObject)	The full Salesforce record of the item where the user clicked an action.
Clicked Item Action Name	Text (String)	The name of the action the user clicked (e.g., "Add to Cart", "View Details"). Use in a Decision element to route the flow based on which action was pressed.
Clicked Item Action Item Name	Text (String)	The name of the item where the action was clicked.

Example: A carousel displays promotional banners with a "Learn More" action. Use a Decision element to check Clicked Item Action Name and navigate to the appropriate promotional page.

Component Metadata

Output variable	Type	What it returns
Number of Items	Integer	The total number of items currently loaded in the carousel. Useful for displaying a count or making decisions when the carousel is empty.

---

Styling the Carousel

From the Styles panel, you can customize styling for the carousel: Margin, Size, Item, Item Title , Item Description and Indicator.

You can find the instructions for styling here.

Examples

Specifications

Attributes

Name	Type	Description
assistiveText	String	Description of the carousel items for screen-readers.
currentPanel	Integer	Dictates the currently active/visible carousel panel.
disableAutoRefresh	Boolean	If present, the carousel doesn't loop after the last image is displayed.
disableAutoScroll	Boolean	If present, images do not automatically scroll and users must click the indicators to scroll.
hideIndicator	Boolean	If present, the progress indicator is hidden.
hidePreviousNextPanelNavigation	Boolean	If present, the left and right arrows of the carousel are hidden.
indicatorVariant	String	Changes the appearance of the progress indicators. Valid values are base or shaded
isInfinite	Boolean	If present, the carousel will loop when reaching the last panel.
itemsPerPanel	Integer	Number of items to be displayed at a time in the carousel. Maximum of 10 items per panel.
smallItemsPerPanel	Integer	Number of items to be displayed for devices of 480px and more
mediumItemsPerPanel	Integer	Number of items to be displayed for devices of 768px and more
largeItemsPerPanel	Integer	Number of items to be displayed for devices of 1024px and more
scrollDuration	Integer	Auto scroll delay. The default is 5 seconds, after which the next image is displayed
items	CarouselItem[]	Images to display in the carousel

Events

Style