Wagtail client-side components
    Preparing search index...

    Class DialogController

    Instantiates an a11y dialog on the controlled element. Adds support for hide and show methods and blocking body scroll when the dialog is open.

    <div
      data-controller="w-dialog"
      data-w-dialog-theme-value="floating"
      >
       <div data-w-dialog-target="body"></div>
    </div>

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    bodyTarget confirmTarget context dialog hasConfirmTarget notifyTargets themeValue blessings outlets targets values

    Accessors

    application classes data element eventDetail identifier outlets scope targets shouldLoad

    Methods

    confirm connect disconnect dispatch hide initialize show afterLoad

    Constructors

    • Parameters

      • context: Context

      Returns DialogController

    Properties

    bodyTarget: HTMLElement
    confirmTarget: HTMLButtonElement
    context: Context
    dialog: A11yDialog
    hasConfirmTarget: boolean
    notifyTargets: HTMLElement[]

    Optional targets that will be dispatched events for key dialog events.

    themeValue: string
    blessings: (<T>(constructor: Constructor<T>) => any)[]
    outlets: string[]
    targets: string[] = ...
    values: { theme: { default: string; type: StringConstructor } } = ...

    Accessors

    • get application(): Application

      Returns Application

    • get classes(): ClassMap

      Returns ClassMap

    • get data(): DataMap

      Returns DataMap

    • get element(): ElementType

      Returns ElementType

    • get identifier(): string

      Returns string

    • get outlets(): OutletSet

      Returns OutletSet

    • get scope(): Scope

      Returns Scope

    • get targets(): TargetSet

      Returns TargetSet

    • get shouldLoad(): boolean

      Returns boolean

    Methods

    • Returns void

    • Parameters

      • eventName: string
      • Optional__namedParameters: Partial<
            {
                bubbles: boolean;
                cancelable: boolean;
                detail: Object;
                prefix: string;
                target: Element
                | Window
                | Document;
            },
        >

      Returns CustomEvent<Object>

    • Returns void

    • Parameters

      • _identifier: string
      • _application: Application

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods