@galangel/react-scroll-magic

Scroll Component

Live Demo

Overview

The Scroll Magic Component is a React component that provides smooth scrolling functionality for your web application. It allows you to create scroll between items and headers and keep the headers visible.

Features

• sticky headers in both directions
• scroll to header by click
• typescript

Installation

To install the Scroll Component, use npm or yarn:

npm install react-scroll-magic

or

yarn add react-scroll-magic

Usage

Here is a basic example of how to use the Scroll Component in your React application:

import React from 'react';
import { ScrollComponent } from 'react-scroll-magic';

const App = () => {
  return (
    <Scroll>
      <Scroll.Header>
        <h1>Scroll down to see the magic!</h1>
      </Scroll.Header>
      <Scroll.Item>
        <p>Keep scrolling...</p>
      </Scroll.Item>
    </Scroll>
  );
};

export default App;

Props

The Scroll Component accepts the following props:

Prop	Type	Description
stickTo	top|bottom|all	how headers should stick
scrollBehavior	scrollBehavior CSS property	how the scrolling should behave when clicking a header

Wishlist

Scroll

• Virtualized scrolling
• Snap scrolling
• Horizontal scrolling support
• Scroll shadow
• Maximum number of sticky items
• Stacking headers
• Collapse header items
• Scroll to item scroll via code

Repo management

• Better tests
• Better looking doc site with more (interactive) examples
• Changelog file
• Enforce code style using eslint
• Ensure support for popular frameworks or libraries

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please read the CONTRIBUTING guidelines before submitting a pull request.

Contact

For any questions or feedback, please open an issue on GitHub.