carbon: TooltipDefinition no longer supports Nodes for tooltipText prop

TooltipDefinition no longer supports Nodes for tooltipText prop

What package(s) are you using?

  • carbon-components
  • carbon-components-react

Detailed description

Describe in detail the issue you’re having.

The TooltipDefinition component no longer supports Node objects for the tooltipText prop. It now only supports strings. This is a breaking change within major version 10. It came in here: https://github.com/carbon-design-system/carbon/commit/2571ed5051a45a335796365fe09f74e419d07192#diff-916183444c3885c676548407d734df75R74

We were using the Node structure to allow multiple DOM nodes within the tooltip, so we could apply alignment and styling to the text. This is no longer possible with only being able to supply strings.

For example, this is how we used TooltipDefinition’s support of Node objects in the tooltipText prop previously: image

Note the bold formatting, and alignment of the tooltip text content.

Is this issue related to a specific component?

TooltipDefinition

What did you expect to happen? What happened instead? What would you like to see changed?

I expected continued support of PropTypes.Node for the tooltipText prop.

What browser are you working in?

Chrome

What version of the Carbon Design System are you using?

carbon-components: 10.4.1 carbon-components-react: 7.4.1

What offering/product do you work on? Any pressing ship or release dates we should be aware of?

IBM Cloud Identity

Steps to reproduce the issue

Render a TooltipDefinition using a Node object for the tooltipText prop instead of a string.

Please create a reduced test case in CodeSandbox

Additional information

  • Screenshots or code
  • Notes

About this issue

  • Original URL
  • State: closed
  • Created 5 years ago
  • Comments: 15 (12 by maintainers)

Most upvoted comments

@asudoh IIRC the move from node to string is in line with the recommended use case for definition tooltips as @elizabethsjudd pointed out. that being said I believe we can reimplement support for nodes in tooltipText for the time being and flesh out migration paths to interactive tooltip for this kind of use case