Tooltip

Introduction

The Tooltip component is used to describe icon buttons. In some cases tooltips are used to show more content, this should be used cautiously since it is hard to be completely accessible.

Tooltip with IconButton

Each IconButton should always be wrapped in a Tooltip.

<Tooltip content="Edit title">
  <IconButton icon={EditIcon} />
</Tooltip>
<Tooltip content="Edit title">
  <IconButton icon={EditIcon} />
</Tooltip>
 Hide code

Tooltip to show some content

Use with caution, it’s hard to be completely accessible.

<Tooltip content="Learn more about a feature">
  <InfoSignIcon />
</Tooltip>
<Tooltip content="Learn more about a feature">
  <InfoSignIcon />
</Tooltip>
 Hide code

Tooltip with card appearance

Use with caution, it’s hard to be completely accessible.

<Tooltip
  content={
    <Paragraph margin={40}>Card appearance</Paragraph>
  }
  appearance="card"
>
  <InfoSignIcon />
</Tooltip>
<Tooltip
  content={
    <Paragraph margin={40}>Card appearance</Paragraph>
  }
  appearance="card"
>
  <InfoSignIcon />
</Tooltip>
 Hide code

Positioning the Tooltip

The Tooltip can be positioned on the following positions using the position prop:

• Position.TOP
• Position.TOP_LEFT
• Position.TOP_RIGHT
• Position.BOTTOM
• Position.BOTTOM_LEFT
• Position.BOTTOM_RIGHT
• Position.LEFT
• Position.RIGHT

For a Tooltip the only really useful sides are TOP, RIGHT, BOTTOM and LEFT as shown below.

<Pane display="flex" justifyContent="space-between">
  <Tooltip content="Top" position={Position.TOP}>
    <IconButton icon={ArrowUpIcon} />
  </Tooltip>
  <Tooltip content="Right" position={Position.RIGHT}>
    <IconButton icon={ArrowRightIcon} />
  </Tooltip>
  <Tooltip content="Bottom" position={Position.BOTTOM}>
    <IconButton icon={ArrowDownIcon} />
  </Tooltip>
  <Tooltip content="Left" position={Position.LEFT}>
    <IconButton icon={ArrowLeftIcon} />
  </Tooltip>
</Pane>
<Pane display="flex" justifyContent="space-between">
  <Tooltip content="Top" position={Position.TOP}>
    <IconButton icon={ArrowUpIcon} />
  </Tooltip>
  <Tooltip content="Right" position={Position.RIGHT}>
    <IconButton icon={ArrowRightIcon} />
  </Tooltip>
  <Tooltip content="Bottom" position={Position.BOTTOM}>
    <IconButton icon={ArrowDownIcon} />
  </Tooltip>
  <Tooltip content="Left" position={Position.LEFT}>
    <IconButton icon={ArrowLeftIcon} />
  </Tooltip>
</Pane>
 Hide code