# react-hints

> This is a simple component to show floating hints highlighting product features.

Latest version **0.1.2** (published 2018-07-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-hints
pnpm add react-hints
yarn add react-hints
bun add react-hints
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-07-02 |
| First published | 2017-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 613.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Asad Memon |
| Maintainers | asadm |
| Keywords | react, reactjs, hint, react-hints |

## Links

- npm: https://www.npmjs.com/package/react-hints
- npm.io page: https://npm.io/package/react-hints

## Dependencies (1)

- [react-bootstrap](https://npm.io/package/react-bootstrap.md) ^0.31.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.1.2 (latest) — 2018-07-02
- 0.1.1 — 2017-08-02
- 0.1.0 — 2017-08-02
- 5.0.1 — 2017-08-02

## README

# React Hints

This is a simple component to show floating hints highlighting product features.

[**Online Demo**](https://asadmemon.com/react-hints/)

![](docs/demo.gif?raw=true)

### Installation

In your React project folder run:

```sh
npm install react-hints --save
```

### Usage

1. Import `react-hints` into your component.

   ```jsx
   import Hint from 'react-hints';
   ```

2. In your render, wrap some element with the `<Hint />` component. Here is a `<button />` wrapped:

   ```jsx
   <Hint
     id="hint-1"
     message="You can put the hint at any side of the element."
     position="top">
       <button className="btn btn-lg btn-default">
         Action!
       </button>
   </Hint>
   ```

3. Read more about what each prop means [here](https://asadmemon.com/react-hints/).

## License

*react-hints* is available under MIT. See LICENSE for more details.

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