8000 Update README.md · bitnulleins/scrollEvent.js@ca4e2e5 · GitHub
[go: up one dir, main page]

Skip to content

Commit ca4e2e5

Browse files
authored
Update README.md
1 parent e88eae8 commit ca4e2e5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Simple and fast event listener for enter viewport in pure Java-Script. The featu
2323
```html
2424
<script type="text/javascript">
2525
ScrollEvent().visible(DOMElement, () => {
26-
// what should happen when DOMElement is visible?
26+
// Event that should happen when DOMElement is visible
2727
});
2828
</script>
2929
```
@@ -49,15 +49,15 @@ It is also possible with javascript libraries like jQuery, React.js, AngularJS o
4949

5050
Parameter | Description
5151
--- | ---
52-
**DOMElement** | An DOM element (HTML element), which is selected by a selector
53-
**Callback** | Action which should fire, when the viewport is reached by scrolling
52+
**DOMElement** | An HTML DOM element (as selector)
53+
**Callback** | A function (Event), called when element is visible
5454

5555
## Options
5656
Option | Description | Datatype | Default Value
5757
--- | --- | --- | ---
58-
**delay** | ... | Number | 0
59-
**repetition** | ... | Number | 1
60-
**fullyInView** | ... | Boolean | false
58+
**delay** | Delay time in ms, after event should fire | Number | 0
59+
**repetition** | Amount of repetition of the event | Number | 1
60+
**fullyInView** | Have the elemnt to be fully in view? | Boolean | false
6161

6262
## Install via npm
6363

0 commit comments

Comments
 (0)
0