@edugouvfr/ngx-dsfr-ext/lib/toast/toast.model.d.ts

NgxDsfrExt est une extension au package @edugouvfr/ngx-dsfr (portage Angular des éléments DSFR)

import { DsfrSeverity } from '@edugouvfr/ngx-dsfr';
/**
 * Décrit une notification.
 */
export interface DsfrToast {
    /**
     * Identifiant unique de la notification (sera généré automatiquement si non valorisé).
     */
    toastId?: string;
    /**
     *  Titre de la notification dans une balise `div` de style `toast--header`, accepte le format HTML.
     */
    heading?: string;
    /**
     * Contenu de la notification dans une balise `div` de style `toast--content`, accepte le format HTML.
     */
    content?: string;
    /**
     *  Sévérité du toast ('info' par défaut).
     */
    severity?: DsfrSeverity;
    /**
     * Permet d'individualiser la durée d'affichage de cette notification (5000ms par défaut).
     */
    duration?: number;
}
/**
 * Définit les positions utilisables pour l'apparition des toasts.
 */
export declare enum DsfrToastPositionConst {
    CENTER = "center",
    TOP_LEFT = "top-left",
    TOP_CENTER = "top-center",
    TOP_RIGHT = "top-right",
    BOTTOM_LEFT = "bottom-left",
    BOTTOM_CENTER = "bottom-center",
    BOTTOM_RIGHT = "bottom-right"
}
/**
 * Type union correspondant aux valeurs de l'enum {@link DsfrToastPositionConst}.
 *
 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button
 */
export type DsfrToastPosition = `${DsfrToastPositionConst}`;