Wagtail client-side components
    Preparing search index...

    Class TooltipController

    A Tippy.js tooltip with simple popover content.

    <button type="button" data-controller="w-tooltip" data-w-tooltip-content-value="More detail here">
      A button with a tooltip
    </button>

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    contentTarget contentValue context hasContentTarget hasOffsetValue offsetValue placementValue tippy? blessings outlets targets values

    Accessors

    application classes data element identifier options outlets plugins scope targets shouldLoad

    Methods

    connect contentValueChanged disconnect dispatch hide initialize placementValueChanged show afterLoad

    Constructors

    • Parameters

      • context: Context

      Returns TooltipController

    Properties

    contentTarget: HTMLElement
    contentValue: string
    context: Context
    hasContentTarget: boolean
    hasOffsetValue: boolean
    offsetValue: [number, number]
    placementValue: Placement
    tippy?: Instance<Props>
    blessings: (<T>(constructor: Constructor<T>) => any)[]
    outlets: string[]
    targets: string[] = ...
    values: {
        content: StringConstructor;
        offset: ArrayConstructor;
        placement: { 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 plugins(): {
          defaultValue: boolean;
          name: string;
          fn(__namedParameters: Instance): { onHide(): void; onShow(): void };
      }[]

      Returns {
          defaultValue: boolean;
          name: string;
          fn(__namedParameters: Instance): { onHide(): void; onShow(): void };
      }[]

    • get scope(): Scope

      Returns Scope

    • get targets(): TargetSet

      Returns TargetSet

    • get shouldLoad(): boolean

      Returns boolean

    Methods

    • 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