React Native Walkthrough Tooltip

Much credit belongs to @jeanregisser and the react-native-popover library. Most of the animations and geometry computation belong to his library. Please check it out! It was an invaluable resource.

Tooltip

React Native Walkthrough Tooltip is a fullscreen modal that highlights whichever element it wraps.
When not visible, the wrapped element is displayed normally.

Breaking Changes in Version 1.0

For Version 1.0, the library was refactored and simplified.

• No more animated prop - if you want to have your tooltips animated, use the last stable version: 0.6.1. Hopefully animations can be added again in the sure (great idea for a PR!)
• No more displayArea and childlessPlacementPadding props - these have been replaced with the displayInsets prop, which allows you to simply declare how many pixels in from each side of the screen to inset the area the tooltip may display.
• Tooltips are now bound by the displayInsets - before if your content was larger than the displayArea prop, the tooltip would render outside of the display area. Now the tooltip should always resize to be inside the display area as defined by the displayInsets prop
• Removed the "auto" option for placement - you must now specify a direction
• Added the "center" option for childless placement - option to center the tooltip within the bounds of the displayInsets when it does not point to a child

Installation

yarn add react-native-walkthrough-tooltip

Example Usage

import Tooltip from 'react-native-walkthrough-tooltip';

<Tooltip
  isVisible={this.state.toolTipVisible}
  content={<Text>Check this out!</Text>}
  placement="top"
  onClose={() => this.setState({ toolTipVisible: false })}
>
  <TouchableHighlight style={styles.touchable}>
    <Text>Press me</Text>
  </TouchableHighlight>
</Tooltip>

Screenshot

How it works

The tooltip wraps an element in place in your React Native rendering. When it initially renders, it measures the location of the element in the window, utilizing React Native's measureInWindow. When the tooltip is displayed, it renders a copy of the wrapped element positioned absolutely on the screen at the coordinates returned after measuring. This allows you to touch the element in the tooltip modal rendered above your current screen.

Listening for touches on highlighted child element

Optionally, you can provide the props onChildPress or onChildLongPress to override any functionality of the current element, should you find that useful. More information on this can be found below.

Props

Style Props

The tooltip styles should work out-of-the-box for most use cases, however should you need you can customize the styles of the tooltip using these props.

Class definitions for props

• Size is an object with properties: { width: number, height: number }

onChildPress and onChildLongPress

When providing either of these functions, React Native Walkthrough Tooltip will wrap your entire child element in a touchable like so:

<TouchableWithoutFeedback onPress={onChildPress} onLongPress={onChildLongPress}>
  {childElement}
</TouchableWithoutFeedback>

NOTE: This will disable and override any touch events on your child element

One possible use case for these functions would be a scenerio where you are highlighting new functionality and want to restrict a user to ONLY do a certain action when they press on an element. While perhaps uncommon, this use case was relevant for another library I am working on, so it may be useful for you. When these props are NOT provided, all touch events on children occur as expected.

TooltipChildrenContext

React Context that can be used to distinguish "real" children rendered inside parent's layout from their copies rendered inside tooltip's modal. The duplicate child rendered in the tooltip modal is wrapped in a Context.Provider which provides object with prop tooltipDuplicate set to true, so informed decisions may be made, if necessary, based on where the child rendered.

import Tooltip, { TooltipChildrenContext } from 'react-native-walkthrough-tooltip';
...
<Tooltip>
  <ComponentA />
  <ComponentB>
    <TooltipChildrenContext.Consumer>
      {({ tooltipDuplicate }) => (
        // will only assign a ref to the original component
        <FlatList {...(!tooltipDuplicate && { ref: this.listRef })} />
      )}
    </TooltipChildrenContext.Consumer>
  </ComponentB>
</Tooltip>