Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

Commit

Permalink
fix(readme): fix 'element' examples
Browse files Browse the repository at this point in the history
  • Loading branch information
davidpa9708 committed Jan 19, 2019
1 parent 977c617 commit 2017282
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,35 +173,35 @@ The objective of this element is to unify the properties of the `window` and of
### size
```js
scrollManager.size.x
scrollManager.size.y
scrollManager.element.size.x
scrollManager.element.size.y
```
This is the size of the container, may it be the `window`, or the (div)element used to instantiate the scrollManager
### scrollSize
```js
scrollManager.scrollSize.x
scrollManager.scrollSize.y
scrollManager.element.scrollSize.x
scrollManager.element.scrollSize.y
```
This is the scroll size of the container. It determines the amount of scroll that can be done
### scrollPosition
```js
scrollManager.scrollPosition.x
scrollManager.scrollPosition.y
scrollManager.element.scrollPosition.x
scrollManager.element.scrollPosition.y
```
This is the position of the scrollBar. Its minimum value it's 0, and its maximum is the `scrollSize` - the `size`
### offset
```js
scrollManager.offset.x
scrollManager.offset.y
scrollManager.element.offset.x
scrollManager.element.offset.y
```
This is less likely to be used. It indicates the offset of the _boundingClientRect_ of the container. So for the window as container, it will return 0 for both `x` and `y`. It's the equivalent for `getBoundingClientRect().left` and `top`
Expand Down

0 comments on commit 2017282

Please sign in to comment.