To implement Tooltip component into your project you'll need to add the import:

import Tooltip from "@kiwicom/orbit-components/lib/Tooltip";

After adding import into your project you can use it simply like:

<Tooltip content="Your content">
  <Airplane />
</Tooltip>

Props

Table below contains all types of the props available in the Tooltip component.

Name Type Default Description
dataTest string Optional prop for testing purposes.
children React.Node The reference element where the Tooltip will appear.
content React.Node The content to display in the Tooltip.
preferredPosition enum The preferred position to choose See Functional specs
size enum The maximum possible size of the Tooltip.
closeText Translation The text of the close button to display on mobile devices.
tabIndex string "0" Specifies the tab order of an element

enum

position size
"right" "small"
"left" "medium"
"top"
"bottom"

Functional specs

  • Whenever event onMouseEnter, onFocus or onClick fires, the script inside this component will calculate possible positions that can be applied and the first possible will be applied.

  • You can prefer one position that will be used if possible, otherwise the default order in enum table will be used.

  • For mobile devices, the user needs to click on the children to open the Tooltip.

  • The Tooltip component supports rendering of many different components inside its children. You can use combination of e.g. Text, Stack, List and custom image to show information to user about the CVV code. All rendered text inside the Tooltip should have white color on big devices (>= largeMobile) automatically:

    <Tooltip
    content={
      <Stack>
        <CustomImage />
        <Text>
          You can find the CVV in the right corner of your credit card.
        </Text>
        <List>
          <ListItem>
            Additional information
          </ListItem>
        </List>
      </Stack>
    }
    >
    <InformationCircle />
    </Tooltip>
  • If you use Tooltip inside Alert, the Text should be automatically underlined with dotted line colored into the color of Alert.

  • For ensuring that Tooltip component will work properly, add div with id set to tooltips. If not, the Tooltip will be rendered into the end of your DOM.