https://github.com/jonath-z/react-z-scroll

React scroll library built on top of skrollr library
https://github.com/jonath-z/react-z-scroll

npm-package react react-skrollr scroll skrollr

Last synced: 23 days ago
JSON representation

React scroll library built on top of skrollr library

• Host: GitHub
• URL: https://github.com/jonath-z/react-z-scroll
• Owner: Jonath-z
• Created: 2023-01-11T14:23:26.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T09:55:58.000Z (almost 2 years ago)
• Last Synced: 2024-12-07T03:52:36.373Z (30 days ago)
• Topics: npm-package, react, react-skrollr, scroll, skrollr
• Language: JavaScript
• Homepage: https://github.com/Jonath-z/react-z-scroll#readme
• Size: 1.01 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# react-z-scroll

> Made with create-react-library

react-z-scroll is a react scroll library built on top of [skrollr](https://github.com/Prinzhorn/skrollr).

[![NPM](https://img.shields.io/npm/v/react-z-scroll.svg)](https://www.npmjs.com/package/react-z-scroll) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## DEM0

[react-z-scroll demo](https://react-z-scroll-demo-butik004.vercel.app)

## Install

```bash

npm install --legacy-peer-deps react-z-scroll

```

## Usage

Add `ScrollProvider` into root app

```jsx

import React, { Component } from 'react'

import { ScrollProvider } from 'react-z-scroll'

const myApp = () => {

     return (

      

      ...

      

    )

}

```

### Setting Scene data (Required)

Use data scrolling via props `data` (props type is object)

Skrollr [_Data attr document_](https://github.com/Prinzhorn/skrollr#absolute-vs-relative-mode)

```js

const Component = () => {

  return (

    

      Some content

    

  )

}

```

## License

MIT © [Jonath-z](https://github.com/Jonath-z)