Class DefaultReactNotifier

Interface that provides popups for the user.

Hierarchy

DefaultNotifier
- DefaultReactNotifier

Implements

IReactNotifier

Index

Constructors

constructor

Methods

debug error getDelegate getOverrides log setOverrides showBusy showError showInput showMessage showOptions showWindow warn

Constructors

constructor

new DefaultReactNotifier(): DefaultReactNotifier

Returns DefaultReactNotifier

Inherited from DefaultNotifier.constructor

Methods

debug

debug(message: string, options?: NotifierOptions): void
Parameters
- message: string
- Optionaloptions: NotifierOptions
Returns void

Inherit Doc: INotifier.debug

Implementation of IReactNotifier.debug

Inherited from DefaultNotifier.debug

error

error(error: string | Error, options?: NotifierOptions): void
Parameters
- error: string | Error
- Optionaloptions: NotifierOptions
Returns void

Inherit Doc: INotifier.error

Implementation of IReactNotifier.error

Inherited from DefaultNotifier.error

getDelegate

getDelegate(): Partial<IReactNotifier> | null

Returns Partial<IReactNotifier> | null

Inherit Doc: IReactNotifier.getDelegate

getOverrides

getOverrides(): Partial<INotifier> | null

Returns the delegate notifier.

Returns Partial<INotifier> | null

Inherited from DefaultNotifier.getOverrides

log

log(message: string, options?: NotifierOptions): void
Parameters
- message: string
- Optionaloptions: NotifierOptions
Returns void

Inherit Doc: INotifier.log

Implementation of IReactNotifier.log

Inherited from DefaultNotifier.log

setOverrides

setOverrides(overrides: Partial<IReactNotifier> | null): void
Parameters
- overrides: Partial<IReactNotifier> | null
Returns void

Inherit Doc: IReactNotifier.setOverrides

Overrides DefaultNotifier.setOverrides

showBusy

showBusy(
message: ReactNode,
options?: ShowBusyOptions,
): BusyHandle | Promise<BusyHandle>
Useful when performing a long running operation and you want to inform the user.

Returns a BusyHandle: call it to dismiss the indicator, or use its setProgress / setMessage methods to update it while it shows. If multiple calls are made the consumer should continue to indicate blocked until all handles have been dismissed.
Parameters
- message: ReactNode
- Optionaloptions: ShowBusyOptions
Returns BusyHandle | Promise<BusyHandle>

Implementation of IReactNotifier.showBusy

showError

showError(error: any): void
Should return error object exception.
Parameters
- error: any
Returns void

Implementation of IReactNotifier.showError

showInput

showInput(options: ShowInputOptions): Promise<InputResults>
Provider a user with a way to enter a text input.
Parameters
- options: ShowInputOptions
Returns Promise<InputResults>

Implementation of IReactNotifier.showInput

showMessage

showMessage(message: ReactNode, options?: EnqueueNotifierOptions): void
Useful when informing the user of something but are not expecting a response.
Parameters
- message: ReactNode
- Optionaloptions: EnqueueNotifierOptions
Returns void

Implementation of IReactNotifier.showMessage

showOptions

showOptions(options: ShowOptionsOptions): Promise<OptionInput>
Provide a user with a list of options to choose from.
Parameters
- options: ShowOptionsOptions
Returns Promise<OptionInput>

Implementation of IReactNotifier.showOptions

showWindow

showWindow(
type: string,
options?: ShowWindowOptions<any, any>,
): Promise<HTMLElement>
Show a dialog for a given type.
Parameters
- type: string
- Optionaloptions: ShowWindowOptions<any, any>
Returns Promise<HTMLElement>

Implementation of IReactNotifier.showWindow

warn

warn(message: string, options?: NotifierOptions): void
Parameters
- message: string
- Optionaloptions: NotifierOptions
Returns void

Inherit Doc: INotifier.warn

Implementation of IReactNotifier.warn

Inherited from DefaultNotifier.warn

Class DefaultReactNotifier

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns DefaultReactNotifier

Methods

debug

Parameters

Returns void

Inherit Doc: INotifier.debug

error

Parameters

Returns void

Inherit Doc: INotifier.error

getDelegate

Returns Partial<IReactNotifier> | null

Inherit Doc: IReactNotifier.getDelegate

getOverrides

Returns Partial<INotifier> | null

log

Parameters

Returns void

Inherit Doc: INotifier.log

setOverrides

Parameters

Returns void

Inherit Doc: IReactNotifier.setOverrides

showBusy

Parameters

Returns BusyHandle | Promise<BusyHandle>

showError

Parameters

Returns void

showInput

Parameters

Returns Promise<InputResults>

showMessage

Parameters

Returns void

showOptions

Parameters

Returns Promise<OptionInput>

showWindow

Parameters

Returns Promise<HTMLElement>

warn

Parameters

Returns void

Inherit Doc: INotifier.warn

Settings

On This Page