Skip to main content

Interface: NarrationProps

Props for the Narration component.

Properties​

children?​

optional children: ReactNode

Optional children elements to be rendered within the narration.

Defined in​

Narration.tsx:25

className?​

optional className: string

Optional additional class names for the narration container.

Defined in​

Narration.tsx:28

id​

id: string

The unique identifier for the narration.

Defined in​

Narration.tsx:19

showActions?​

optional showActions: boolean

Flag to show or hide the action buttons.

Defined in​

Narration.tsx:43

showSparkle?​

optional showSparkle: boolean

Flag to show or hide the sparkle element.

Defined in​

Narration.tsx:37

optional sparkleLink: string

Optional link for the sparkle element.

Defined in​

Narration.tsx:34

sparkleText?​

optional sparkleText: string

Optional text for the sparkle element.

Defined in​

Narration.tsx:40

title​

title: string

The title of the narration.

Defined in​

Narration.tsx:22

titleClassName?​

optional titleClassName: string

Optional additional class names for the title element.

Defined in​

Narration.tsx:31

titleTag?​

optional titleTag: keyof IntrinsicElements

The HTML tag to use for the title element.

Defined in​

Narration.tsx:46