Skip to content

Commit d2e50cd

Browse files
authored
Merge pull request #9 from yama-dev/v0.2.0
V0.2.0
2 parents 44d51aa + 152f0be commit d2e50cd

File tree

6 files changed

+199
-197
lines changed

6 files changed

+199
-197
lines changed

README.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Add effect according to scroll.
1111
## Demo
1212

1313
- Document -> [https://yama-dev.github.io/js-scroll-effect-module/](https://yama-dev.github.io/js-scroll-effect-module/)
14-
- SamplePage -> [https://yama-dev.github.io/js-scroll-effect-module/sample/](https://yama-dev.github.io/js-scroll-effect-module/sample/)
14+
- ExamplePage -> [https://yama-dev.github.io/js-scroll-effect-module/examples/](https://yama-dev.github.io/js-scroll-effect-module/examples/)
1515

1616
<br>
1717

1818
## Installation,Download
1919

2020
- npm -> [https://www.npmjs.com/package/js-scroll-effect-module](https://www.npmjs.com/package/js-scroll-effect-module)
2121

22-
- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.1.4/dist/js-scroll-effect-module.js](https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.1.4/dist/js-scroll-effect-module.js)
22+
- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.2.0/dist/js-scroll-effect-module.js](https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.2.0/dist/js-scroll-effect-module.js)
2323

2424
- Zip -> [yama-dev/js-scroll-effect-module](https://github.com/yama-dev/js-scroll-effect-module/releases/latest)
2525

@@ -39,12 +39,49 @@ npm install --save-dev js-scroll-effect-module
3939
import SCROLL_EFFECT_MODULE from 'js-scroll-effect-module';
4040
```
4141

42-
### Basic Standalone Usage
42+
### Basic Use
4343

4444
``` html
4545
<link rel="stylesheet" href="./scroll-effect-module.css">
46-
<script src="./js-scroll-effect-module"></script>
47-
<script> new SCROLL_EFFECT_MODULE({ elem : '.effect_item' }); </script>
46+
<script src="./js-scroll-effect-module.js"></script>
47+
48+
<div class="js-scroll js-scroll__fadein-basic"></div>
49+
50+
<script> new SCROLL_EFFECT_MODULE({ elem : '.js-scroll' }); </script>
51+
```
52+
53+
### Advanced Use
54+
55+
``` html
56+
<link rel="stylesheet" href="./scroll-effect-module.css">
57+
<script src="./js-scroll-effect-module.js"></script>
58+
59+
<div class="js-scroll js-scroll__fadein-basic"></div>
60+
61+
<script>
62+
var ScrollEffectModule = new SCROLL_EFFECT_MODULE({
63+
elem : '.js-scroll',
64+
displayRatio : 0.8,
65+
displayReverse : true,
66+
firstElem : '.js-scroll--first',
67+
firstElemDelayTime : 300,
68+
firstDelayTime : 500,
69+
loadDelayTime : 0,
70+
addClassNameActive : 'is-active',
71+
on: {
72+
In: function(item, pos){
73+
console.log('In')
74+
console.log(item);
75+
console.log(pos);
76+
},
77+
Out: function(item, pos){
78+
console.log('Out')
79+
console.log(item);
80+
console.log(pos);
81+
}
82+
}
83+
});
84+
</script>
4885
```
4986

5087
<br>
@@ -69,7 +106,7 @@ import SCROLL_EFFECT_MODULE from 'js-scroll-effect-module';
69106

70107
## Dependencies
71108

72-
none
109+
[@yama-dev/js-dom](https://github.com/yama-dev/js-dom)
73110

74111
<br><br><br>
75112

dist/js-scroll-effect-module.js

Lines changed: 11 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)