Skip to content

Commit

Permalink
update docs changelog and version
Browse files Browse the repository at this point in the history
  • Loading branch information
dasiux committed Apr 14, 2022
1 parent 12c861c commit d94a5f8
Show file tree
Hide file tree
Showing 15 changed files with 75 additions and 13 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 0.8.2
- Added *Exception.previousToStack()* fallback for none string stacks.
- Improved docs nav and some minor typos.

## 0.8.1
- Added *detach* method to *ConsoleInterceptor* for global use, change default constructor argument host from document to window.
- Improved *Scroller* options offset can be arguments array and added *Scroller.scrollTo()* method, removed *scrollComplete( delay )* option.
Expand Down
17 changes: 11 additions & 6 deletions docs/es6/Animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Animation
> [Table of contents](../README.md) <[ Animation ]> [Array](Array.md)
## Table of contents
- [holdElementViewportPosition()](#holdElementViewportPosition)
Expand Down Expand Up @@ -86,13 +87,13 @@ class Scroller extends EventDispatcher {
static getUrlWithHash( hash, url ) {} // string
constructor( options, debug ) {}
config : { // ScrollerOptions
offset : null|number|HTMLElement|Array // Offset pixels or element or Array of arguments, default: null
bind : boolean // Bind scrollTo links, default: true
offset : null|Number|HTMLElement|Array // Offset pixels or element or Array of arguments, default: null
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^="#"]
capture : boolean // Capture initial scroll, default: true
initial : number|'ready' // Initial scroll delay after capture
hashClean : number // scrollComplete delay, default: 300
selector : String // Scroll to link selector, default: [href^="#"]
capture : Boolean // Capture initial scroll, default: true
initial : Number|'ready' // Initial scroll delay after capture
hashClean : Number // scrollComplete delay, default: 300
}
initial : null|HTMLElement // Initial scroll-to target
scrollTo( element, complete = null ) {} // void
Expand Down Expand Up @@ -250,3 +251,7 @@ Show element by sliding down.
```javascript
slideShow( document.getElementById( 'slidable' ), () => console.log( 'slideShow::complete' ) );
```

---

> [Table of contents](../README.md) <[ Animation ]> [Array](Array.md)
5 changes: 5 additions & 0 deletions docs/es6/Array.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Array
> [Animation](Animation.md) <[ Array ]> [Dev](Dev.md)
## Table of contents
- [mergeArray()](#mergeArray)
Expand Down Expand Up @@ -35,3 +36,7 @@ Merges two or more arrays and returns a new array.
```javascript
mergeArray([1],[2],[3]); // [1,2,3]
```

---

> [Animation](Animation.md) <[ Array ]> [Dev](Dev.md)
3 changes: 3 additions & 0 deletions docs/es6/DOM.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / DOM
> [Dev](Dev.md) <[ DOM ]> [Error](Error.md)
## Table of contents
- [appendAfter()](#appendAfter)
Expand Down Expand Up @@ -317,3 +318,5 @@ wrap( document.querySelectorAll( '.selector' ) ); // HTMLDivElement
```

---

> [Dev](Dev.md) <[ DOM ]> [Error](Error.md)
5 changes: 5 additions & 0 deletions docs/es6/Dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Dev
> [Array](Array.md) <[ Dev ]> [DOM](DOM.md)
## Table of contents
- [ConsoleInterceptor](#ConsoleInterceptor)
Expand Down Expand Up @@ -54,3 +55,7 @@ Binds a global event to highlight elements focused by keyboard control and retur
const disableTabFocus = tabFocus(); // Enable tab focus debug
disableTabFocus(); // Disable tab focus debug
```

---

> [Array](Array.md) <[ Dev ]> [DOM](DOM.md)
7 changes: 6 additions & 1 deletion docs/es6/Error.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Error
> [DOM](DOM.md) <[ Error ]> [Events](Events.md)
## Table of contents
- [Exception](#Exception)
Expand All @@ -14,7 +15,7 @@ Exception class - Extension of the native *Error* with a previous implementation

#### Class overview
```javascript
class Exception {
class Exception extends Error {
constructor( message, previous ) {}
previous : *
previousToStack : boolean
Expand All @@ -23,3 +24,7 @@ class Exception {
}
```
For more details check the [Exception source file](../../src/es6/Error/Exception.js).

---

> [DOM](DOM.md) <[ Error ]> [Events](Events.md)
7 changes: 6 additions & 1 deletion docs/es6/Events.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Events
> [Error](Error.md) <[ Events ]> [HTTP](HTTP.md)
## Table of contents
- [bindNodeList()](#bindNodeList)
Expand Down Expand Up @@ -104,7 +105,7 @@ EventDispatcher class - Abstract class used for creating dom event connected or
class EventDispatcher {
static isCompat( obj ) {} // Boolean
constructor( element = null, parent = null, debug = null ) {}
debug : console
debug : null|Console
target : null|HTMLElement
parent : null|EventDispatcher
isSimulated : Boolean
Expand All @@ -116,3 +117,7 @@ class EventDispatcher {
}
```
For more details check the [EventDispatcher source file](../../src/es6/Events/EventDispatcher.js).

---

> [Error](Error.md) <[ Events ]> [HTTP](HTTP.md)
5 changes: 5 additions & 0 deletions docs/es6/HTTP.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / HTTP
> [Events](Events.md) <[ HTTP ]> [Logic](Logic.md)
## Table of contents
- [AsyncRequest](#AsyncRequest)
Expand Down Expand Up @@ -59,3 +60,7 @@ class JsonP {
}
```
For more details check the [JsonP source file](../../src/es6/HTTP/JsonP.js).

---

> [Events](Events.md) <[ HTTP ]> [Logic](Logic.md)
11 changes: 8 additions & 3 deletions docs/es6/Logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Logic
> [HTTP](HTTP.md) <[ Logic ]> [Number](Number.md)
## Table of contents
- [Config](#Config)
Expand Down Expand Up @@ -41,7 +42,7 @@ Plugin class - Plugin class for use with the [Plugins](#Plugins) class
class Plugin {
constructor( options = {}, context = null, debug = null ) {}
options : Object
debug : null|console
debug : null|Console
context : null|Object
_context_check( context ) {} // void
}
Expand All @@ -57,8 +58,8 @@ Plugins class - A plugins handler class for use with the [Plugin](#Plugin) class
```javascript
class Plugins {
constructor( plugins = [], context = null, append = true, debug = null ) {}
append : null|boolean
debug : null|console
append : null|Boolean
debug : null|Console
context : null|Object
load( plugins ) {} // void
init( Construct, options = {}, replace = false ) {} // Object
Expand All @@ -70,3 +71,7 @@ class Plugins {
}
```
For more details check the [Plugins source file](../../src/es6/Logic/Plugins.js).

---

> [HTTP](HTTP.md) <[ Logic ]> [Number](Number.md)
5 changes: 5 additions & 0 deletions docs/es6/Number.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Number
> [Logic](Logic.md) <[ Number ]> [Object](Object.md)
## Table of contents
- [convertBytes()](#convertBytes)
Expand Down Expand Up @@ -205,3 +206,7 @@ Round value to specific decimals, default 2.
```javascript
round( 4.5678 ); // 4.57
```

---

> [Logic](Logic.md) <[ Number ]> [Object](Object.md)
5 changes: 5 additions & 0 deletions docs/es6/Object.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Object
> [Number](Number.md) <[ Object ]> [String](String.md)
## Table of contents
- [cloneObject()](#cloneObject)
Expand Down Expand Up @@ -182,3 +183,7 @@ strCreate( 'foo.link', '#anchor', base );
console.log( base );
// { foo : { label : 'text', link : '#anchor' } }
```

---

> [Number](Number.md) <[ Object ]> [String](String.md)
5 changes: 5 additions & 0 deletions docs/es6/String.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / String
> [Object](Object.md) <[ String ]> [Var](Var.md)
## Table of contents
- [escapeHTML()](#escapeHTML)
Expand Down Expand Up @@ -227,3 +228,7 @@ Capitalize the first character.
```javascript
ucfirst( 'foo' ); // 'Foo'
```

---

> [Object](Object.md) <[ String ]> [Var](Var.md)
5 changes: 5 additions & 0 deletions docs/es6/Var.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Documentation
### Javascript / Var
> [String](String.md) <[ Var ]> [Table of contents](../README.md)
## Table of contents
- [cast2type()](#cast2type)
Expand Down Expand Up @@ -70,3 +71,7 @@ isEmpty( 0 ); // true
isEmpty( false ); // true
isEmpty(); // true
```

---

> [String](String.md) <[ Var ]> [Table of contents](../README.md)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@squirrel-forge/ui-util",
"version": "0.8.1",
"version": "0.8.2",
"description": "A collection of utilities, classes, functions and abstracts made for the browser and babel compatible.",
"main": "src/es6/index.js",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion src/es6/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*!
* @module : @squirrel-forge/ui-util
* @version : 0.8.0
* @version : 0.8.2
* @license : MIT
* @copyright : 2022 squirrel-forge
* @author : Daniel Hartwell aka. siux <me@siux.info>
Expand Down

0 comments on commit d94a5f8

Please sign in to comment.