• Stars
    star
    267
  • Rank 148,516 (Top 4 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created over 6 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

React Native: Native Tooltip View

PRs Welcome

ReactNative: Native Tooltips (Android/iOS)

If this project has helped you out, please support us with a star 🌟

This library is a React Native bridge around native tooltips. It allows you to create simple tip views.

Android: florent37/ViewTooltip
iOS: calm/SexyTooltip

πŸ“– Getting started

$ yarn add react-native-tooltips

RN60 >= RNT V1 >

RN60 above please use react-native-tooltips V1 and above

  • iOS

iOS Prerequisite: Please make sure CocoaPods is installed on your system

- Add the following to your `Podfile` -> `ios/Podfile` and run pod update:
  pod 'SexyTooltip',:git => 'https://github.com/prscX/SexyTooltip.git'

  use_native_modules!

  pod 'RNTooltips', :path => '../node_modules/react-native-tooltips/ios'
  • Android

RN60 < RNT V1 <

RN60 below please use react-native-tooltips V.0.*

$ react-native link react-native-tooltips

  • Android

Please add below snippet into your app build.gradle


buildscript {
    repositories {
        jcenter()
        maven { url "https://maven.google.com" }
		...
    }
	...
}


allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
		maven { url "https://maven.google.com" }
		...
    }
}

Note: Android SDK 27 > is supported

  • iOS

    • After react-native link react-native-tooltips, please verify node_modules/react-native-tooltips/ios/ contains Pods folder. If does not exist please execute pod install command on node_modules/react-native-tooltips/ios/, if any error => try pod repo update then pod install

πŸ’» Usage

import RNTooltips from 'react-native-tooltips';
  • React Way
<RNTooltips text={"Long Press Description"} visible={this.state.visible} target={this.state.target} parent={this.state.parent} />
  • API Way
RNTooltips.Show(
    this.state.target,
    this.state.parent,
    {
        text: 'Long Press Description'
    }
)

πŸ’‘ Props

  • Props: Generic
Prop Type Default Note
text string Text which needs to be displayed
autoHide bool Should tip view get auto dismiss
duration number Duration after which tooltip view should be dismissed
clickToHide bool On click should tooltip view be dismissed
corner number Radius of corner
tintColor string Color of tooltip view background
textColor string Color of text
textSize number Size of text displayed
gravity number Gravity of text
visible bool Should tooltip be displayed
shadow bool Shadow on tooltip view
arrow bool true Display Arrow
target object Reference of react component of which you need the tooltip
parent object Reference of the parent component of which you need the tooltip to fit in
onHide func Callback function invoked on tooltip hide
  • Props - iOS
Prop Type Default Note
  • Props - Android
Prop Type Default Note
position number Position of the tooltip view. On iOS it is auto adjustable
align number Alignment of tooltip

✨ Credits

πŸ€” How to contribute

Have an idea? Found a bug? Please raise to ISSUES. Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

πŸ’« Where is this library used?

If you are using this library in one of your projects, add it in this list below. ✨

πŸ“œ License

This library is provided under the Apache 2 License.

RNTooltips @ prscX

πŸ’– Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like πŸš€

  • If you're feeling especially charitable, please follow prscX on GitHub.

    Buy Me A Coffee

    Thanks! ❀️
    prscX.github.io
    </ Pranav >

More Repositories

1

react-native-photo-editor

React Native: Native Photo Editor
Java
1,102
star
2

react-native-bottom-action-sheet

React Native: Native Bottom Action Sheet
JavaScript
634
star
3

react-native-app-tour

React Native: Native App Tour Library
Objective-C
621
star
4

react-native-spruce

React Native Bridge for Native Spruce Animation Library
JavaScript
532
star
5

react-native-popover-menu

React Native: Native Popover Menu
JavaScript
479
star
6

awesome-react-native-native-modules

A curated list of Awesome ReactNative: Native Modules Guidelines/Components/News/Tools/Learning Materials
437
star
7

react-native-shine-button

React Native: Native Shine Button - Effects like shining
Java
357
star
8

react-native-file-selector

React Native: Native File Selector
Java
306
star
9

react-native-iconic

React Native - Native Animated Icons with different states
Java
223
star
10

react-native-fluidic-slider

React Native: Native Fluidic Slider
Objective-C
196
star
11

react-native-styled-dialogs

React Native: Native Styled Dialogs
Objective-C
174
star
12

react-native-morphing-text

React Native: Native Morphing Text
Swift
160
star
13

react-native-toasty

React Native: Native Toast
JavaScript
156
star
14

react-native-siri-wave-view

React Native: Native Siri Wave View
Objective-C
145
star
15

react-native-download-button

React Native: Native Download Button: with pretty cool animation
Java
123
star
16

react-native-lock-screen

React Native: Lock Screen
JavaScript
114
star
17

react-native-selection-menu

React Native: Native Selection Menu
Java
110
star
18

react-native-voice-recorder

React Native: Native Audio Recorder View
Java
93
star
19

react-native-notification-banner

React Native: Native Notification Banner
JavaScript
90
star
20

react-native-material-shadows

React Native: Native Material Shadows
Java
86
star
21

PXSiriWave9

iOS: Siri Waveform effect similar to 9
Objective-C
64
star
22

react-native-chip-view

React Native: Material Chip View
JavaScript
43
star
23

react-native-number-selector

ReactNative: Native Number Picker
Java
39
star
24

react-native-number-stepper

ReactNative: Number Stepper
JavaScript
35
star
25

react-native-richtext

React Native: Native Rich Text Editor
Swift
31
star
26

prettier-pack

Prettier + ESLint + Husky + Lint + Flow + React + React Native
JavaScript
31
star
27

react-native-about-libraries

React Native: It offers information about install packages
JavaScript
31
star
28

react-native-easy-permissions

React Native: Native Easy Permissions
Objective-C
31
star
29

react-native-file-type

React Native: Detect the file type of a Buffer/Uint8Array by reading from Local Storage
Java
27
star
30

react-native-text-switch

ReactNative: Native Text Switch
Objective-C
26
star
31

vs-essential-plugins

Essential Prepackaged VSCode Plugins for ReactNative
JavaScript
25
star
32

react-native-bottom-sheet-text-view

React Native: Native Bottom Sheet - Text View
Objective-C
22
star
33

react-native-add-shortcuts

React Native: Native Add Shortcuts
Java
21
star
34

PXMultiSelector.iOS

iOS: Multi Selector List
20
star
35

react-native-local-authenticate

React Native: Local Authentication
Java
15
star
36

react-native-image-helper

React Native: Native Image Helper
Java
9
star
37

pod-installer

POD Installer
JavaScript
6
star
38

react-native-whats-new

React Native: Native Whats New Kit
Java
6
star
39

simplified-promise

Enhance Simplicity of JS Promise
JavaScript
4
star
40

BottomSheetTextView.iOS

Android - BottomSheet TextView
Objective-C
2
star
41

BottomSheetTextView.Android

Android - BottomSheet TextView
Java
1
star
42

prscX.github.io

prscX Profile Page
CSS
1
star