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.

Example

Basic usage

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

Example

Use of `position` and `showOnFocus` attrs 3 replies

Example

Incorrect usage

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

Hierarchy

Constructors

Properties

The attributes passed into the component.

See

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

childDomNode: null | HTMLElement = null
element: Element

The root DOM element for the component.

firstChild: null | Vnode<any, any> = null
oldText: string = ''
oldVisibility: undefined | boolean
shouldChangeTooltipVisibility: boolean = false
shouldRecreateTooltip: boolean = false
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

  • 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.

    Returns

    the jQuery object for the DOM node

    Final

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

  • Checks if the tooltip DOM node has changed.

    If it has, it updates this.childDomNode to the new node, and sets shouldRecreateTooltip to true.

    Returns void

  • Initialize the component's attrs.

    This can be used to assign default values for missing, optional attrs.

    Parameters

    • attrs: unknown

    Returns void

Generated using TypeDoc v0.23.24