@webalternatif/js-core 1.6.0 → 1.6.3

package/docs/dom.md

@@ -0,0 +1,683 @@
+# DOM utilities
+
+Description of the dom utilities.
+
+## Import
+
+```js
+import { dom } from '@webalternatif/js-core'
+```
+
+---
+
+## API
+<!-- GENERATED:dom -->
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## isWindow
+
+[src/dom.js:42-44][1]
+
+### Parameters
+
+*   `o` **any**&#x20;
+
+Returns **[boolean][2]**&#x20;
+
+## isDocument
+
+[src/dom.js:50-53][3]
+
+### Parameters
+
+*   `o` **any**&#x20;
+
+Returns **[boolean][2]**&#x20;
+
+## isDomElement
+
+[src/dom.js:59-61][4]
+
+### Parameters
+
+*   `o` **any**&#x20;
+
+Returns **[boolean][2]**&#x20;
+
+## getStyle
+
+[src/dom.js:68-80][5]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `cssRule` **[string][7]**&#x20;
+
+Returns **[string][7]**&#x20;
+
+## children
+
+[src/dom.js:88-92][8]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **[string][7]?**&#x20;
+
+Returns **[NodeList][9]**&#x20;
+
+## child
+
+[src/dom.js:99-101][10]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **[string][7]?**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## findOne
+
+[src/dom.js:108-110][11]
+
+### Parameters
+
+*   `refEl` **([Element][6] | [Document][12] | [string][7])**&#x20;
+*   `selector` **([string][7] | [Element][6] | [NodeList][9] | [Array][13]<[Element][6]>)?**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## find
+
+[src/dom.js:117-142][14]
+
+### Parameters
+
+*   `refEl` **([Element][6] | [Document][12] | [string][7])**&#x20;
+*   `selector` **([string][7] | [Element][6] | [NodeList][9] | [Array][13]<[Element][6]>)?**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## findOneByData
+
+[src/dom.js:150-152][15]
+
+### Parameters
+
+*   `el` **([Element][6] | [string][7])**&#x20;
+*   `data` **[string][7]**&#x20;
+*   `value` **[string][7]?**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## findByData
+
+[src/dom.js:160-163][16]
+
+### Parameters
+
+*   `el` **([Element][6] | [string][7])**&#x20;
+*   `data` **[string][7]**&#x20;
+*   `value` **[string][7]?**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## addClass
+
+[src/dom.js:170-188][17]
+
+### Parameters
+
+*   `el` **([Element][6] | [NodeList][9] | [Array][13]<[Element][6]>)**&#x20;
+*   `className` **[string][7]**&#x20;
+
+Returns **([Element][6] | [NodeList][9] | [Array][13]<[Element][6]>)**&#x20;
+
+## removeClass
+
+[src/dom.js:195-213][18]
+
+### Parameters
+
+*   `el` **([Element][6] | [NodeList][9] | [Array][13]<[Element][6]>)**&#x20;
+*   `className` **[string][7]**&#x20;
+
+Returns **([Element][6] | [NodeList][9] | [Array][13]<[Element][6]>)**&#x20;
+
+## toggleClass
+
+[src/dom.js:221-230][19]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `classNames` **[string][7]**&#x20;
+*   `force` **[boolean][2]?**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## hasClass
+
+[src/dom.js:237-257][20]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `classNames` **[string][7]**&#x20;
+
+Returns **[boolean][2]**&#x20;
+
+## append
+
+[src/dom.js:264-274][21]
+
+### Parameters
+
+*   `node` **[Node][22]**&#x20;
+*   `children` **...([Node][22] | [string][7])**&#x20;
+
+Returns **[Node][22]**&#x20;
+
+## prepend
+
+[src/dom.js:281-291][23]
+
+### Parameters
+
+*   `node` **[Node][22]**&#x20;
+*   `children` **...([Node][22] | [string][7])**&#x20;
+
+Returns **[Node][22]**&#x20;
+
+## remove
+
+[src/dom.js:297-307][24]
+
+### Parameters
+
+*   `els` **([Element][6] | [NodeList][9] | [Array][13]<[Element][6]> | [string][7])**&#x20;
+
+Returns **void**&#x20;
+
+## closest
+
+[src/dom.js:314-338][25]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **([string][7] | [Element][6])?**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## next
+
+[src/dom.js:345-355][26]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **[string][7]?**  (optional, default `null`)
+
+Returns **([Element][6] | null)**&#x20;
+
+## prev
+
+[src/dom.js:362-372][27]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **([string][7] | null)?**  (optional, default `null`)
+
+Returns **([Element][6] | null)**&#x20;
+
+## nextAll
+
+[src/dom.js:379-393][28]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **[string][7]?**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## prevAll
+
+[src/dom.js:400-414][29]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **[string][7]?**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## nextUntil
+
+[src/dom.js:421-444][30]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **([Element][6] | [string][7])**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## prevUntil
+
+[src/dom.js:451-474][31]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **([Element][6] | [string][7])**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## wrap
+
+[src/dom.js:481-489][32]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `wrappingElement` **[Element][6]**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## attr
+
+[src/dom.js:497-507][33]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `name` **[string][7]**&#x20;
+*   `value` **any?**&#x20;
+
+Returns **([Element][6] | any)**&#x20;
+
+## prop
+
+[src/dom.js:515-522][34]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `name` **[string][7]**&#x20;
+*   `value` **any?**&#x20;
+
+Returns **(any | [Element][6])**&#x20;
+
+## html
+
+[src/dom.js:529-534][35]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `html` **[string][7]?**&#x20;
+
+Returns **([Element][6] | any)**&#x20;
+
+## text
+
+[src/dom.js:541-546][36]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `text` **[string][7]?**&#x20;
+
+Returns **([Element][6] | any)**&#x20;
+
+## hide
+
+[src/dom.js:552-560][37]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## show
+
+[src/dom.js:566-577][38]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## toggle
+
+[src/dom.js:583-585][39]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## data
+
+[src/dom.js:593-616][40]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `name` **([Object][41]<[string][7], [string][7]> | [string][7])**&#x20;
+*   `value` **[string][7]?**&#x20;
+
+Returns **([Element][6] | DOMStringMap)**&#x20;
+
+## removeData
+
+[src/dom.js:623-629][42]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `name` **[string][7]**&#x20;
+
+Returns **([Element][6] | any)**&#x20;
+
+## css
+
+[src/dom.js:637-660][43]
+
+### Parameters
+
+*   `el` **[HTMLElement][44]**&#x20;
+*   `style` **([Object][41]<[string][7], [string][7]> | [string][7])**&#x20;
+*   `value` **[string][7]?**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## closestFind
+
+[src/dom.js:668-676][45]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selectorClosest` **[string][7]**&#x20;
+*   `selectorFind` **[string][7]**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## closestFindOne
+
+[src/dom.js:684-692][46]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selectorClosest` **[string][7]**&#x20;
+*   `selectorFindOne` **[string][7]**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## first
+
+[src/dom.js:698-701][47]
+
+### Parameters
+
+*   `nodeList` **([NodeList][9] | [Element][6] | [Array][13]<[Element][6]>)**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## last
+
+[src/dom.js:707-711][48]
+
+### Parameters
+
+*   `nodeList` **([NodeList][9] | [Array][13]<[Element][6]>)**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## create
+
+[src/dom.js:717-738][49]
+
+### Parameters
+
+*   `html` **[string][7]**&#x20;
+
+Returns **([Element][6] | [DocumentFragment][50] | null)**&#x20;
+
+## eq
+
+[src/dom.js:745-755][51]
+
+### Parameters
+
+*   `nodeList` **([NodeList][9] | [Array][13]<[Element][6]>)**&#x20;
+*   `index` **[number][52]**  (optional, default `0`)
+
+Returns **([Element][6] | null)**&#x20;
+
+## after
+
+[src/dom.js:762-770][53]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `newEl` **([Element][6] | [string][7])**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## before
+
+[src/dom.js:777-785][54]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `newEl` **([Element][6] | [string][7])**&#x20;
+
+Returns **([Element][6] | null)**&#x20;
+
+## empty
+
+[src/dom.js:791-801][55]
+
+### Parameters
+
+*   `el` **([Element][6] | [string][7])**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## not
+
+[src/dom.js:808-822][56]
+
+### Parameters
+
+*   `el` **([Element][6] | [NodeList][9] | [Array][13]<[Element][6]>)**&#x20;
+*   `selector` **([string][7] | [Element][6])**&#x20;
+
+Returns **[Array][13]<[Element][6]>**&#x20;
+
+## collide
+
+[src/dom.js:829-840][57]
+
+### Parameters
+
+*   `elem1` **[Element][6]**&#x20;
+*   `elem2` **[Element][6]**&#x20;
+
+Returns **[boolean][2]**&#x20;
+
+## matches
+
+[src/dom.js:846-852][58]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `selector` **([string][7] | [Element][6])**&#x20;
+
+## replaceChild
+
+[src/dom.js:859-861][59]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `child` **[Element][6]**&#x20;
+*   `oldChild` **[Element][6]**&#x20;
+
+## replaceChildren
+
+[src/dom.js:868-881][60]
+
+### Parameters
+
+*   `el` **[Element][6]**&#x20;
+*   `children` **([NodeList][9] | [Array][13]<[Element][6]> | [Array][13]<[string][7]>)**&#x20;
+
+Returns **[Element][6]**&#x20;
+
+## offset
+
+[src/dom.js:887-909][61]
+
+### Parameters
+
+*   `el` **([Element][6] | [Document][12] | [Window][62])**&#x20;
+
+Returns **{top: [number][52], left: [number][52]}**&#x20;
+
+[1]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L42-L44 "Source code on GitHub"
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[3]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L50-L53 "Source code on GitHub"
+
+[4]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L59-L61 "Source code on GitHub"
+
+[5]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L68-L80 "Source code on GitHub"
+
+[6]: https://developer.mozilla.org/docs/Web/API/Element
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[8]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L88-L92 "Source code on GitHub"
+
+[9]: https://developer.mozilla.org/docs/Web/API/NodeList
+
+[10]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L99-L101 "Source code on GitHub"
+
+[11]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L108-L110 "Source code on GitHub"
+
+[12]: https://developer.mozilla.org/docs/Web/API/Document
+
+[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[14]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L117-L142 "Source code on GitHub"
+
+[15]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L150-L152 "Source code on GitHub"
+
+[16]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L160-L163 "Source code on GitHub"
+
+[17]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L170-L188 "Source code on GitHub"
+
+[18]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L195-L213 "Source code on GitHub"
+
+[19]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L221-L230 "Source code on GitHub"
+
+[20]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L237-L257 "Source code on GitHub"
+
+[21]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L264-L274 "Source code on GitHub"
+
+[22]: https://developer.mozilla.org/docs/Web/API/Node/nextSibling
+
+[23]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L281-L291 "Source code on GitHub"
+
+[24]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L297-L307 "Source code on GitHub"
+
+[25]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L314-L338 "Source code on GitHub"
+
+[26]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L345-L355 "Source code on GitHub"
+
+[27]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L362-L372 "Source code on GitHub"
+
+[28]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L379-L393 "Source code on GitHub"
+
+[29]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L400-L414 "Source code on GitHub"
+
+[30]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L421-L444 "Source code on GitHub"
+
+[31]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L451-L474 "Source code on GitHub"
+
+[32]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L481-L489 "Source code on GitHub"
+
+[33]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L497-L507 "Source code on GitHub"
+
+[34]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L515-L522 "Source code on GitHub"
+
+[35]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L529-L534 "Source code on GitHub"
+
+[36]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L541-L546 "Source code on GitHub"
+
+[37]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L552-L560 "Source code on GitHub"
+
+[38]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L566-L577 "Source code on GitHub"
+
+[39]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L583-L585 "Source code on GitHub"
+
+[40]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L593-L616 "Source code on GitHub"
+
+[41]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[42]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L623-L629 "Source code on GitHub"
+
+[43]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L637-L660 "Source code on GitHub"
+
+[44]: https://developer.mozilla.org/docs/Web/HTML/Element
+
+[45]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L668-L676 "Source code on GitHub"
+
+[46]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L684-L692 "Source code on GitHub"
+
+[47]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L698-L701 "Source code on GitHub"
+
+[48]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L707-L711 "Source code on GitHub"
+
+[49]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L717-L738 "Source code on GitHub"
+
+[50]: https://developer.mozilla.org/docs/Web/API/DocumentFragment
+
+[51]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L745-L755 "Source code on GitHub"
+
+[52]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[53]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L762-L770 "Source code on GitHub"
+
+[54]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L777-L785 "Source code on GitHub"
+
+[55]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L791-L801 "Source code on GitHub"
+
+[56]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L808-L822 "Source code on GitHub"
+
+[57]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L829-L840 "Source code on GitHub"
+
+[58]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L846-L852 "Source code on GitHub"
+
+[59]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L859-L861 "Source code on GitHub"
+
+[60]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L868-L881 "Source code on GitHub"
+
+[61]: https://github.com/webalternatif/js-core/blob/c9158e27ed191c37c696ced37950f978a21eecba/src/dom.js#L887-L909 "Source code on GitHub"
+
+[62]: https://developer.mozilla.org/docs/Web/API/Window

package/docs/eventDispatcher.md

@@ -0,0 +1,15 @@
+# Event Dispatcher
+
+Description of the event dispatcher.
+
+## Import
+
+```js
+import { eventDispatcher } from '@webalternatif/js-core'
+```
+
+---
+
+## API
+<!-- GENERATED:eventDispatcher -->
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

package/docs/is.md

@@ -0,0 +1,15 @@
+# Type Checking
+
+Description of the type checking.
+
+## Import
+
+```js
+import { is } from '@webalternatif/js-core'
+```
+
+---
+
+## API
+<!-- GENERATED:is -->
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->