The attributes passed into the component.
The root DOM element for the component.
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.
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.
the jQuery object for the DOM node
Checks if the tooltip DOM node has changed.
If it has, it updates this.childDomNode to the new node, and sets
shouldRecreateTooltip to true.
Convenience method to attach a component without JSX.
Has the same effect as calling m(THIS_CLASS, attrs, children).
Initialize the component's attrs.
This can be used to assign default values for missing, optional attrs.
Generated using TypeDoc version 0.22.10
The
Tooltipcomponent 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
titleattribute 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.Basic usage
Use of
3 replies
positionandshowOnFocusattrsIncorrect usage // This is wrong! Surround the children with a or similar.
Click
here