Tooltip

Source@react-form-builder/components-material-ui

Introduction

The Tooltip component displays informative text when users hover over, focus on, or tap an element. It is commonly used to provide additional context, explanations, or instructions for UI elements. The component follows Material Design guidelines for tooltips with smooth animations and proper positioning.

The Tooltip component is based on Material UI Tooltip. It is included within the following NPM package: @react-form-builder/components-material-ui.

The Tooltip component can be styled and configured to fit specific design and functionality requirements by using various properties that are presented and described below.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Arrow	boolean	If true, an arrow will be shown pointing to the target element
Disable focus listener	boolean	If true, the tooltip won't appear on focus
Disable interactive	boolean	If true, the tooltip will not be interactive (won't close when hovering over the tooltip itself)
Disable hover listener	boolean	If true, the tooltip won't appear on hover
Disable touch listener	boolean	If true, the tooltip won't appear on touch
Follow cursor	boolean	If true, the tooltip will follow the cursor (mouse only)
Enter delay	number	Delay in milliseconds before the tooltip appears (default: 100ms)
Leave delay	number	Delay in milliseconds before the tooltip disappears (default: 0ms)
Placement	'bottom-end' | 'bottom-start' | 'bottom' | 'left-end' | 'left-start' | 'left' | 'right-end' | 'right-start' | 'right' | 'top-end' | 'top-start' | 'top'	The placement of the tooltip relative to the target element
Title	string | ReactNode	The text or content to display in the tooltip

At the bottom of the Main properties menu, you can find additional options:

• Render When: Provides conditional rendering for your component as described in the corresponding chapter.
• HTML attributes: Allows you to provide custom HTML attributes for your form.

Style properties

These are properties that allow to customize the size, color and other style properties of your component:

• For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.

• Component > Class Name: Add a class name for your component for the subsequent styling if necessary.

• Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:

  Name	Type	Description
  Width	number	Specifies the width for your component
  Height	number	Specifies the height for your component
  Margin top/right/bottom/left	number	Margin values for you component
  Color	string	Allows customizing the text color
  Background color	string	Enables customizing the background color