Flarum (v2.0.0-beta.6)
    Preparing search index...

    Class Tooltip

    The Tooltip component is used to create a tooltip for an element. It requires a single child element to be passed to it. Passing multiple children or fragments will throw an error.

    You should use this for any tooltips you create to allow for backwards compatibility when we switch to another tooltip library instead of Bootstrap tooltips.

    If you need to pass multiple children, surround them with another element, such as a <span> or <div>.

    Note: this component will overwrite the title attribute of the first child you pass to it, as this is how the current tooltip system works in Flarum. This shouldn't be an issue if you're using this component correctly.

             <Tooltip text="You wish!">
               <Button>
                 Click for free money!
               </Button>
             </Tooltip>

             <Tooltip text="Woah! That's cool!" position="bottom" showOnFocus>
               <span>3 replies</span>
             </Tooltip>

             // This is wrong! Surround the children with a <span> or similar.
             <Tooltip text="This won't work">
               Click
               <a href="/">here</a>
             </Tooltip>

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attrs element state

    Methods

    $ onbeforeremove onbeforeupdate oncreate oninit onremove onupdate view component initAttrs

    Constructors

    Properties

    attrs: TooltipAttrs

    The attributes passed into the component.

    https://mithril.js.org/components.html#passing-data-to-components

    element: Element

    The root DOM element for the component.

    state: undefined

    Class component state that is persisted between redraws.

    Updating this will not automatically trigger a redraw, unlike other frameworks.

    This is different to Vnode state, which is always an instance of your class component.

    This is undefined by default.

    Methods

    $

    • $(selector?: string): JQuery

      Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

      For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods