# react-native-help-bubbles

> Help bubbles for react native.

Latest version **0.0.6** (published 2017-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-help-bubbles
pnpm add react-native-help-bubbles
yarn add react-native-help-bubbles
bun add react-native-help-bubbles
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2017-11-30 |
| First published | 2017-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Marcel Gläser |
| Maintainers | ibeekeeper |
| Keywords | react-native, react, ios, help, bubble |

## Links

- npm: https://www.npmjs.com/package/react-native-help-bubbles
- Repository: https://github.com/marcelglaeser/react-native-help-bubbles
- Homepage: https://github.com/marcelglaeser/react-native-help-bubbles#readme
- Issues: https://github.com/marcelglaeser/react-native-help-bubbles/issues
- npm.io page: https://npm.io/package/react-native-help-bubbles

## Dependencies (1)

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) ^1.1.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2017-11-30
- 0.0.2 — 2017-08-30
- 0.0.1 — 2017-08-30

## README

# react-native-help-bubbles

Inspired by https://github.com/liuzheng644607/react-native-intro

# Install
Run ```npm install react-native-help-bubbles --save```

# Usage
```
import HelpBubbles, { helpbubbles } from 'react-native-help-bubbles';

<HelpBubbles group="firstStart" content={'I will help you!'} step={1}/>

.....

componentDidMount() {

    var helpbubbles = helpbubbles({group:'firstStart'});
    helpbubbles.start();

}

```

### Properties

#### Basic

| Prop  | Default  | Type | Description |
| :------------ |:---------------:| :---------------:| :-----|
| showStepNum | true | `bool` | If `true`, the number tip will be shown. |
| stopBtnTitle | stop | `string` | Props to translate the Stop button. |
| nextBtnTitle | next | `string` | Props to translate the Next button. |
| prevBtnTitle | prev | `string` | Props to translate the Prev button. |
| checkDisableEvent | - | `fnc` | Function to check if this bubble disabled. (Has the user seen this bubble before? (Need your own implemention.)) |
| willViewEvent | - | `fnc` | Function will called before the bubble appeared. |
| didViewEvent | - | `fnc` | Function will called after the bubble appeared. |
| cancelEvent | - | `fnc` | Function will called if the user canceled the bubbles. |

#### Custom basic style & content

| Prop  | Default  | Type | Description |
| :------------ |:---------------:| :---------------:| :-----|
| customToolTipStyle | - | `style` | Tooltip style. |
| customArrowStyle | - | `style` | Arrow style. |

# Warning
 *This Component does not support your component Wrapped by `Redux connect` currently;*

---
_Source: https://npm.io/package/react-native-help-bubbles · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._