Angular Toast-Benachrichtigungsservice | ng-hub-ui-toast

Standalone Angular Toast-Benachrichtigungsservice mit Signals, Lifecycle-Observables, Fortschrittsleiste, sechs Positionen und vollständigem Theming über CSS-Variablen.

API-Referenz

Hier ist der vollständige Vertrag für toast: alles, was du binden, abhören, projizieren und gestalten kannst, an einem Ort gesammelt. Verdrahte, was du brauchst, und gestalte, was du willst — es ist standalone und Signals-freundlich.

Inputs

Stelle toast mit 12 Inputs ein. Binde sie wie jeden Angular-@Input.

NameTypStandardBeschreibung
data (hub-toast)ErforderlichHubToastData—Der zu rendernde Toast: id, Typ, Nachricht, optionaler Titel, aufgelöste Konfiguration und Lifecycle-Subjects. Wird intern von ToastContainerComponent bereitgestellt — normalerweise bindest du ihn nie selbst.
position (hub-toast-container)HubToastPosition | string'toast-top-right'Die Ecke, für die dieser Container zuständig ist. Er rendert nur Toasts, deren positionClass übereinstimmt — genau das verhindert, dass eine neue Meldung die bereits sichtbaren verschiebt. ToastService setzt den Wert beim Einhängen des Containers.
timeOut / extendedTimeOut (config)number5000 / 2500timeOut ist die Dauer in ms bis zum automatischen Ausblenden (0 = dauerhaft); extendedTimeOut ist die zusätzliche Zeit, die gewährt wird, nachdem der Benutzer den Mauszeiger vom Toast wegbewegt hat.
closeButton / progressBar (config)booleantrue / falsecloseButton zeigt eine Schließen-Schaltfläche auf dem Toast; progressBar zeigt einen Balken, der bis zum automatischen Ausblenden herunterzählt.
closeButtonAriaLabel (config)string'Close'Zugänglicher Name, der für die Schließen-Schaltfläche angesagt wird. Das Zeichen × ist dekorativ, daher ist dies der einzige Name, den ein Screenreader dafür hat; in nicht englischsprachigen Anwendungen übersetzen.
tapToDismiss (config)booleantrueSchließt den Toast, wenn der Benutzer irgendwo darauf klickt.
disableTimeOut (config)boolean | 'timeOut' | 'extendedTimeOut'falseDeaktiviert das automatische Ausblenden: true oder 'timeOut' deaktiviert den anfänglichen Timer; 'extendedTimeOut' deaktiviert nur die Hover-Verlängerung.
newestOnTop (config)booleantrueWenn true, wird der neueste Toast oben im Stapel eingefügt statt unten.
positionClass (config)HubToastPosition | string'toast-top-right'Ecke, in der dieser Toast erscheint: eine der sechs eingebauten Klassen toast-top/bottom-left/center/right oder eine eigene Klasse. Jede Position hat ihren eigenen Container.
maxOpened (config)number0Maximale Anzahl gleichzeitig sichtbarer Toasts, über alle Positionen hinweg gezählt und nicht je Ecke; 0 bedeutet unbegrenzt.
autoDismiss (config)booleanfalseSobald maxOpened erreicht ist, wird der älteste Toast auf dem Bildschirm automatisch entfernt, um Platz zu schaffen — da das Limit global gilt, kann das einer in einer anderen Ecke sein. Ist es aus, wird der Aufruf stattdessen verworfen und sein HubToastRef meldet dropped: true.
preventDuplicates (config)booleanfalseIgnoriert einen neuen Toast, dessen Nachricht und Typ mit einem bereits sichtbaren übereinstimmen, und gibt stattdessen das Handle des vorhandenen Toasts zurück.

Outputs

Reagiere darauf, was toast tut — 1 Events, an die du deine Logik anknüpfen kannst.

NameTypBeschreibung
closed (hub-toast)OutputEmitterRef<number>Gibt die Toast-id aus, wenn der Toast verworfen werden soll — nach Ablauf des Auto-Dismiss-Timers, einem Tippen mit tapToDismiss oder über die Schließen-Schaltfläche.

Methoden

Steuere toast aus dem Code heraus — 7 Methoden auf der programmatischen Schnittstelle.

NameSignaturRückgabeBeschreibung
HubToastService.successsuccess(message: string, title?: string, config?: Partial<HubToastConfig>): HubToastRefHubToastRef handle for the toast, or a handle with dropped: true when the stack was fullZeigt einen Erfolgs-Toast mit der angegebenen Nachricht, optionalem Titel und Konfigurations-Overrides je Aufruf.
HubToastService.errorerror(message: string, title?: string, config?: Partial<HubToastConfig>): HubToastRefHubToastRef handle for the toast, or a handle with dropped: true when the stack was fullZeigt einen Fehler-Toast mit der angegebenen Nachricht, optionalem Titel und Konfigurations-Overrides je Aufruf.
HubToastService.warningwarning(message: string, title?: string, config?: Partial<HubToastConfig>): HubToastRefHubToastRef handle for the toast, or a handle with dropped: true when the stack was fullZeigt einen Warn-Toast mit der angegebenen Nachricht, optionalem Titel und Konfigurations-Overrides je Aufruf.
HubToastService.infoinfo(message: string, title?: string, config?: Partial<HubToastConfig>): HubToastRefHubToastRef handle for the toast, or a handle with dropped: true when the stack was fullZeigt einen Info-Toast mit der angegebenen Nachricht, optionalem Titel und Konfigurations-Overrides je Aufruf.
HubToastService.showshow(message: string, title?: string, config?: Partial<HubToastConfig>, type?: HubToastType | string): HubToastRefHubToastRef handle for the toast, or a handle with dropped: true when the stack was fullZeigt einen Toast mit einem eingebauten oder benutzerdefinierten Typ-String; der Typ wird als data-type auf dem Toast-Host angewendet und steuert das Akzent-Styling.
HubToastService.removeremove(toastId: number): voidvoidEntfernt einen bestimmten Toast anhand der id, die von den Show-Methoden zurückgegeben wird.
HubToastService.clearclear(): voidvoidEntfernt sofort alle aktiven Toasts und schließt dabei das onHidden-Observable jedes Toasts ab.

Templates

Noch keine Templates dokumentiert.