Components

List Options

Display options for embedded resource lists.

An embedded list page (lists/{list}) accepts display options as URL query parameters on the list path. They only apply inside an embed. Browse the demo client's lists and open one to find its name in the URL.

OptionValuesDefaultDescription
viewlist, carousellistlist shows the full list page. carousel shows the resources as a scrolling row of cards.
numcardsnumber5Cards visible at once when the page is 1300px or wider. From 960px at most 4 show, then 3, 2 and 1 on narrower screens. Applies with view=carousel.
hideheadertrue, short, falsefalsetrue hides the list header. short shows only the title and description.

Passing the options

Add the options to the list path after a ?. Any of these work:

  • In the container page URL. The second ? is expected; everything after cm_page= is the embedded path:

    https://www.example.com/wellbeing?cm_page=lists/after-the-storm-hurricane-resources-and-support?view=carousel&numcards=3&hideheader=true
  • In the components property:

    components: ['lists/after-the-storm-hurricane-resources-and-support?view=carousel&numcards=3']
  • In the urlParams property, which adds the options to whatever page is shown:

    urlParams: 'view=carousel&numcards=3'

See the example above live: the "After the Storm" list as a carousel of 3 cards with no header.

On this page