Documentation / dialogs

dialogs

Interfaces

DialogMediatorProps

Props for the dialog mediator.

Properties

children?

optional children: Element | Element[]

Children to provide the dialog mediator to.

Defined in

Source/JavaScript/Applications.React.MVVM/dialogs/DialogMediator.tsx:19

handler

handler: IDialogMediatorHandler

The dialog mediator context.

Defined in

Source/JavaScript/Applications.React.MVVM/dialogs/DialogMediator.tsx:24

parentHandler?

optional parentHandler: IDialogMediatorHandler

Parent handler, if any.

Defined in

Source/JavaScript/Applications.React.MVVM/dialogs/DialogMediator.tsx:29

Functions

DialogMediator()

DialogMediator(props): Element

Provide the dialog mediator to the children.

Parameters

props

DialogMediatorProps

Props for the dialog mediator.

Returns

Element

Provider for the dialog mediator.

Defined in

Source/JavaScript/Applications.React.MVVM/dialogs/DialogMediator.tsx:45

---

DialogMediatorContext()

DialogMediatorContext(props): ReactNode

Context for the dialog mediator.

Parameters

props

ProviderProps

Returns

ReactNode

Defined in

Source/JavaScript/Applications.React.MVVM/dialogs/DialogMediator.tsx:10

---

useDialog()

useDialog<TProps, TResponse>(requestType, DialogComponent): [FC<TProps>, ShowDialog<TProps, TResponse>]

Use a dialog request for showing a dialog, similar to useDialog.

Type Parameters

• TProps extends object = object

• TResponse = object

Parameters

requestType

Constructor<TProps>

Type of request to use that represents a request that will be made by your view model.

DialogComponent

ComponentType<TProps>

The dialog component to render.

Returns

[FC<TProps>, ShowDialog<TProps, TResponse>]

A tuple with a component to use for rendering the dialog.

Defined in

Source/JavaScript/Applications.React.MVVM/dialogs/useDialog.tsx:15

---

useDialogMediator()

useDialogMediator(): IDialogMediatorHandler

Use the dialog mediator.

Returns

IDialogMediatorHandler

The dialog mediator.

Defined in

Source/JavaScript/Applications.React.MVVM/dialogs/DialogMediator.tsx:36

References

BusyIndicator

Re-exports BusyIndicator

DialogMediatorHandler

Re-exports DialogMediatorHandler

DialogRegistration

Re-exports DialogRegistration

DialogRequest

Re-exports DialogRequest

Dialogs

Re-exports Dialogs

IDialogMediatorHandler

Re-exports IDialogMediatorHandler

IDialogs

Re-exports IDialogs