react-custom-scroll
Advanced tools
Comparing version 4.0.1 to 4.0.2
{ | ||
"name": "react-custom-scroll", | ||
"version": "4.0.1", | ||
"version": "4.0.2", | ||
"description": "An easily designable, cross browser (!!), custom scroll with ReactJS Animations and scroll rate **exactly** like native scroll", | ||
@@ -5,0 +5,0 @@ "main": "index", |
@@ -10,3 +10,3 @@ [![NPM version][npm-image]][npm-url] | ||
## Installation | ||
``` | ||
```sh | ||
npm i react-custom-scroll --save | ||
@@ -25,4 +25,4 @@ ``` | ||
**From unpkg cdn:** | ||
* [Js file](https://unpkg.com/react-custom-scroll@4.0.0/dist/reactCustomScroll) | ||
* [css file](https://unpkg.com/react-custom-scroll@4.0.0/dist/customScroll.css) | ||
* [Js file](https://unpkg.com/react-custom-scroll@4.0.1/dist/reactCustomScroll) | ||
* [css file](https://unpkg.com/react-custom-scroll@4.0.1/dist/customScroll.css) | ||
@@ -33,7 +33,7 @@ Wrap your content with the custom scroll component | ||
``` | ||
```js | ||
import CustomScroll from 'react-custom-scroll'; | ||
``` | ||
```jxs | ||
```jsx | ||
<CustomScroll> | ||
@@ -69,3 +69,3 @@ your content | ||
```jxs | ||
```jsx | ||
<CustomScroll heightRelativeToParent="calc(100% - 20px)"> | ||
@@ -89,9 +89,10 @@ your content | ||
Here is an example for an HTML structure before using customScroll: | ||
```jxs | ||
<someParent style="display: flex; height: 500px;"> | ||
<fixedHeightElement style="height: 100px"><fixedHeightElement/> | ||
<flexibleHeightElement style="flex:1; overflow:scroll"> | ||
your content (with enough height to cause a scroll) | ||
<flexibleHeightElement/> | ||
</someParent> | ||
```jsx | ||
<SomeParent style="display: flex; height: 500px;"> | ||
<FixedHeightElement style="height: 100px"><FixedHeightElement /> | ||
<FlexibleHeightElement style="flex:1; overflow:scroll"> | ||
your content (with enough height to cause a scroll) | ||
<FlexibleHeightElement /> | ||
</SomeParent> | ||
``` | ||
@@ -107,3 +108,4 @@ | ||
Instead, min-height and min-width should be set to 0. | ||
```jxs | ||
```jsx | ||
<someParent style="display: flex; height: 500px;"> | ||
@@ -118,6 +120,8 @@ <fixedHeightElement style="height: 100px"><fixedHeightElement/> | ||
``` | ||
min-height and min-width are required since flex won't shrink below it's minimum content size ([flex box spec](https://www.w3.org/TR/css-flexbox/#flex-common)). | ||
- Replacing the flex-size element with customScroll | ||
```jxs | ||
```jsx | ||
<someParent style="display: flex; height: 500px;"> | ||
@@ -131,3 +135,2 @@ <fixedHeightElement style="height: 100px"><fixedHeightElement/> | ||
### Contributing | ||
@@ -138,3 +141,3 @@ To build the project in watch mode, run 'npm run develop' or 'yarn develop'. | ||
### Tests | ||
```bash | ||
```sh | ||
npm install | ||
@@ -141,0 +144,0 @@ npm test |
@@ -12,3 +12,4 @@ const path = require('path') | ||
library: 'ReactCustomScroll', | ||
libraryTarget: 'umd' | ||
libraryTarget: 'umd', | ||
globalObject: 'typeof self !== \'undefined\' ? self : this' | ||
}, | ||
@@ -15,0 +16,0 @@ module: { |
Sorry, the diff of this file is not supported yet
523787
2493
148