@aotearoan/neon/dist/src/model/feedback/banner/NeonBannerMessage.d.ts

Neon is a lightweight design library of Vue 3 components with minimal dependencies.

import type { NeonAlertAction } from '@/model/feedback/alert/NeonAlertAction';
/**
 * Model describing a banner message to be displayed above the page content. See <a href="/feedback/banner">Banner</a>.
 */
export interface NeonBannerMessage {
    /**
     * Optional key of the alert. This can be used to remove a message programmatically later.
     */
    key?: string;
    /**
     * Banner message to display to the user.
     */
    message: string;
    /**
     * Provide an action for the user to click on. Actions consist of a label to display for the action and a callback
     * which is invoked when the user clicks on the action. When a user clicks on an action the alert will also be
     * dismissed.
     */
    action: NeonAlertAction;
}