Class Tooltip

Base Component

Link

https://github.com/twbs/bootstrap/blob/main/js/src/base-component.js

Hierarchy (View Summary)

default
- Tooltip

Index

Constructors

Properties

DATA_KEY Default DefaultType Event EVENT_KEY getInstance getOrCreateInstance NAME VERSION

Methods

disable dispose enable hide setContent show toggle toggleEnabled update

Constructors

constructor

new Tooltip(element: string | Element, options?: Partial<Options>): Tooltip
Parameters
- element: string | Element
- Optionaloptions: Partial<Options>
Returns Tooltip
Overrides default.constructor
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:39

Properties

`Static` `Readonly`DATA_KEY

DATA_KEY: string

`Static`Default

Default: Options

Default settings of this plugin

Link

https://getbootstrap.com/docs/5.0/getting-started/javascript/#default-settings

`Static`DefaultType

DefaultType: Record<keyof Options, string>

`Static`Event

Event: Record<
    | "CLICK"
    | "FOCUSIN"
    | "FOCUSOUT"
    | "HIDDEN"
    | "HIDE"
    | "INSERTED"
    | "MOUSEENTER"
    | "MOUSELEAVE"
    | "SHOW"
    | "SHOWN",
    string,
>

`Static` `Readonly`EVENT_KEY

EVENT_KEY: string

`Static`getInstance

getInstance: GetInstanceFactory<Tooltip>

`Static`getOrCreateInstance

getOrCreateInstance: GetOrCreateInstanceFactory<Tooltip>

Static method which allows you to get the tooltip instance associated with a DOM element, or create a new one in case it wasn’t initialised

`Static`NAME

NAME: "tooltip"

`Static` `Readonly`VERSION

VERSION: string

Version of this plugin

Link

https://getbootstrap.com/docs/5.0/getting-started/javascript/#version-numbers

Methods

disable

disable(): void
Removes the ability for an element’s tooltip to be shown. The tooltip will only be able to be shown if it is re-enabled.

Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:76

dispose

dispose(): void
Destroys an element's.

Returns void
Inherited from default.dispose
- Defined in node_modules/@types/bootstrap/js/dist/base-component.d.ts:34

enable

enable(): void
Gives an element’s tooltip the ability to be shown. Tooltips are enabled by default.

Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:70

hide

hide(): void
Hides an element’s tooltip. Returns to the caller before the tooltip has actually been hidden (i.e. before the hidden.bs.tooltip event occurs). This is considered a “manual” triggering of the tooltip.

Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:56

setContent

setContent(
    content?: Record<
        string,
        string
        | Element
        | Tooltip.SetContentFunction
        | null,
    >,
): void
Gives a way to change the tooltip’s content after its initialization.
Parameters
- Optionalcontent: Record<string, string | Element | Tooltip.SetContentFunction | null>
Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:91

show

show(): void
Reveals an element’s tooltip. Returns to the caller before the tooltip has actually been shown (i.e. before the shown.bs.tooltip event occurs). This is considered a “manual” triggering of the tooltip. Tooltips with zero-length titles are never displayed.

Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:49

toggle

toggle(event?: any): void
Toggles an element’s tooltip. Returns to the caller before the tooltip has actually been shown or hidden (i.e. before the shown.bs.tooltip or hidden.bs.tooltip event occurs). This is considered a “manual” triggering of the tooltip.
Parameters
- Optionalevent: any
Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:64

toggleEnabled

toggleEnabled(): void
Toggles the ability for an element’s tooltip to be shown or hidden.

Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:81

update

update(): void
Updates the position of an element’s tooltip.

Returns void
- Defined in node_modules/@types/bootstrap/js/dist/tooltip.d.ts:86