Skip to main content

CarouselBlock

Overview​

CarouselBlock represents a block that displays content in a carousel format. It is used to showcase multiple items, such as images, promotional content, or other media, with sliding functionality.

Attributes​

id​

type: string

A unique identifier for the carousel block.

type​

type: literal = 'carousel'

Discriminant for this block type.

content​

type: ContentBlockType[] (optional)

An array of content blocks to be displayed as slides in the carousel.

lg​

type: string (optional)

Specifies the layout configuration for large screens.

md​

type: string (optional)

Specifies the layout configuration for medium screens.

sm​

type: string (optional)

Specifies the layout configuration for small screens.

fullBleed​

type: boolean (optional)

Indicates whether the carousel spans the full width of its container.

headerText​

type: object (optional)

The header text displayed above the carousel, with the following structure:

  • text: string (optional)
  • format: literal = 'markdown' | 'html' (optional)

paddingTop​

type: PaddingOptions (optional)

Specifies the top padding for the carousel block.

paddingBottom​

type: PaddingOptions (optional)

Specifies the bottom padding for the carousel block.

headerTextPosition​

type: TextAlignment (optional)

Defines the alignment of the header text.

ariaLabel​

type: string (optional)

Accessibility label for the carousel block.