Interface UmbModalRouteRegistration<UmbModalTokenData, UmbModalTokenValue>

interface UmbModalRouteRegistration<
    UmbModalTokenData extends
        { [key: string]: any } = { [key: string]: any },
    UmbModalTokenValue = any,
> {
    alias: string | UmbModalToken<UmbModalTokenData, UmbModalTokenValue>;
    key: string;
    path: undefined | string;
    _internal_setRouteBuilder(builder: UmbModalRouteBuilder): void;
    generateModalPath(): string;
    open(params: { [key: string]: string | number }, prepend?: string): void;
    routeSetup(
        router: IRouterSlot,
        modalManagerContext: UmbModalManagerContext,
        params: Params,
    ): Promise<
        undefined
        | UmbModalContext<UmbModalTokenData, UmbModalTokenValue>,
    >;
}

Type Parameters

UmbModalTokenData extends { [key: string]: any } = { [key: string]: any }
UmbModalTokenValue = any

Implemented by

UmbModalRouteRegistrationController

Index

Properties

Methods

_internal_setRouteBuilder generateModalPath open routeSetup

Properties

alias

alias: string | UmbModalToken<UmbModalTokenData, UmbModalTokenValue>

key

key: string

path

path: undefined | string

Methods

_internal_setRouteBuilder

_internal_setRouteBuilder(builder: UmbModalRouteBuilder): void
Parameters
- builder: UmbModalRouteBuilder
Returns void
- Defined in src/packages/core/router/modal-registration/modal-route-registration.interface.ts:23

generateModalPath

generateModalPath(): string
Returns string
- Defined in src/packages/core/router/modal-registration/modal-route-registration.interface.ts:12

open

open(params: { [key: string]: string | number }, prepend?: string): void
Parameters
- params: { [key: string]: string | number }
- Optionalprepend: string
Returns void
- Defined in src/packages/core/router/modal-registration/modal-route-registration.interface.ts:15

routeSetup

routeSetup(
    router: IRouterSlot,
    modalManagerContext: UmbModalManagerContext,
    params: Params,
): Promise<
    undefined
    | UmbModalContext<UmbModalTokenData, UmbModalTokenValue>,
>
Parameters
- router: IRouterSlot
- modalManagerContext: UmbModalManagerContext
- params: Params
Returns Promise<undefined | UmbModalContext<UmbModalTokenData, UmbModalTokenValue>>
- Defined in src/packages/core/router/modal-registration/modal-route-registration.interface.ts:17