Wagtail client-side components
    Preparing search index...

    Wagtail's extension of the base Stimulus Application with additional capabilities for convenience.

    Hierarchy

    • Application
      • WagtailApplication
    Index

    Constructors

    • Parameters

      • Optionalelement: Element
      • Optionalschema: Schema

      Returns WagtailApplication

    Properties

    actionDescriptorFilters: ActionDescriptorFilters
    debug: boolean
    dispatcher: Dispatcher
    element: Element
    logDebugActivity: (
        identifier: string,
        functionName: string,
        detail?: object,
    ) => void
    logger: Logger
    router: Router
    schema: Schema

    Accessors

    • get controllers(): Controller<Element>[]

      Returns Controller<Element>[]

    Methods

    • Parameters

      Returns Controller<Element> | null

    • Parameters

      • error: Error
      • message: string
      • detail: object

      Returns void

    • Parameters

      • ...definitions: Definition[]

      Returns void

    • Parameters

      • definitions: Definition[]

      Returns void

    • Returns the first Stimulus controller that matches the identifier.

      Type Parameters

      Parameters

      • identifier: string

        The identifier of the controller to query.

      Returns T | null

      The first controller instance that matches the identifier, or null if not found.

      const controller = window.wagtail.app.queryController('w-preview');
      const content = await controller?.extractContent();
    • Returns all Stimulus controllers that match the identifier.

      Type Parameters

      Parameters

      • identifier: string

        The identifier of the controller to query.

      Returns T[]

      An array of controller instances that match the identifier.

      const controllers = window.wagtail.app.queryControllerAll('w-action');
      controllers.forEach((controller) => controller.reset());
    • Parameters

      • identifier: string
      • controllerConstructor: ControllerConstructor

      Returns void

    • Parameters

      • name: string
      • filter: ActionDescriptorFilter

      Returns void

    • Returns Promise<void>

    • Returns void

    • Parameters

      • ...identifiers: string[]

      Returns void

    • Parameters

      • identifiers: string[]

      Returns void

    • Parameters

      • Optionalelement: Element
      • Optionalschema: Schema

      Returns Application