Provides a way to display supplementary information related to an element when a user interacts with it (e.g., hover, focus). It offers features such as placement customization, delays, sticky mode, and animations.

Type Parameters

Hierarchy

Hierarchy

  • Component<P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>, {}>
    • IgrTooltip

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P & Omit<HTMLAttributes<HTMLElement>, keyof P>

    Returns IgrTooltip<P>

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get anchor(): string
  • An element instance or an IDREF to use as the anchor for the tooltip.

    Returns string

  • set anchor(v): void
  • Parameters

    • v: string

    Returns void

  • get disableArrow(): boolean
  • Whether to disable the rendering of the arrow indicator for the tooltip.

    Default

    false
    

    Returns boolean

  • set disableArrow(v): void
  • Parameters

    • v: boolean

    Returns void

  • get hideDelay(): number
  • Specifies the number of milliseconds that should pass before hiding the tooltip.

    Default

    300
    

    Returns number

  • set hideDelay(v): void
  • Parameters

    • v: number

    Returns void

  • get hideTriggers(): string
  • Which event triggers will hide the tooltip. Expects a comma separate string of different event triggers.

    Default

    pointerleave, click
    

    Returns string

  • set hideTriggers(v): void
  • Parameters

    • v: string

    Returns void

  • get message(): string
  • Specifies a plain text as tooltip content.

    Returns string

  • set message(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get offset(): number
  • The offset of the tooltip from the anchor in pixels.

    Default

    6
    

    Returns number

  • set offset(v): void
  • Parameters

    • v: number

    Returns void

  • get open(): boolean
  • Whether the tooltip is showing.

    Default

    false
    

    Returns boolean

  • set open(v): void
  • Parameters

    • v: boolean

    Returns void

  • get placement(): PopoverPlacement
  • Where to place the floating element relative to the parent anchor element.

    Default

    top
    

    Returns PopoverPlacement

  • set placement(v): void
  • Parameters

    Returns void

  • get showDelay(): number
  • Specifies the number of milliseconds that should pass before showing the tooltip.

    Default

    200
    

    Returns number

  • set showDelay(v): void
  • Parameters

    • v: number

    Returns void

  • get showTriggers(): string
  • Which event triggers will show the tooltip. Expects a comma separate string of different event triggers.

    Default

    pointerenter
    

    Returns string

  • set showTriggers(v): void
  • Parameters

    • v: string

    Returns void

  • get sticky(): boolean
  • Specifies if the tooltip remains visible until the user closes it via the close button or Esc key.

    Default

    false
    

    Returns boolean

  • set sticky(v): void
  • Parameters

    • v: boolean

    Returns void

Methods

  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • nextContext: any

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>

    Returns any

  • Hides the tooltip if not already hidden.

    Returns boolean

  • Returns DOMElement<{
        children: any[];
        class: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["className"];
        id: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["id"];
        ref: ((ref) => void);
        style: {};
    }, any>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Shows the tooltip if not already showing. If a target is provided, sets it as a transient anchor.

    Parameters

    • Optional target: string

    Returns boolean

  • Toggles the tooltip between shown/hidden state

    Returns boolean