https://github.com/transitive-bullshit/react-springy-scroll

React utility that adds a physical springiness to elements on scroll.
https://github.com/transitive-bullshit/react-springy-scroll

animation react spring

Last synced: 23 days ago
JSON representation

React utility that adds a physical springiness to elements on scroll.

• Host: GitHub
• URL: https://github.com/transitive-bullshit/react-springy-scroll
• Owner: transitive-bullshit
• Created: 2018-12-05T04:45:42.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-11T23:13:42.000Z (over 4 years ago)
• Last Synced: 2024-10-20T01:08:36.369Z (27 days ago)
• Topics: animation, react, spring
• Language: JavaScript
• Size: 2.89 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# react-springy-scroll ([demo](https://transitive-bullshit.github.io/react-springy-scroll/))

> React utility that adds a physical springiness to elements on scroll.

[![NPM](https://img.shields.io/npm/v/react-springy-scroll.svg)](https://www.npmjs.com/package/react-springy-scroll) [![Build Status](https://travis-ci.com/transitive-bullshit/react-springy-scroll.svg?branch=master)](https://travis-ci.com/transitive-bullshit/react-springy-scroll) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Demo](https://raw.githubusercontent.com/transitive-bullshit/react-springy-scroll/master/example/demo.gif)](https://transitive-bullshit.github.io/react-springy-scroll/)

## Install

```bash

npm install --save react-springy-scroll

```

## Usage

Check out the [demo](https://transitive-bullshit.github.io/react-springy-scroll/).

```jsx

import React, { Component } from 'react'

import Springy from 'react-springy-scroll'

export default class App extends Component {

  render () {

    return (

      

        
This div will move like a spring on scroll.

      

    )

  }

}


```

## Props

| Property    | Type             | Default  | Description |

|:------------|:-----------------|:---------|:------------|

| `children`    | `Node`  | **required** | Children element(s) to make add springiness to. |

| `...`       | ...              | undefined | Any other props are applied to the root element. |

## License

MIT © [Travis Fischer](https://github.com/transitive-bullshit)

Support my OSS work by following me on twitter