# playful

> A simple transition library for React (and routers!)

Latest version **0.0.4** (published 2019-02-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install playful
pnpm add playful
yarn add playful
bun add playful
```

## 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.4 |
| Published | 2019-02-10 |
| First published | 2019-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jon Quach |
| Maintainers | itsjonq |
| Keywords | react, router, transition, motion, playful, animation, anime, animejs |

## Links

- npm: https://www.npmjs.com/package/playful
- Repository: https://github.com/itsjonq/playful
- Homepage: https://github.com/itsjonq/playful#readme
- Issues: https://github.com/itsjonq/playful/issues
- npm.io page: https://npm.io/package/playful

## Dependencies (2)

- [@helpscout/motion](https://npm.io/package/@helpscout/motion.md) 0.0.5
- [@helpscout/react-utils](https://npm.io/package/@helpscout/react-utils.md) ^2.0.1

## Alternatives

- [@luma.gl/experimental](https://npm.io/package/@luma.gl/experimental.md) — 77.1K weekly downloads
- [persona-harness](https://npm.io/package/persona-harness.md) — 4.7K weekly downloads
- [@tsparticles/effect-bubble](https://npm.io/package/@tsparticles/effect-bubble.md) — 4.6K weekly downloads
- [f3d](https://npm.io/package/f3d.md) — 730 weekly downloads
- [spark-html-motion](https://npm.io/package/spark-html-motion.md) — 298 weekly downloads

## Recent versions

- 0.0.4 (latest) — 2019-02-10

## README

# ▶️ Playful

> A simple transition library for React (and routers!)

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Installation](#installation)
- [Usage](#usage)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installation

```
npm install --save playful
```

## Usage

```jsx
import {withTransition} from 'playful'

// Create your components as you normally would
const MyComponent = () => <div>My Content</div>

// Define the effect you'd like your component to animate with when it is
// mounted and unmounted. Technically, you don't need to do this.
// The library has some nice smart defaults.
const playOptions = {
  effect: 'fadeAndPop',
  duration: 600,
  direction: 'up',
}

// Create the enhanced component using withTransition along with your
// options and component.
const PlayfulComponent = withTransition(playOptions)(MyComponent)

// Render it out! ✨
const App = () => {
  return (
    <div className="App">
      <PlayfulComponent />
    </div>
  )
}
```

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