Matterway
    Preparing search index...

    Interface ShowMessageOptions

    Options for showing a message.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    title?: ReactNode

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

    description?: ReactNode

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

    text

    text: ReactNode

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

    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.

    overlay?: boolean

    Obscure the content behind the message and prevent interaction.

    forcePosition?: Position

    Force the position of the bubble.

    isDraggable?: boolean

    If true, the bubble will be draggable. Default true

    Settings

    On This Page

    Properties