Interface ShowMessageOptions

Options for showing a message.

interface ShowMessageOptions {
    buttons?: MessageBubbleButtonProps[];
    description?: ReactNode;
    forcePosition?: Position;
    isDraggable?: boolean;
    overlay?: boolean;
    text: ReactNode;
    title?: ReactNode;
}

Hierarchy (view full)

Properties

buttons? description? forcePosition? isDraggable? overlay? text title?

Properties

Optionalbuttons

buttons?: MessageBubbleButtonProps[]

A list of buttons that will resolve the message. By default, a Proceed button with value ok. The helper will resolve with the value of the button that was clicked.

Optionaldescription

description?: ReactNode

A description shown under the title. Usually, describes the contents of the step.

OptionalforcePosition

forcePosition?: Position

Force the position of the bubble.

OptionalisDraggable

isDraggable?: boolean

If true, the bubble will be draggable. Default true

Optionaloverlay

overlay?: boolean

Obscure the content behind the message and prevent interaction.

text

text: ReactNode

Markdown text to show in the content. Usually, the instructions for the current step. It also accepts ReactNodes.

Optionaltitle

title?: ReactNode

A title shown in the header. Usually, the title of the step.

Settings

On This Page

Properties