Skip to content

Repository files navigation

react-native-tooltip

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

Installation

Mostly automatic installation

  1. Add this to your dependencies in package.json: "react-native-tooltip": "git+https://github.com/blockfirm/react-native-tooltip.git"
  2. Run npm install
  3. React Native 0.60+: $ cd ios && pod install
    React Native <0.60: $ react-native link react-native-tooltip

Manual installation

  1. Add this to your dependencies in package.json: "react-native-tooltip": "git+https://github.com/blockfirm/react-native-tooltip.git"
  2. Run npm install
  3. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  4. Go to node_modulesreact-native-tooltip and add ToolTipMenu.xcodeproj
  5. In XCode, in the project navigator, select your project. Add libToolTipMenu.a to your project's Build PhasesLink Binary With Libraries
  6. Run your project (Cmd+R)

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, right, and default. Default is default, which means to point up or down at the object of focus based on its location on the screen.

Props from TouchableHighlight.propTypes

  • activeOpacity
  • onHideUnderlay
  • onShowUnderlay
  • style
  • underlayColor

You can see the list on the react native website

Example

importReactfrom'react';import{AppRegistry,StyleSheet,PixelRatio,View,Text,}from'react-native';importToolTipfrom'react-native-tooltip';exportdefaultclassMyToolTipextendsReact.Component{state={input: 'chirag'};handleCopyPress=()=>{AlertIOS.alert(`Copy has been pressed!`);};handleOtherPress=()=>{AlertIOS.alert(`Other has been pressed!`);};handleHide=()=>{console.log('Tooltip did hide');};handleShow=()=>{console.log('tooltip did show');};render(){return(<Viewstyle={{flex: 1,justifyContent: 'center'}}><ToolTipref='tooltip'actions={[{text: 'Copy',onPress: this.handleCopyPress},{text: 'Other',onPress: this.handleOtherPress}]}onHide={this.handleHide}onShow={this.handleShow}underlayColor={'blue'}style={styles.selectedName}><Textstyle={styles.welcome}>
Press Here.
</Text></ToolTip></View>);}}conststyles=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:

Demo gif

Special thanks

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

About

A react-native wrapper for showing tooltips

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages