# @newhippo/react-joyride

> Create guided tours for your apps

Latest version **2.3.2** (published 2019-07-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @newhippo/react-joyride
pnpm add @newhippo/react-joyride
yarn add @newhippo/react-joyride
bun add @newhippo/react-joyride
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.3.2 |
| Published | 2019-07-16 |
| First published | 2019-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 11 |
| Unpacked size | 249.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7871 |
| Author | Gil Barbara |
| Maintainers | jason.roett, natechao, nealio, nigelzor, psisous, ye.li |
| Keywords | react, react-component, tooltips, joyride, walkthroughs, tour |

## Links

- npm: https://www.npmjs.com/package/@newhippo/react-joyride
- Repository: https://github.com/gilbarbara/react-joyride
- Homepage: https://gilbarbara.github.com/react-joyride/
- Issues: https://github.com/gilbarbara/react-joyride/issues
- npm.io page: https://npm.io/package/@newhippo/react-joyride

## Dependencies (11)

- [exenv](https://npm.io/package/exenv.md) ^1.2.2
- [scroll](https://npm.io/package/scroll.md) ^2.0.3
- [is-lite](https://npm.io/package/is-lite.md) ^0.2.2
- [react-is](https://npm.io/package/react-is.md) ^16.7.0
- [deep-diff](https://npm.io/package/deep-diff.md) ^1.0.2
- [deepmerge](https://npm.io/package/deepmerge.md) ^3.0.0
- [scroll-doc](https://npm.io/package/scroll-doc.md) ^0.2.1
- [scrollparent](https://npm.io/package/scrollparent.md) ^2.0.1
- [tree-changes](https://npm.io/package/tree-changes.md) ^0.4.0
- [react-floater](https://npm.io/package/react-floater.md) ^0.6.2
- [nested-property](https://npm.io/package/nested-property.md) ^0.0.7

## 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

- 2.3.2 (latest) — 2019-07-16
- 2.3.1 — 2019-07-16
- 2.2.1 — 2019-07-16
- 2.1.1 — 2019-07-16

## README

# React Joyride

[![](https://badge.fury.io/js/react-joyride.svg)](https://www.npmjs.com/package/react-joyride) [![](https://travis-ci.org/gilbarbara/react-joyride.svg)](https://travis-ci.org/gilbarbara/react-joyride) [![](https://api.codeclimate.com/v1/badges/43ecb5536910133429bd/maintainability)](https://codeclimate.com/github/gilbarbara/react-joyride/maintainability) [![](https://api.codeclimate.com/v1/badges/43ecb5536910133429bd/test_coverage)](https://codeclimate.com/github/gilbarbara/react-joyride/test_coverage)

[![Joyride example image](http://gilbarbara.com/files/react-joyride.png)](https://react-joyride.com/)

#### Create awesome tours for your app!

Showcase your app to new users or explain functionality of new features.  

It uses [react-floater](https://github.com/gilbarbara/react-floater) for positioning and styling.  
And you can use your own components too!

**View the demo [here](https://react-joyride.com/)**

**Read the [docs](https://docs.react-joyride.com/)**

## Setup

```bash
npm i react-joyride
```

## Getting Started

```jsx
import Joyride from 'react-joyride';

export class App extends React.Component {
  state = {
    steps: [
      {
        target: '.my-first-step',
        content: 'This is my awesome feature!',
      },
      {
        target: '.my-other-step',
        content: 'This another awesome feature!',
      },
      ...
    ]
  };

  render () {
    const { steps } = this.state;

    return (
      <div className="app">
        <Joyride
          steps={steps}
          ...
        />
        ...
      </div>
    );
  }
}
```

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