Skip to content

Class: Tooltip#

Renderer.Component.Tooltip

Hierarchy#

Tooltip

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

new Tooltip(props)

Parameters#

Name Type
props TooltipProps

Overrides#

React.Component<TooltipProps\>.constructor

Properties#

activePosition#

Optional activePosition: TooltipPosition


context#

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>

see https://reactjs.org/docs/context.html

Inherited from#

React.Component.context


elem#

elem: null | HTMLDivElement = null


isContentVisible#

isContentVisible: boolean = false


isVisible#

isVisible: boolean = false


props#

Readonly props: Readonly<TooltipProps> & Readonly<{ children?: ReactNode }>

Inherited from#

React.Component.props


refs#

refs: Object

deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Index signature#

▪ [key: string]: ReactInstance

Inherited from#

React.Component.refs


state#

state: Readonly<{}>

Inherited from#

React.Component.state


contextType#

Static Optional 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}</>;
  }
}

see https://reactjs.org/docs/context.html#classcontexttype

Inherited from#

React.Component.contextType


defaultProps#

Static defaultProps: object

Accessors#

hoverTarget#

get hoverTarget(): null | HTMLElement

Returns#

null | HTMLElement


targetElem#

get targetElem(): null | HTMLElement

Returns#

null | HTMLElement

Methods#

UNSAFE_componentWillMount#

Optional UNSAFE_componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

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

deprecated 16.3, use componentDidMount or the constructor instead

see - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns#

void

Inherited from#

React.Component.UNSAFE_componentWillMount


UNSAFE_componentWillReceiveProps#

Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

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.

deprecated 16.3, use static getDerivedStateFromProps instead

see - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters#

Name Type
nextProps Readonly<TooltipProps>
nextContext any

Returns#

void

Inherited from#

React.Component.UNSAFE_componentWillReceiveProps


UNSAFE_componentWillUpdate#

Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

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

deprecated 16.3, use getSnapshotBeforeUpdate instead

see - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters#

Name Type
nextProps Readonly<TooltipProps>
nextState Readonly<{}>
nextContext any

Returns#

void

Inherited from#

React.Component.UNSAFE_componentWillUpdate


componentDidCatch#

Optional componentDidCatch(error, errorInfo): void

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

Parameters#

Name Type
error Error
errorInfo ErrorInfo

Returns#

void

Inherited from#

React.Component.componentDidCatch


componentDidMount#

componentDidMount(): void

Returns#

void

Overrides#

React.Component.componentDidMount


componentDidUpdate#

componentDidUpdate(): void

Returns#

void

Overrides#

React.Component.componentDidUpdate


componentWillMount#

Optional componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

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

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

see - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns#

void

Inherited from#

React.Component.componentWillMount


componentWillReceiveProps#

Optional componentWillReceiveProps(nextProps, nextContext): void

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.

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

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters#

Name Type
nextProps Readonly<TooltipProps>
nextContext any

Returns#

void

Inherited from#

React.Component.componentWillReceiveProps


componentWillUnmount#

componentWillUnmount(): void

Returns#

void

Overrides#

React.Component.componentWillUnmount


componentWillUpdate#

Optional componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

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

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters#

Name Type
nextProps Readonly<TooltipProps>
nextState Readonly<{}>
nextContext any

Returns#

void

Inherited from#

React.Component.componentWillUpdate


forceUpdate#

forceUpdate(callback?): void

Parameters#

Name Type
callback? () => void

Returns#

void

Inherited from#

React.Component.forceUpdate


getPosition#

Protected getPosition(position, tooltipBounds, targetBounds): Object

Parameters#

Name Type
position TooltipPosition
tooltipBounds DOMRect
targetBounds DOMRect

Returns#

Object

Name Type
bottom number
left number
right number
top number

getSnapshotBeforeUpdate#

Optional getSnapshotBeforeUpdate(prevProps, prevState): any

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#

Name Type
prevProps Readonly<TooltipProps>
prevState Readonly<{}>

Returns#

any

Inherited from#

React.Component.getSnapshotBeforeUpdate


onEnterTarget#

Protected onEnterTarget(): void

Returns#

void


onLeaveTarget#

Protected onLeaveTarget(): void

Returns#

void


refreshPosition#

refreshPosition(): void

Returns#

void


render#

render(): null | Element

Returns#

null | Element

Overrides#

React.Component.render


setPosition#

Protected setPosition(elem, pos): void

Parameters#

Name Type
elem HTMLDivElement
pos Object
pos.left number
pos.top number

Returns#

void


setState#

setState<K>(state, callback?): void

Type parameters#

Name Type
K extends never

Parameters#

Name Type
state null | {} | (prevState: Readonly<{}>, props: Readonly<TooltipProps>) => null | {} | Pick<{}, K> | Pick<{}, K>
callback? () => void

Returns#

void

Inherited from#

React.Component.setState


shouldComponentUpdate#

Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

Parameters#

Name Type
nextProps Readonly<TooltipProps>
nextState Readonly<{}>
nextContext any

Returns#

boolean

Inherited from#

React.Component.shouldComponentUpdate