PaulMest / react-native-tooltip

A react-native wrapper for showing tooltips

react-native-tooltip

A react-native component from displaying tooltip. Uses UIMenuController.

Add it to your project

1. Run npm install react-native-tooltip --save
2. Open your project in XCode, right click on Libraries and click Add Files to "Your Project Name" (Screenshot) then (Screenshot).
3. Add libRNToolTipMenu.a to Build Phases -> Link Binary With Libraries (Screenshot).
4. Whenever you want to use it within React code: var ToolTip = require('react-native-tooltip');

Usage

Props

• actions: Array of actions [{text: 'Copy', onPress: () => Clipboard.set(this.someValue) }]
• longPress: Boolean indicating if the tooltip should be showing on longPress, false by default.
• arrowDirection: String indicating the direction of the tooltip arrow. Possible values are: up, down, left, and right. Default is down.

Props from TouchableHighlight.propTypes

• activeOpacity
• onHideUnderlay
• onShowUnderlay
• style
• underlayColor

You can see the list on the react native website

Example

var React = require('react-native');
var {
  AppRegistry,
  StyleSheet,
  PixelRatio,
  View,
  Text,
} = React;
var createReactClass = require('create-react-class');

var ToolTip = require('react-native-tooltip');

var tooltip = createReactClass({
  getInitialState: function() {
    return {
      input: 'chirag',
    }
  },
  render: function() {
    return (
      <View style={styles.container}>
        <View style={styles.textinputContainer}>
          <ToolTip
            ref='theToolTip'
            actions={[
              {text: 'x', onPress: () => { this.setState({input: 'x pressed'}) }},
              {text: 'y', onPress: () => { this.setState({input: 'y pressed'}) }}
            ]}
            underlayColor='transparent'
            longPress={true}
            arrowDirection='down'
            style={styles.textinput}
          >
            <Text>
              {this.state.input}
            </Text>
          </ToolTip>
        </View>
      </View>
    );
  }
});

var styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#F5FCFF',
  },
  textinputContainer: {
    marginTop: 20,
    justifyContent: 'center',
    alignItems: 'center',
  },
  textinput: {
    width: 60,
    marginVertical: 2,
    marginHorizontal: 2,
    borderWidth: 1 / PixelRatio.get(),
    borderRadius: 5,
    borderColor: '#c7c7cc',
    padding: 2,
    fontSize: 14,
    backgroundColor: 'white',
  },
});

AppRegistry.registerComponent('tooltip', () => tooltip);

Note

It is also possible to open the menu programmatically, by calling this.refs.theToolTip.showMenu(); ( theToolTip being the reference of the component). To hide menu this.refs.theToolTip.hideMenu(); (Though tooltip hides by itself, while using with drawer on specific gesture tooltip does not hide by default.)

Here is how it looks:

Special thanks

Special thanks to jrichardlai for refactoring the api and make it awesome.