# react-swap-animation

> Swap animation for React

Latest version **16.1.0** (published 2017-11-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-swap-animation
pnpm add react-swap-animation
yarn add react-swap-animation
bun add react-swap-animation
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 16.1.0 |
| Published | 2017-11-07 |
| First published | 2016-11-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Thomas Heymann |
| Maintainers | cyberthom |

## Links

- npm: https://www.npmjs.com/package/react-swap-animation
- Repository: https://github.com/cyberthom/react-swap-animation
- Homepage: https://github.com/cyberthom/react-swap-animation#readme
- Issues: https://github.com/cyberthom/react-swap-animation/issues
- npm.io page: https://npm.io/package/react-swap-animation

## Dependencies (3)

- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.0
- [react-delegate-transition-group](https://npm.io/package/react-delegate-transition-group.md) ^16.0.0

## Recent versions

- 16.1.0 (latest) — 2017-11-07
- 16.0.0 — 2017-08-22
- 15.5.0 — 2017-04-25
- 15.5.0-alpha.1 — 2017-04-25
- 0.14.1 — 2016-11-15
- 0.14.0 — 2016-11-14

## README

# React Swap Animation

Swap animation for React. Useful to smoothly swap blocks of content with varying heights. 

Note: Due to the nature of the effect `SwapAnimation` only animates a single child. If you want to animate items in a list use [react-slide-animation](https://github.com/cyberthom/react-slide-animation) instead. 


## Installation

```
npm install --save react-swap-animation
```


## Usage

```JavaScript
import SwapAnimation from 'react-swap-animation';

const Message = ({ message }) => (
    <SwapAnimation animationEnterTimeout={300} animationLeaveTimeout={300}>
        {!message ? <Spinner key="spinner" /> : <Text key="message">{message}</Text>}
    </SwapAnimation>
);

export default Message;
```



## Build

Import styles using [PostCSS Import Plugin](https://github.com/postcss/postcss-import) (e.g. in your `main.css`):

```CSS
@import "react-swap-animation";
```

Or manually add `react-swap-animation/lib/index.css` to your webpack entry config.


## Reference

* `children` - **Required.** Single child that animates when swapped. 

    **You must provide the `key` attribute for all children of `SwapAnimation`.** This is how React determines which child has entered, left, or stayed.

* `animationEnterTimeout` - **Required.** Duration of transition for child entering.

* `animationLeaveTimeout` - **Required.** Duration of transition for child leaving.

* `component` - Component used for rendering. *(default: 'div')*

    Can be a string (DOM component) or any user defined component:

    ```
    <SwapAnimation component={CustomContainer}>
        {/* ... */}
    </SwapAnimation>
    ```

    Additional properties to `SwapAnimation` will become properties of the rendered component:

    ```
    <SwapAnimation className="example" style={{ border: '1px solid black' }}>
        {/* ... */}
    </SwapAnimation>
    ```

* `animationName` - Prefix used to construct CSS class names. *(default: 'swap-animation')*

    Can be used to create custom animation effects:

    - `{animationName}` - Applied to container when child is swapped
    - `{animationName}-active` - Applied to container on next tick
    - `{animationName}-enter` - Applied to entering child during swap
    - `{animationName}-enter-active` - Applied to entering child on next tick
    - `{animationName}-leave` - Applied to leaving child during swap
    - `{animationName}-leave-active` - Applied to leaving child on next tick

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