AEM Components

Carousel Component (Restriced Use)

The Carousel is used to click through a set of other components, such as Teasers or Media Players.

 

The Carousel is only available for specific uses at the disrection of the Governor's Office.

Overview

Component name: Carousel

Authors who can use: Governor's Office user groups

Templates/page types that can use component: Governor Content Page

Required or optional: optional

Authoring Fields

Adding the Carousel component to the page

Carousel can only be added to Governor Content Page templates. Other templates do not offer the component.

Once on the desired page in Edit mode, add the Carousel by doing the following:

Option 1: Double click on “Drag components here.” A modal titled “Insert New Component” will pop up. Type “Carousel” in the search bar, or scroll to the Carousel in the list. Double click to add to page.

Option 2: On the left hand rail, navigate to the Components tab. Type “Carousel” in the search bar, or scroll to the Carousel in the list. Double click to add to page.

Editing the Carousel component

1. With the edit wrench, open the component.

2. Items tab

  1. Add button: Add a new component to the Carousel slides. Once added, components can be edited as normal.

3. Properties tab

  1. Active Item dropdown: Select which item should appear as the first in the Carousel slides. Default selection shows item #1 first.
  2. Automatically transition slides checkbox: When checked, Carousel will autoplay the slides. Default unchecked. As requested by Governor's Office, not needed- leave unchecked.

4. Accessibility tab

  1. Label field: Add an aria-label attribute for the Carousel that desribes content.
  2. Previous field: Add an aria-label attribute for the Previous button. If authored, will appear visually on the button. If not authored, "Previous" will appear visually on the button.
  3. Next field: Add an aria-label attribute for the Next button. If authored, will appear visually on the button. If not authored, "Next" will appear visually on the button.
  4. Play field: Add an aria-label attribute for the Play button. As requested by Governor's Office, not needed- leave unchecked.
  5. Pause field: Add an aria-label attribute for the Pause button. As requested by Governor's Office, not needed- leave unchecked.
  6. Tablist field: Add an aria-label attirbute for the list of items label.
  7. Sets carousel item's aria label to its title checkbox: When checked, uses aria label field for Carousel items title. Default unchecked.

5. Click Done to exit the component authoring.

6. To edit each item, click the panel from the toolbar, then select the item to edit.

Panel option from authoring toolbar, showing options to edit Teaser 1, Teaser 2, or Teaser 3.

Carousel example

Carousel with a Teaser displaying, along with Previous button, Next button, and indicator that the user is on slide 2/3.

Accessibility

  • Leave fields "Automatically transition slides", "Play", and "Pause" blank, as the component has not been tested for autoplay.

Other tips

  • All components are available to add to Carousel.
  • There is no max number of components that may be added as Carousel slides.
  • Carousel will change if items are of different heights, as different components are differently sized. If using Images or Teasers with images enabled, it is recommended to use images of the same height/width.
  • Carousel buttons are continuous in both directions (ex. if resident is on first slide and clicks "Previous" they are taken to the last slide).