React UI Components Documentation
ReactJS Tooltip Component
The Tooltip component for ReactJS represents a widget that displays a popup message. The widget can be used in combination with any HTML element. You just need to call the Tooltip's "add" method and pass the HTML element as parameter.
Prerequisites
Refer to ReactJS Getting Started before you start with this help topic.
Configuration
The Tooltip component for ReactJS requires the following imports.
import React from 'react';import ReactDOM from 'react-dom'; import JqxTooltip from 'jqwidgets-react/react_jqxtooltip.js';
Then we create our component class. Properties and methods are put as ReactJS props.
class App extends React.Component { render () { let imgStyle = { margin: 10 }; let tooltipStyle = { float: 'left' }; return ( <JqxTooltip style={tooltipStyle} position={'mouse'} name={'movieTooltip'} content={'<b>Title:</b> <i>The Amazing Spider-man</i><br /><b>Year:</b> 2012'} > <img style={imgStyle} src="images/The_Amazng_Spider_Man.jpeg" /> </JqxTooltip> ) }}
Finally we render our class in the desired HTML element:
ReactDOM.render(<App />, document.getElementById('app'));
Events Methods & Properties
In order to bind to any event, change any property or call any method, we need a reference to the component.
For that we use the ReactJS "ref" Callback Attribute:
<JqxTooltip ref='myTooltip' position={'mouse'} name={'movieTooltip'} ....>
Now, when we have a reference, we need to call the desired event/property/method.
This is done in the componentDidMount() ReactJS Component Lifecycle method.
class App extends React.Component { componentDidMount() { //your logic } render () { return ( .... ) }};
Events
The open event is triggered when the tooltip is opened (shown).
The following example demonstrates how to add an event listener:
Methods & Properties
This is how you call methods & props:
Every component have a method setOptions which accepts a object as an argument. This object contains component settings.
this.refs.myTooltip.setOptions({ autoHide: false, width: 300, height: 50})
Every component also have a method getOptions which returns a object containing the component settings.
Tooltip Examples
Overview
The following example demonstrates how to create a Tooltip component.
Disabled Tooltip
The following example demonstrates how to disable the Tooltip component.