beauty-scroll-container

beauty-scroll-container

pkg.module supported, which means that you can apply tree-shaking in you project

中文文档

A react component that provider a beauty scroll container

repository

[e-mail]:livelybone/beauty-scroll-container.git

Demo

https://github.com/livelybone/beauty-scroll-container

Run Example

you can see the usage by run the example of the module, here is the step:

1. Clone the library git clone [e-mail]:livelybone/beauty-scroll-container.git
2. Go to the directory cd [the-module-directory]
3. Install npm dependencies npm i(use taobao registry: npm i --registry=http://registry.npm.taobao.org)
4. Open service npm run dev
5. See the example(usually is http://127.0.0.1:3000/examples/test.html) in your browser

Installation

npm i -S beauty-scroll-container

Global name - The variable the module exported in umd bundle

BeautyScrollContainer

Interface

See what method or params you can use in index.d.ts

Usage

import BeautyScrollContainer from 'beauty-scroll-container'

const Comp = () => {
    return (
      <BeautyScrollContainer style={{ width: '100vw', height: '100vh' }}>
        <div style={{ width: '200vw', height: '200vh' }}></div>
      </BeautyScrollContainer>
    )
}

CDN

Use in html, see what you can use in CDN: unpkg

<-- use what you want -->
<script src="https://unpkg.com/beauty-scroll-container/lib/umd/<--module-->.js"></script>

Or，see what you can use in CDN: jsdelivr

<script src="https://cdn.jsdelivr.net/npm/beauty-scroll-container/lib/umd/<--module-->.js"></script>

style

For building style, you may need to import the css or scss file:

// scss
import 'beauty-scroll-container/lib/css/index.scss'

// css
import 'beauty-scroll-container/lib/css/index.css'

Or

// scss
@import '~beauty-scroll-container/lib/css/index.scss'

// css
@import '~beauty-scroll-container/lib/css/index.css'

Or, you can build your custom style by copying, editing and importing node_modules/beauty-scroll-container/lib/css/index.scss

QA

1. Error Error: spawn node-sass ENOENT

You may need install node-sass globally, npm i -g node-sass