# supscroll

> Library to enable scrolling carousel functionality like Google Top Stories.

Latest version **1.0.7** (published 2021-05-23) · ISC license · 0 weekly downloads

## Install

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

## 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 | 1.0.7 |
| Published | 2021-05-23 |
| First published | 2021-05-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | "super-scrolling", |
| Maintainers | xassuak |
| Keywords | "supercurl" |

## Links

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

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2021-05-23
- 1.0.6 — 2021-05-23
- 1.0.5 — 2021-05-23
- 1.0.4 — 2021-05-23
- 1.0.3 — 2021-05-23
- 1.0.2 — 2021-05-23
- 1.0.1 — 2021-05-23
- 1.0.0 — 2021-05-23

## README

# SupScroll - Library for Scrolling Carousel

##### Now implement scrolling carousel on your frontend apps quickly.

###### Current Version - v1.0.7

# Usage
This can be used in 2 ways
### Vanilla JS
- Add Script to your webpage using CDN -
```
    <script src="https://cdn.jsdelivr.net/npm/supscroll@1.0.4/script.js"></script>
```

- Add Styles to your page head using CDN
```
    <link 
        rel="stylesheet" 
        href="https://cdn.jsdelivr.net/npm/supscroll@1.0.4/carousel.css" 
    />
```

- Initiate Initializers
    ```
    // On DOMContentLoad complete
    document.addEventListener("DOMContentLoaded", function (event) {
        let elem = document.querySelector('.supscroll .supscroll-wrapper');
        supscroll(elem);
    });
    ```
### Using NPM Module
- Install package via npm or yarn
    ```
        // for npm 
            npm install supscroll
        // for yarn
            yarn add supscroll
    ```
- Import supscroll and styles into your file
    ```
        import { supscroll } from "supscroll";
        import 'supscroll/carousel.css';
    ```
    
### Common Step - 
- Add Markup to your frontend code, Supscroll expects markup like below
    ```
     <div class="supscroll">
        <div class="supscroll-wrapper">
            <a href="#">
               <!-- Your Custom HTML -->
            </a> // Repeat it n times
        </div>
    </div>
    ```
Note - For React this would be JSX and similar suited variations for other FE Frameworks 
<<<<<<< HEAD
Styles can be overrided using external in-app stylesheets
=======
>>>>>>> 5f744c4d0d69fc97c31502b1b1c1a1bc27444b23

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