Carousel Component

Display a rotating series of Web pages. Clickable controls allow visitors to cycle through the list.

Using This Component

Add the component to the page. There are two initial tabs: Carousel Module and Carousel Items. An additional tab appears after the Build list using option is chosen.

The component as it first appears when added to the page.

The component as it first appears when added to the page.

The title of each page, its descriptive text and its main photo are displayed on each slide. Clickable controls allow visitors to manually cycle through the display of pages.

These components are normally used as teasers to link to Shared Content pages built with the Highlight Template. When the linked module contains a YouTube video, it will be playable from the Carousel. 

Works Best with Highlight Template

For best performance, please use this component with Shared Content pages created using the Highlight Template.

Carousel Module Tab

  • Title: Your descriptive title will be shown in all CAPS on the page.
  • Show "See All" button: Check the box if you would like to provide your visitors with a button that takes them to a webpage which displays all items in the Carousel simultaneously.
  • "See All" button text: If you decide to add a button, enter the buttn's label here.
  • Full list page: Select a URL to which your title and button will link.
The component showing its Carousel Module Tab settings.

The component showing its Carousel Module Tab settings.

Carousel Items Tab

(This tab employs the standard List Builder Component settings.)

Here you will choose the type of list, as well as additional advanced settings.

Build list using: This drop-down menu asks how you want to build your list. You have the option to build it using:

  • Advanced search: Do not choose Advanced Search unless you are familiar with writing queries. Build a list using Java API and REST API. Advanced search accepts a query description, and creates and runs an XPath query.
    • An Advanced Search tab will automatically appear.
    • If desired, the XPath query will filter the result set and extract facets.
    • Query descriptions are made up from a set of predicates.
    • For each predicate type, there is an evaluator component that handles that specific predicate for XPath, filtering and facet extraction.
    • The REST API provides access to these features through HTTP with responses sent in JSON.
  • Child pages: Populate the content of the list with the pages found in a segment of a website.
    • A Child Pages tab will automatically appear. Click the magnifying glass icon to the right of the Parent Page field to select a folder from which to display pages in your list. (If you build your list with child pages you do not have the option of displaying them in the order of your choice.)

Be careful not to list the parent page here by mistake--it can create a loop.
Read more

Do not link to DAM assets using a relative path (/content/dam/...). For these you must use a File Download component.
> read more about this Known Issue

  • Curated list: Build a list with selected choices. Requires you to manually add pages to the list (and maintain).
    • A Curated List tab will automatically appear. Click the magnifying glass icons to select Web pages to be displayed.
    • Use the Up and Down buttons to specify the order that the web pages will be displayed in the list. The minus (-) buttons allow you to delete web pages while the + button enables you to add Web pages.
  • Another list: Populate your list using another previously created list. This is useful if you want to mirror items displayed on another page, while perhaps limiting the amount of items displayed.
    • An Another List tab will automatically appear. Click the arrow at the right of the List Reference field to select another page from which to pull a list to imitate:
      • Click on the field to pull up a browser window of all the pages in your UBCMS.
      • Select the page containing the list you want to use.
      • The browser will display all usable components on the right hand side of the browser. Choose the desired list and click OK.
  • Search: Use a particular word or phrase to build a list. Any page that contains the searched-for term will be included in the list. Meta-data including tags can also be found in this way -- read more about searching for tagged pages.
    • Search query: Enter a predetermined unique keyword or phrase; e.g. "ubgreen-event" in our example.
      This is optional, but with no keyword you will display ALL events in the calendar. More complex queries are possible. (See Tips for Building a List Search Query.)
    • Start in: Click the magnifying glass icon to select which page, and subsequent child pages, the search is confined to. Leave the field blank to search all pages in the UBCMS.
  • Tags: Build a list using the tag words assigned to certain pages. (Read more about Tagging Your Shared Content.)
    • A Tags tab will automatically appear. In the Tags field, type the tags you would like to use or select the tags from a drop-down menu by clicking on the downward arrow sign to the right of the field.
      • In the Limit to path field, choose the scope of the list by selecting the page, and subsequent child pages, to which you wish to limit the list. Leave this field blank to populate the list using the content of your entire UBCMS. Web pages with tags matching your selections will then be displayed in your list.
      • Be advised, items in lists built using tags are not sorted in the normal default order even if they all originate in one folder. If you want the items to appear in a specific order, specify that in the Order by field.
    • Tagged pages can also be listed using the Search option (read more), which allows more advanced control.

New window: Select so each clicked page is displayed in a new browser window.

'Open links in new window' and 'Display as: Full content' are incompatible and will disable each other when selected.

Link Label Icons

When New Window is selected, an additional icon will follow the linked text, to alert visitors that they will be taken to a new browser window, or even leave the current website.

And if the hyperlink goes to a downloadable file, an document icon will instead be shown as well as the file size if the file is on the same server. (Read more about link labels.)

Display as: This drop-down menu asks how you would like your list to be displayed. Lists fall into the general categories of Links, Teasers and Content:

  • Links - Display the pages in the list as underlined links. Clicking on one of the links will redirect the user to the page selected. The types of links available are:
    • Plain (default): If no other option is selected, the list will automatically be displayed as a set of plain links. They are bulleted with the right angle bracket (>) symbol.
    • Medium Call to Action: The links are bulleted with the Call to Action component’s circular, exclamatory icon (medium size).
    • Large Call to Action: The links are bulleted with the Call to Action component’s circular, exclamatory icon (large size).
    • Compact: The links are shown in a simple comma-separated list.
    • Grouped by Date: The un-bulleted list will be displayed with emphasis on the separate entries' time of creation. The date appears as the heading for each entry while the exact time of the page's creation and the link to the page are placed beneath.
    • Grouped by Title: Links are grouped alphabetically by the first letter of their titles and that letter precedes each group; e.g.

      > Terminator
      > Trains, Planes and Automobiles
  • News (with dates): This option also displays an un-bulleted list with the date of creation. A simpler format than Links: Grouped by Date, the title of each entry is followed by the date of creation all on a single line.
  • Teasers - Display a preview of the information that's on the pages from your list. The types of teasers available are:
    • With Images: Instead of bullets, an image from each page appears to the left of the page’s title. The introductory text of each page is displayed beneath the title.
    • Without Images: Displays the title of the page with its introductory paragraph. Items are bulleted with the Call to Action component’s circular, exclamatory icon (large size).
    • With Dates: Instead of bullets, an image from each page appears to the left of each page’s title and its date of creation. The page’s introductory paragraph appears below.
    • Grid: Displays the list as a gallery of images. Each page is represented by an image with its name beneath the picture as the link.
    • Directory (with interests): Meant to be used with the Faculty Profile Template, it reveals each person's name, contact details, titles, and research interests.
  • Content:
    • Full Content Displays the full content of each page in the list.

'Display as: Full content' and 'Open links in new window' are incompatible and will disable each other when selected.

Settings available for Display As.

Settings available for Display As.

Order by: There are several ways in which you can order your list:

  • (blank): The default option sorts the list by the natural page order in the Website Console. This only applies to lists that pull entries directly from the Console, such as Child Pages.
  • postDate: Arrange the list items by the date the pages were created for pages created using the News Article Template or for pages that include the Date Created component. Using postDate for other pages will result in a randomized order.
  • jcr:created: Order the list by the date of creation, with the earliest date of creation beginning the list.
  • cq:lastModified: The list will be ordered by the date of modification. The page most recently edited will appear on top.
  • cq:template: The order will be established according to its arrangement in the Page Tree, sorted by template type used on each page.
  • jcr:title: The list is ordered alphabetically by title.
  • random: Each time someone views the page, they will see a random order to the list.
Settings available for Order By.

Settings available for Order By. Custom options can be type din manually.

Reverse order - Check the box to select whether you would like to inverse the order selected in the Order by field.

The component showing its Carousel Items Tab settings.

The component showing its Carousel Items Tab settings.

Advanced List Options

  • Start at: Select how many items you would like to skip at the beginning of the list (example: '5' will skip the first four items and begin the list at the fifth item). Left blank, the default value of '1' will result in the list displaying every item in your list. This setting can be useful if you wish to feature several items in one group, perhaps at the top of your news page, or on your homepage, and NOT have them repeated with the rest of your list displayed elsewhere on your site.
  • Limit: Choose a maximum number of entries (optional).
    • If left blank, the default value is 100; for example, if you leave it blank, no more than 100 items will be available.
    • If you set the Limit value smaller than the Paginate after value, users will never see the next page navigation!

If you want all items to appear in the list, do not leave the Limit field blank. Instead, enter a value that you anticipate will meet your needs; for example, 200, 500, etc. (The News Center has used 9999 as a 'very large number' because their archives date to 1990.)

  • Exclude current page: Do not display any entries that link to the page on which the list is shown (optional).
  • Enable Scheduling: Select to enable shared content Scheduling.
    • Scheduling can be used to automatically change the content in a list over time.
    • When scheduling is enabled, only pages whose “Featured on/off time” (as set in each page’s Page Properties) will be shown in the list.
    • Scheduled lists can be previewed for a given date and time by right-clicking the list and choosing “Schedule Preview”.
    • Unlike Delayed Activation or Scheduled On/Off Time, Featured On/Off Time does not affect the page’s visibility elsewhere on the site; it is still visible in navigation or by direct link.
    • Pages with “Featured on/off time” set must also be activated.
    • Examples of uses for list scheduling:
      • Hide an application link after a deadline has passed.
      • Switch from one featured image to another in a slideshow each day (set the start time of one item to the end time of another).
The component showing its Carousel Items Tab advanced settings.

The component showing its Carousel Items Tab advanced settings.


  1. This component is only intended for use in the right sidebar and on some homepages, where the width is no more than three columns. In a wider setting, the Carousel may not display well.
  2. Unlike the Full Width Carousel component, only one teaser (with the webpage’s title, main image and introductory text) is displayed at a time.
  3. This component cannot be placed into a column control without using a shared content reference or modifying your site’s design.
  4. For best performance, please use this component with Shared Content pages created using the Highlight Template.

Advanced: Displaying Just Images or Teasers

How to Build a Carousel of Just Images or Teasers

There may be times when you want to build a slideshow but you don't want to link to anything. For example, you have a series of pictures of people making statements, with captions, but you do not have anything more to show about them. To accomplish this, use the Carousel to display a series of shared content pages built using the Highlight Template. If the Highlight Template is not provided with a link, the Carousel teaser will not be linked either.  

Advanced: Adding Playable Video

How to Load a Playable YouTube Video

This component is intended to be used with Shared Content pages built using the Highlight Template. This template comes with a preloaded flexible shared content module, which includes a video tab. Follow these steps to provide working videos in the Carousel.

  1. Create a new Shared Content page using the Highlight Template.
  2. Open that page and add a video to the video tab.
    • Use the full URL for the video, either or
  3. Be sure to include a thumbnail for the video on the Image tab.
    • Without this image, the video will not be playable from the Carousel.
  4. Add any additional details, such as a heading, and descriptive text.
  5. Back in the Carousel, link to your Shared Content page using a Curated or Child Pages list.
  6. The video can now be played from the Carousel.  

Was This Page Helpful?

(so we can thank you or request more details)
( addresses only please)

On this page:

See an Example:

Tip: To display images or teasers without deeper links, see Advanced Use.

Tip: To display working YouTube videos, see Advanced Use.

Related Components:

Last Reviewed:

March 7, 2018