@umbraco-cms/backoffice
    Preparing search index...

    Interface UmbModalContext<ModalData, ModalValue>

    This mixin enables a web-component to host controllers. This enables controllers to be added to the life cycle of this element.

    interface UmbModalContext<
        ModalData extends { [key: string]: any } = { [key: string]: any },
        ModalValue = any,
    > {
        _host: UmbControllerHost;
        alias: string | UmbModalToken<ModalData, ModalValue>;
        backdropBackground?: string;
        data: ModalData;
        element?: ElementLoaderProperty<UUIModalElement>;
        key: string;
        router: null | IRouterSlot<any, any>;
        size: Observable<string>;
        type: UmbModalType;
        value: Observable<ModalValue>;
        view: UmbViewController;
        get controllerAlias(): UmbControllerAlias;
        _internal_removeCurrentModal(): Promise<void>;
        _internal_setCurrentModalPath(path: string): void;
        addEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addUmbController(controller: UmbController): void;
        consumeContext<
            BaseType extends UmbContextMinimal = UmbContextMinimal,
            ResultType extends UmbContextMinimal = BaseType,
        >(
            alias: string | UmbContextToken<BaseType, ResultType>,
            callback: UmbContextCallback<ResultType>,
        ): UmbContextConsumerController<BaseType, ResultType>;
        destroy(): void;
        dispatchEvent(event: Event): boolean;
        forceResolve(): void;
        getContext<
            BaseType extends UmbContextMinimal = UmbContextMinimal,
            ResultType extends UmbContextMinimal = BaseType,
        >(
            alias: string | UmbContextToken<BaseType, ResultType>,
            options?: UmbClassGetContextOptions,
        ): Promise<undefined | ResultType>;
        getHostElement(): Element;
        getUmbControllers(
            filterMethod: (ctrl: UmbController) => boolean,
        ): UmbController[];
        getValue(): ModalValue;
        hasUmbController(controller: UmbController): boolean;
        hostConnected(): void;
        hostDisconnected(): void;
        isResolved(): boolean;
        observe<
            ObservableType extends undefined
            | Observable<T>,
            T,
            SpecificT = ObservableType extends Observable<U>
                ? ObservableType<ObservableType> extends undefined ? undefined | U : U
                : undefined,
            SpecificR = ObservableType extends undefined
                ? undefined
                | UmbObserverController<SpecificT>
                : UmbObserverController<SpecificT>,
        >(
            source: ObservableType,
            callback?: ObserverCallback<SpecificT>,
            controllerAlias?: null | UmbControllerAlias,
        ): SpecificR;
        onSubmit(): Promise<ModalValue>;
        provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
            alias: string | UmbContextToken<R, R>,
            instance: R,
        ): UmbContextProviderController<R>;
        reject(reason?: UmbModalRejectReason): void;
        removeEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        removeUmbController(controller: UmbController): void;
        removeUmbControllerByAlias(unique: UmbControllerAlias): void;
        setModalSize(size: UUIModalSidebarSize): void;
        setValue(value: ModalValue): void;
        submit(): void;
        updateValue(partialValue: Partial<ModalValue>): void;
    }

    Type Parameters

    • ModalData extends { [key: string]: any } = { [key: string]: any }
    • ModalValue = any

    Hierarchy (View Summary)

    Index

    Properties

    _host alias backdropBackground? data element? key router size type value view

    Accessors

    controllerAlias

    Methods

    _internal_removeCurrentModal _internal_setCurrentModalPath addEventListener addUmbController consumeContext destroy dispatchEvent forceResolve getContext getHostElement getUmbControllers getValue hasUmbController hostConnected hostDisconnected isResolved observe onSubmit provideContext reject removeEventListener removeUmbController removeUmbControllerByAlias setModalSize setValue submit updateValue

    Properties

    _host

    _host: UmbControllerHost
    alias: string | UmbModalToken<ModalData, ModalValue>
    backdropBackground?: string
    data: ModalData
    element?: ElementLoaderProperty<UUIModalElement>
    key: string
    router: null | IRouterSlot<any, any> = null
    size: Observable<string> = ...
    type: UmbModalType = 'dialog'
    value: Observable<ModalValue>
    view: UmbViewController

    Accessors

    Methods

    _internal_removeCurrentModal

    _internal_setCurrentModalPath

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods