Properties

Protected Abstract defaultConfig

defaultConfig: P

Toast default config.

Protected Abstract toastContainerComponent

toastContainerComponent: Type<C>

Component for Toast Container.

Protected Abstract toastDataInjectionToken

toastDataInjectionToken: InjectionToken<any>

Injection token for Toast Data.

Protected Abstract toastPositionStrategy

toastPositionStrategy: BaseToastPosition

Toast Position Strategy.

Protected Abstract toastTextComponent

toastTextComponent: Type<ToastTextComponent>

Component for simple text toast.

Methods

Protected animateToast

animateToast<T>(toastRef): void

Animates the old Toast out and the new one in.
Type Parameters
- T
Parameters
- toastRef: BaseToastDurationDismissibleRef<EmbeddedViewRef<any> | T, P, BaseToastDurationDismissibleContainerComponent>
Returns void
Overrides BaseToastService.animateToast
- Defined in libs/cdk/utils/toast/classes/duration-dismissible/base-toast-duration-dismissible.service.ts:14

Protected attachToastContainerComponent

attachToastContainerComponent(overlayRef, config): C

Attaches the Toast container component to the overlay.
Parameters
- overlayRef: OverlayRef
- config: P
Returns C
Inherited from BaseToastService.attachToastContainerComponent
- Defined in libs/cdk/utils/toast/base-toast.service.ts:191

Protected createContentComponentInjector

createContentComponentInjector<T>(config, toastRef): Injector

Creates an injector to be used inside a Toast component.
Type Parameters
- T
Parameters
- config: P
 Config that was used to create the Toast.
- toastRef: BaseToastRef<T, any, ToastContainerComponent<any>>
 Reference to the Toast.
Returns Injector
Inherited from BaseToastService.createContentComponentInjector
- Defined in libs/cdk/utils/toast/base-toast.service.ts:211

Protected Abstract getContainerComponentProviders

getContainerComponentProviders(config): StaticProvider[]

Gets Toast Container providers.
Parameters
- config: P
  Toast Config.
Returns StaticProvider[]
Inherited from BaseToastService.getContainerComponentProviders
- Defined in libs/cdk/utils/toast/base-toast.service.ts:76

Protected Abstract getContentComponentProviders

getContentComponentProviders<T>(config, toastRef): StaticProvider[]

Gets Toast Content providers.
Type Parameters
- T
Parameters
- config: P
 Toast Config.
- toastRef: BaseToastRef<T, any, ToastContainerComponent<any>>
 Toast Reference.
Returns StaticProvider[]
Inherited from BaseToastService.getContentComponentProviders
- Defined in libs/cdk/utils/toast/base-toast.service.ts:83

Protected Abstract getToastRef

getToastRef<T>(containerRef, overlayRef, positionStrategy): BaseToastRef<EmbeddedViewRef<any> | T, P, ToastContainerComponent>

Creates Toast Reference for provided container and overlay.
Type Parameters
- T
Parameters
- containerRef: C
 Container reference.
- overlayRef: OverlayRef
 Overlay Reference.
- positionStrategy: BaseToastPosition
 Position Strategy
Returns BaseToastRef<EmbeddedViewRef<any> | T, P, ToastContainerComponent>
Inherited from BaseToastService.getToastRef
- Defined in libs/cdk/utils/toast/base-toast.service.ts:91

hasOpenMessageToasts

hasOpenMessageToasts(): boolean

Returns true if there are some message toasts currently open. False otherwise.

Returns boolean
Inherited from BaseToastService.hasOpenMessageToasts
- Defined in libs/cdk/utils/toast/base-toast.service.ts:127

hideAll

hideAll(): void

Dismisses all Toasts.

Returns void
Inherited from BaseToastService.hideAll
- Defined in libs/cdk/utils/toast/base-toast.service.ts:120

Abstract open

open<T>(toast): BaseToastRef<ToastTextComponent | T | EmbeddedViewRef<T>, P, ToastContainerComponent>

Opens a Toast with the provided configuration.
Type Parameters
- T
Parameters
- toast: string | Type<T> | TemplateRef<T>
 accepts string, Component or TemplateRef.
Returns BaseToastRef<ToastTextComponent | T | EmbeddedViewRef<T>, P, ToastContainerComponent>
Inherited from BaseToastService.open
- Defined in libs/cdk/utils/toast/base-toast.service.ts:50

Abstract openFromComponent

openFromComponent<T>(component, config): BaseToastRef<T, P, ToastContainerComponent>

Opens a Toast with provided component inside.
Type Parameters
- T
Parameters
- component: Type<T>
 Component to render inside a Toast.
- config: P
 Toast configuration.
Returns BaseToastRef<T, P, ToastContainerComponent>
Toast reference.
Inherited from BaseToastService.openFromComponent
- Defined in libs/cdk/utils/toast/base-toast.service.ts:62

Abstract openFromString

openFromString(message, config): BaseToastRef<ToastTextComponent, P, ToastContainerComponent>

Parameters
- message: string
- config: P
Returns BaseToastRef<ToastTextComponent, P, ToastContainerComponent>
Inherited from BaseToastService.openFromString
- Defined in libs/cdk/utils/toast/base-toast.service.ts:54

Abstract openFromTemplate

openFromTemplate(template, config): BaseToastRef<EmbeddedViewRef<any>, any, ToastContainerComponent<any>>

Opens a Toast with provided Template Reference.
Parameters
- template: TemplateRef<any>
 Template Reference to render inside a Toast.
- config: P
 Toast configuration.
Returns BaseToastRef<EmbeddedViewRef<any>, any, ToastContainerComponent<any>>
Toast reference.
Inherited from BaseToastService.openFromTemplate
- Defined in libs/cdk/utils/toast/base-toast.service.ts:70

setNewPositionStrategy

setNewPositionStrategy(newStrategy): void

Sets new position strategy for all Toast items.
Parameters
- newStrategy: BaseToastPosition
  New Position Strategy
Returns void
Inherited from BaseToastService.setNewPositionStrategy
- Defined in libs/cdk/utils/toast/base-toast.service.ts:135

Type Parameters

P extends BaseToastDurationDismissibleConfig

C extends BaseToastDurationDismissibleContainerComponent<P> = BaseToastDurationDismissibleContainerComponent<P>

Hierarchy

Constructors

constructor

Type Parameters

P extends BaseToastDurationDismissibleConfig<any>

C extends BaseToastDurationDismissibleContainerComponent<P> = BaseToastDurationDismissibleContainerComponent<P>

Returns BaseDismissibleToastService<P, C>

Properties

Protected Abstract defaultConfig

Protected Abstract toastContainerComponent

Protected Abstract toastDataInjectionToken

Protected Abstract toastPositionStrategy

Protected Abstract toastTextComponent

Methods

Protected animateToast

Type Parameters

T

Parameters

toastRef: BaseToastDurationDismissibleRef<EmbeddedViewRef<any> | T, P, BaseToastDurationDismissibleContainerComponent<P>>

Returns void

Protected attachToastContainerComponent

Parameters

overlayRef: OverlayRef

config: P

Returns C

Protected createContentComponentInjector

Type Parameters

T

Parameters

config: P

toastRef: BaseToastRef<T, any, ToastContainerComponent<any>>

Returns Injector

Protected Abstract getContainerComponentProviders

Parameters

config: P

Returns StaticProvider[]

Protected Abstract getContentComponentProviders

Type Parameters

T

Parameters

config: P

toastRef: BaseToastRef<T, any, ToastContainerComponent<any>>

Returns StaticProvider[]

Protected Abstract getToastRef

Type Parameters

T

Parameters

containerRef: C

overlayRef: OverlayRef

positionStrategy: BaseToastPosition

Returns BaseToastRef<EmbeddedViewRef<any> | T, P, ToastContainerComponent<P>>

hasOpenMessageToasts

Returns boolean

hideAll

Returns void

Abstract open

Type Parameters

T

Parameters

toast: string | Type<T> | TemplateRef<T>

Returns BaseToastRef<ToastTextComponent | T | EmbeddedViewRef<T>, P, ToastContainerComponent<P>>

Abstract openFromComponent

Type Parameters

T

Parameters

component: Type<T>

config: P

Returns BaseToastRef<T, P, ToastContainerComponent<P>>

Abstract openFromString

Parameters

message: string

config: P

Returns BaseToastRef<ToastTextComponent, P, ToastContainerComponent<P>>

Abstract openFromTemplate

Parameters

template: TemplateRef<any>

config: P