CardList

CardList

Documentation

A responsive grid of authored cards.

Kind

Rendered Content

Required fields

cards, type

Style Guide

Used by

Authoring guidance

Use when

Use for peer items sharing a card presentation.

Properties

cardClass

string

Optional theme styling hook of the individual children cards.

*

cards

A list of cards rendered in their display order.

min items: 1

class

string

Optional styling hook.

columns

number

Controls the preferred number of cards per row; the grid may use fewer columns when space is limited.

minimum: 1 · maximum: 4 · integer only (no decimals)

*

type

string

Identifies the Element type represented by this object.

"card-list"

Example

Required

{ "cards": [ { "title": "Getting Started", "elements": [ { "type": "paragraph", "text": "Learn the basics of birding." } ] } ], "type": "card-list" }

Full

{ "cardClass": "example", "cards": [ { "title": "Getting Started", "elements": [ { "type": "paragraph", "text": "Learn the basics of birding." } ] }, { "title": "Field Skills", "elements": [ { "type": "paragraph", "text": "Practice identifying birds outdoors." } ] } ], "class": "example", "columns": 2, "type": "card-list" }

examples are generated from the schema.