Skip to content

Commit 9a011e0

Browse files
committed
adjust readme
1 parent b0a897d commit 9a011e0

File tree

1 file changed

+34
-43
lines changed

1 file changed

+34
-43
lines changed

README.md

Lines changed: 34 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Add effect according to scroll.
2020

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

23-
- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.11.2/dist/js-scroll-effect-module.js](https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.11.2/dist/js-scroll-effect-module.js)
23+
- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.13.2/dist/js-scroll-effect-module.js](https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.13.2/dist/js-scroll-effect-module.js)
2424

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

@@ -57,57 +57,48 @@ import SCROLL_EFFECT_MODULE from 'js-scroll-effect-module';
5757
<link rel="stylesheet" href="./scroll-effect-module.css">
5858
<script src="./js-scroll-effect-module.js"></script>
5959

60-
<div class="js-scroll"></div>
60+
<div data-scroll data-scroll-name="name-1"></div>
61+
62+
<div data-scroll data-scroll-name="name-2"></div>
6163

6264
<script>
63-
var ScrollEffectModule = new SCROLL_EFFECT_MODULE({
64-
elem : '.js-scroll',
65-
firstElem : '.js-scroll--first',
66-
67-
displayRatio : 0.8, // 判定する比率を指定(ウィンドウ高さを1として指定)
68-
displayReverse : true, // スクロールを戻した時にクラスを削除するかどうか
69-
70-
firstDelay : 0, // 初回動作までの遅延時間(ms)
71-
firstDelaySteps : 100, // 初回出現要素を指定した場合のステップ遅延時間(ms)
72-
73-
addClassNameActive : 'is-active', // null を設定するとクラスが付与されなくなる。
74-
75-
on: {
76-
Scroll: function(top){
77-
console.log('Scroll', top);
78-
},
79-
Change: function(item, pos){
80-
console.log('Change', item, pos);
81-
},
82-
In: function(item, pos){
83-
console.log('In', item, pos);
84-
},
85-
Out: function(item, pos){
86-
console.log('Out', item, pos);
87-
}
88-
}
89-
});
65+
const ScrollEffectModule = new SCROLL_EFFECT_MODULE({
66+
target : '[data-scroll]',
67+
classNameInview : 'is-active',
68+
69+
displayRatio : 0.8, // 判定する比率を指定(ウィンドウ高さを1として指定)
70+
displayReverse : false, // スクロールを戻した時にクラスを削除するかどうか
71+
displayRatioReverse: null,
72+
73+
firstDelay : 100, // 初回動作までの遅延時間(ms)
74+
75+
throttleInterval : 5,
76+
77+
autoStart : true,
78+
autoStartType : 'ready', // ready, load, scroll
79+
80+
on: {
81+
Change: function(obj, index, name){
82+
console.log('Change', obj, index, name);
83+
},
84+
In: function(obj, index, name){
85+
console.log('In', obj, index, name);
86+
},
87+
Out: function(obj, index, name){
88+
console.log('Out', obj, index, name);
89+
},
90+
Scroll: function(_y){
91+
console.log('Scroll', _y);
92+
},
93+
}
94+
});
9095
</script>
9196
```
9297

9398
## API
9499

95100
<br>
96101

97-
98-
## Browser support
99-
100-
| Browser | OS、version |
101-
| --- | --- |
102-
| Internet Explorer | 11+ |
103-
| Chrome | 最新 |
104-
| Firefox | 最新 |
105-
| Safari | 最新 |
106-
| Android | 4.4+ Chrome |
107-
| iOS | 8.0+ safari |
108-
109-
<br>
110-
111102
## Dependencies
112103

113104
[@yama-dev/js-dom](https://github.com/yama-dev/js-dom)

0 commit comments

Comments
 (0)