Class ToastService

Service for showing auto-dismissing toast notifications.

Inject this service and call one of the convenience methods (info, success, warning, error) or use show() for full control.

The toast container component (<ui-toast-container>) must be placed somewhere in the application template (typically in the root component) for toasts to be rendered.

Example

private readonly toast = inject(ToastService);

save(): void {
  this.toast.success('Document saved');
}

Index

Constructors

constructor

new ToastService(): ToastService
Returns ToastService

Properties

`Readonly`toasts

toasts: WritableSignal<readonly ToastInstance[]> = ...

All currently active toast instances.

Methods

clear

clear(): void
Remove all toasts.

Returns void
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:121

dismiss

dismiss(id: string): void
Dismiss a toast by ID with exit animation.
Parameters
- id: string
Returns void
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:100

error

error(message: string, config?: Partial<ToastConfig>): string
Show an error toast.
Parameters
- message: string
- Optionalconfig: Partial<ToastConfig>
Returns string
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:95

info

info(message: string, config?: Partial<ToastConfig>): string
Show an informational toast.
Parameters
- message: string
- Optionalconfig: Partial<ToastConfig>
Returns string
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:80

remove

remove(id: string): void
Immediately remove a toast without animation.
Parameters
- id: string
Returns void
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:111

show

show(config: ToastConfig): string
Show a toast with full configuration.
Parameters
- config: ToastConfig
Returns string
The unique ID of the created toast.
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:55

success

success(message: string, config?: Partial<ToastConfig>): string
Show a success toast.
Parameters
- message: string
- Optionalconfig: Partial<ToastConfig>
Returns string
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:85

warning

warning(message: string, config?: Partial<ToastConfig>): string
Show a warning toast.
Parameters
- message: string
- Optionalconfig: Partial<ToastConfig>
Returns string
- Defined in packages/ui-kit/src/lib/toast/toast.service.ts:90

Class ToastService

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ToastService

Properties

`Readonly`toasts

Methods

clear

Returns void

dismiss

Parameters

Returns void

error

Parameters

Returns string

info

Parameters

Returns string

remove

Parameters

Returns void

show

Parameters

Returns string

success

Parameters

Returns string

warning

Parameters

Returns string

Settings

On This Page

Class ToastService

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ToastService

Properties

Readonlytoasts

Methods

clear

Returns void

dismiss

Parameters

Returns void

error

Parameters

Returns string

info

Parameters

Returns string

remove

Parameters

Returns void

show

Parameters

Returns string

success

Parameters

Returns string

warning

Parameters

Returns string

Settings

On This Page

`Readonly`toasts