JavaScript Data GridTooltip Component
Tooltip components allow you to add your own tooltips to the grid's column headers and cells. Use these when the provided tooltip component or the default browser tooltip do not meet your requirements.
Below is a simple example of a tooltip component:
class CustomTooltip {
init(params) {
const eGui = this.eGui = document.createElement('div');
const color = params.color || 'white';
const data = params.api.getDisplayedRowAtIndex(params.rowIndex).data;
eGui.classList.add('custom-tooltip');
eGui.style['background-color'] = color;
eGui.innerHTML = `
<p>
<span class"name">${data.athlete}</span>
</p>
<p>
<span>Country: </span>${data.country}
</p>
<p>
<span>Total: </span>${data.total} </p>`;
}
getGui() {
return this.eGui;
}
}The example below demonstrates how to provide custom tooltips to the grid. Notice the following:
- The Custom Tooltip Component is supplied by name via
colDef.tooltipComponent. - The Custom Tooltip Parameters (for tooltip background color) are supplied using
colDef.tooltipComponentParams. - Tooltips are displayed instantly by setting
tooltipShowDelayto0. - Tooltips hide in 2000ms by setting
tooltipHideDelayto2000. - Tooltips will be shown for the
athleteandcountrycolumns
Implement this interface to provide a custom tooltip.
interface ITooltipComp {
// The init(params) method is called on the tooltip component once. See below for details on the parameters.
init(params: ITooltipParams): void;
// Returns the DOM element for this tooltip
getGui(): HTMLElement;
}The interface for the init parameters is as follows:
Properties available on the ITooltipParams<TData = any, TValue = any, TContext = any> interface.
See the registering custom components section for details on registering and using custom tooltip components.
If you don't want to use the grid's tooltip component, you can use the enableBrowserTooltips config to use the browser's default tooltip. The grid will simply set an element's title attribute to display the tooltip.
By default, when you hover on an item, it will take 2 seconds for the tooltip to be displayed and then 10 seconds for the tooltip to hide. If you need to change these delays, the tooltipShowDelay and tooltipHideDelay configs should be used, which are set in milliseconds.
The delays will have no effect if you are using browser tooltips, as they are controlled entirely by the browser.
The grid will not show a tooltip if there is no value to show. This is the default behaviour as the simplest form of tooltip will show the value it is provided without any additional information. In this case, it would be strange to show the tooltip with no value as that would show as a blank box.
This can be a problem if you wish a tooltip to display for blank values. For example, you might want to display a tooltip saying "This cell has no value" instead. To achieve this, you should utilise tooltipValueGetter to return something different when the value is blank.
The example below shows both displaying and not displaying the tooltip for blank values. Note the following:
- The first three rows have athlete values of
undefined,nulland''(empty string). - The column Athlete Col 1 uses
tooltipFieldfor the tooltip field. When there is no value (the first three rows) no tooltip is displayed. - The column Athlete Col 2 uses
tooltipValueGetterfor the tooltip field. The value getter will return a value (an object) regardless of whether the value to display is empty or not. This ensures the tooltip gets displayed even when no cell value is present.
When we want to display a header tooltip, we set the headerTooltip config as a string, and that string will be displayed as the tooltip. However, when working with custom tooltips we set colDef.tooltipComponent to assign the column's tooltip component and the headerTooltip value will passed to the params object.
If headerTooltip is not present, the tooltip will not be rendered.
The example below shows how to set a custom tooltip to a header and to a grouped header. Note the following:
- The column Athlete Col 1 does not have a
tooltipComponentso it will render the value set in itsheaderTooltipconfig. - The column Athlete Col 2 uses
tooltipComponentso the the value inheaderTooltipis passed to the tooltipComponentparamsto be used. - The
tooltipComponentdetects that it's being rendered by a header because theparamsobject does not contain arowIndexvalue.
The example below shows how to use the default tooltip component with group columns. Because the group column has no real field assigned to it, the tooltipValueGetter function must be used.
The example below enables mouse tracking to demonstrate a scenario where tooltips need to follow the cursor. To enable this feature, set the tooltipMouseTrack to true in the gridOptions.
The example below demonstrates how to use the default browser tooltips.