Skip to main content

Card

Stentor API Reference


Stentor API Reference / stentor-models/src / Card

Interface: Card

Defined in: packages/stentor-models/src/Display/Card/Card.ts:4

Extends​

Properties​

type​

type: "CARD"

Defined in: packages/stentor-models/src/Display/Card/Card.ts:5

Overrides​

BaseDisplay.type


title​

title: string

Defined in: packages/stentor-models/src/Display/Card/Card.ts:9

Card title

Overrides​

BaseDisplay.title


subTitle?​

optional subTitle: string

Defined in: packages/stentor-models/src/Display/Card/Card.ts:13

Card secondary title, if available it is smaller font below title


content​

content: string

Defined in: packages/stentor-models/src/Display/Card/Card.ts:17

Description, typically used in the body of the card


smallImageUrl?​

optional smallImageUrl: string

Defined in: packages/stentor-models/src/Display/Card/Card.ts:21

Small image, used on smaller form factors.


largeImageUrl?​

optional largeImageUrl: string

Defined in: packages/stentor-models/src/Display/Card/Card.ts:25

Large image, used on larger form factors


imageActionUrl?​

optional imageActionUrl: string

Defined in: packages/stentor-models/src/Display/Card/Card.ts:31

Beta

When present, if the image is clicked the provided website will open.

Not yet fully supported.


accessibilityText?​

optional accessibilityText: string

Defined in: packages/stentor-models/src/Display/Card/Card.ts:35

Used when available as the accessibility text for the image, if provided.


buttons?​

optional buttons: CardButton[]

Defined in: packages/stentor-models/src/Display/Card/Card.ts:39

Buttons for the card which typically appear below the body of the card near the bottom.


token?​

optional token: string

Defined in: packages/stentor-models/src/Display/Types.ts:9

Inherited from​

BaseDisplay.token