Skip to content

HeatmapTooltip API

API reference docs for the React HeatmapTooltip component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import { HeatmapTooltip } from '@mui/x-charts-pro/Heatmap';
// or
import { HeatmapTooltip } from '@mui/x-charts-pro';

Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
anchorElHTML element
| object
| func		-

An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

components{ Root?: elementType }{}

The components used for each slot inside the Popper. Either a string to use a HTML element or a component.

componentsProps{ root?: func
| object }		{}

The props used for each slot inside the Popper.

container(props, propName) => { if (props[propName] == null) { return new Error(`Prop '${propName}' is required but wasn't specified`); } if (typeof props[propName] !== 'object' || props[propName].nodeType !== 1) { return new Error(`Expected prop '${propName}' to be of type Element`); } return null; }
| func		-

An HTML element or function that returns one. The container will have the portal children appended to it.
You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible.
By default, it uses the body of the top-level document object, so it's simply document.body most of the time.

disablePortalboolfalse

The children will be under the DOM hierarchy of the parent component.

keepMountedboolfalse

Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.

modifiersArray<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain'
| 'afterRead'
| 'afterWrite'
| 'beforeMain'
| 'beforeRead'
| 'beforeWrite'
| 'main'
| 'read'
| 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>		-

Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.

openbool-

If true, the component is shown.

placement'auto-end'
| 'auto-start'
| 'auto'
| 'bottom-end'
| 'bottom-start'
| 'bottom'
| 'left-end'
| 'left-start'
| 'left'
| 'right-end'
| 'right-start'
| 'right'
| 'top-end'
| 'top-start'
| 'top'		'bottom'

Popper placement.

popperOptions{ modifiers?: array, onFirstUpdate?: func, placement?: 'auto-end'
| 'auto-start'
| 'auto'
| 'bottom-end'
| 'bottom-start'
| 'bottom'
| 'left-end'
| 'left-start'
| 'left'
| 'right-end'
| 'right-start'
| 'right'
| 'top-end'
| 'top-start'
| 'top', strategy?: 'absolute'
| 'fixed' }		{}

Options provided to the Popper.js instance.

popperReffunc
| { current?: { destroy: func, forceUpdate: func, setOptions: func, state: { attributes: object, elements: object, modifiersData: object, options: object, orderedModifiers: Array<object>, placement: 'auto-end'
| 'auto-start'
| 'auto'
| 'bottom-end'
| 'bottom-start'
| 'bottom'
| 'left-end'
| 'left-start'
| 'left'
| 'right-end'
| 'right-start'
| 'right'
| 'top-end'
| 'top-start'
| 'top', rects: object, reset: bool, scrollParents: object, strategy: 'absolute'
| 'fixed', styles: object }, update: func } }		-

A ref that points to the used popper instance.

slotPropsobject{}

The props used for each slot inside the Popper.

slotsobject{}

The components used for each slot inside the Popper. Either a string to use a HTML element or a component.

See Slots API below for more details.

sxArray<func
| object
| bool>
| func
| object		-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

transitionboolfalse

Help supporting a react-transition-group/Transition component.

The component cannot hold a ref.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiHeatmapTooltip-cellcellStyles applied to the cell element.
.MuiHeatmapTooltip-labelCelllabelCellStyles applied to the labelCell element.
.MuiHeatmapTooltip-markmarkStyles applied to the mark element.
.MuiHeatmapTooltip-markCellmarkCellStyles applied to the markCell element.
.MuiHeatmapTooltip-paperpaperStyles applied to the paper element.
.MuiHeatmapTooltip-rootrootStyles applied to the root element.
.MuiHeatmapTooltip-rowrowStyles applied to the row element.
.MuiHeatmapTooltip-tabletableStyles applied to the table element.
.MuiHeatmapTooltip-valueCellvalueCellStyles applied to the valueCell element.

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.