Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dasiux committed May 23, 2022
1 parent f67769a commit b29d253
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/Animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,13 @@ class Scroller extends EventDispatcher {
bind : Boolean // Bind scrollTo links, default: true
context : document.body|HTMLElement // Context to select scrollTo links from, default: document.body
selector : String // Scroll to link selector, default: [href^="#"]
autoTop : Boolean // Scroll to top when using only # or #top without an actual element target
capture : Boolean // Capture initial scroll, default: true
initial : Number|'ready' // Initial scroll delay after capture
complete : null|Function // Complete callback for local scrollTo
}
initial : null|HTMLElement // Initial scroll-to target
bind( selector = null, context = null ) {} // void
scrollTo( element, complete = null ) {} // void
}
```
Expand Down
21 changes: 21 additions & 0 deletions docs/Number.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,27 @@ rand( 1, 10 ); // (1|2|3|4|5|6|7|8|9|10)

---

### Ratio
Ratio class - A ratio value class.

#### Class overview
```javascript
class Ratio {
static make( width, height = null, separator = ':' ) {} // string
constructor( width, height = null, separator = ':' ) {}
separator : String
w : Number // Input width
h : Number // Input height
r : Number // Ratio value
x : Number // Ratio width
y : Number // Ratio height
toString() {} // string
}
```
For more details check the [Ratio source file](../src/es6/Number/Ratio.js).

---

### round
round - Round value

Expand Down

0 comments on commit b29d253

Please sign in to comment.