nanosplash 2.3.3 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/README.md +38 -42
  2. package/dist/iife/nanosplash.iife.js +1 -1
  3. package/dist/module/Nanosplash.css +1 -1
  4. package/dist/module/nanosplash.cjs.js +1 -1
  5. package/dist/module/nanosplash.es.js +45 -27
  6. package/docs/index.html +36 -14
  7. package/docs/nanosplash.iife.js +6 -1
  8. package/docs/style.css +1 -1
  9. package/docs/typedoc/assets/main.js +2 -2
  10. package/docs/typedoc/assets/search.js +1 -1
  11. package/docs/typedoc/classes/Core_Nanosplash.Nanosplash.html +59 -0
  12. package/docs/typedoc/index.html +1 -1
  13. package/docs/typedoc/modules/Core_Nanosplash.html +1 -0
  14. package/docs/typedoc/modules/types.html +1 -0
  15. package/index.html +35 -17
  16. package/package.json +13 -13
  17. package/src/Core/Nanosplash.ts +74 -19
  18. package/src/Core/SplashInstance.ts +114 -1
  19. package/src/Factory/NanosplashFactory.ts +1 -13
  20. package/src/Interfaces/NanosplashInterface.ts +1 -2
  21. package/src/main.ts +7 -1
  22. package/src/repositories/NanosplashRepository.ts +13 -1
  23. package/src/style.sass +47 -17
  24. package/src/types.d.ts +8 -4
  25. package/src/utilities/dom.ts +2 -2
  26. package/src/Interfaces/ImageInterface.ts +0 -5
package/docs/typedoc/index.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>nanosplash</title><meta name="description" content="Documentation for nanosplash"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">nanosplash</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>nanosplash </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="index.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias"><a href="index.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias"><a href="index.html#ImgFunction" class="tsd-kind-icon">Img<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias"><a href="index.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias"><a href="index.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ContextualAPIObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ContextualAPIObject<a href="#ContextualAPIObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ContextualAPIObject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>inside<span class="tsd-signature-symbol">?: </span><a href="index.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a><span class="tsd-signature-symbol">; </span>getId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>moveTo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>remove<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L35">types.d.ts:35</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> inside<span class="tsd-signature-symbol">?: </span><a href="index.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a></h5></li><li class="tsd-parameter"><h5>get<wbr/>Id<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">get<wbr/>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L36">types.d.ts:36</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">get<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L42">types.d.ts:42</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Text<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">get<wbr/>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L40">types.d.ts:40</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>move<wbr/>To<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">move<wbr/>To<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L39">types.d.ts:39</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>remove<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L38">types.d.ts:38</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>set<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">set<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L43">types.d.ts:43</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> src: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li><li class="tsd-parameter"><h5>set<wbr/>Text<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">set<wbr/>Text<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L41">types.d.ts:41</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Destination<a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Destination<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L12">types.d.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ImgFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Img<wbr/>Function<a href="#ImgFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Img<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="index.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L33">types.d.ts:33</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>src: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="index.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="InsideFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Inside<wbr/>Function<a href="#InsideFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Inside<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L34">types.d.ts:34</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ProgressFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Progress<wbr/>Function<a href="#ProgressFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Progress<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>[]<span class="tsd-signature-symbol">: </span><a href="index.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L26">types.d.ts:26</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>[]<span class="tsd-signature-symbol">: </span><a href="index.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>[]: <a href="index.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ShowFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Show<wbr/>Function<a href="#ShowFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Show<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L25">types.d.ts:25</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SplashJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Splash<wbr/>Job<a href="#SplashJob" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Splash<wbr/>Job<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L13">types.d.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="StrategyObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Strategy<wbr/>Object<a href="#StrategyObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Strategy<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>progress<span class="tsd-signature-symbol">: </span><a href="index.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><a href="index.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a><span class="tsd-signature-symbol">; </span>while<span class="tsd-signature-symbol">: </span><a href="index.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L28">types.d.ts:28</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>progress<span class="tsd-signature-symbol">: </span><a href="index.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a></h5></li><li class="tsd-parameter"><h5>show<span class="tsd-signature-symbol">: </span><a href="index.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a></h5></li><li class="tsd-parameter"><h5>while<span class="tsd-signature-symbol">: </span><a href="index.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WhileFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">While<wbr/>Function<a href="#WhileFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">While<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>asyncTask<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ShowInterface</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/d617de1/src/types.d.ts#L27">types.d.ts:27</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>asyncTask<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ShowInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>asyncTask: <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ShowInterface</span></h4></li></ul></li></ul></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="index.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias"><a href="index.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias"><a href="index.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias"><a href="index.html#ImgFunction" class="tsd-kind-icon">Img<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="index.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias"><a href="index.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias"><a href="index.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>nanosplash</title><meta name="description" content="Documentation for nanosplash"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">nanosplash</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> nanosplash </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Modules</h3><ul class="tsd-index-list"><li class="tsd-kind-module"><a href="modules/Core_Nanosplash.html" class="tsd-kind-icon">Core/<wbr/>Nanosplash</a></li><li class="tsd-kind-module"><a href="modules/types.html" class="tsd-kind-icon">types</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="index.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/Core_Nanosplash.html">Core/<wbr/>Nanosplash</a></li><li class=" tsd-kind-module"><a href="modules/types.html">types</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
package/docs/typedoc/modules/Core_Nanosplash.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Core/Nanosplash | nanosplash</title><meta name="description" content="Documentation for nanosplash"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">nanosplash</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">nanosplash</a></li><li><a href="Core_Nanosplash.html">Core/Nanosplash</a></li></ul><h1>Module Core/Nanosplash </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/Core_Nanosplash.Nanosplash.html" class="tsd-kind-icon">Nanosplash</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class="current tsd-kind-module"><a href="Core_Nanosplash.html">Core/<wbr/>Nanosplash</a></li><li class=" tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/Core_Nanosplash.Nanosplash.html" class="tsd-kind-icon">Nanosplash</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/typedoc/modules/types.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>types | nanosplash</title><meta name="description" content="Documentation for nanosplash"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">nanosplash</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">nanosplash</a></li><li><a href="types.html">types</a></li></ul><h1>Module types </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Type Aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ImgFunction" class="tsd-kind-icon">Img<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InstanceIterationCallback" class="tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#NanosplashOptions" class="tsd-kind-icon">Nanosplash<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type Aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ContextualAPIObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ContextualAPIObject<a href="#ContextualAPIObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ContextualAPIObject<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>inside<span class="tsd-signature-symbol">?: </span><a href="types.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a><span class="tsd-signature-symbol">; </span>getId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>moveTo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>remove<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setImgSrc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>setText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L37">types.d.ts:37</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> inside<span class="tsd-signature-symbol">?: </span><a href="types.html#InsideFunction" class="tsd-signature-type" data-tsd-kind="Type alias">InsideFunction</a></h5></li><li class="tsd-parameter"><h5>get<wbr/>Id<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">get<wbr/>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L38">types.d.ts:38</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">get<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L44">types.d.ts:44</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>get<wbr/>Text<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">get<wbr/>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L42">types.d.ts:42</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li><li class="tsd-parameter"><h5>move<wbr/>To<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">move<wbr/>To<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L41">types.d.ts:41</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>remove<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L40">types.d.ts:40</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>set<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">set<wbr/>Img<wbr/>Src<span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L45">types.d.ts:45</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> src: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li><li class="tsd-parameter"><h5>set<wbr/>Text<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">set<wbr/>Text<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L43">types.d.ts:43</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SplashInstance</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Destination<a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Destination<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L14">types.d.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ImgFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Img<wbr/>Function<a href="#ImgFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Img<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="types.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L35">types.d.ts:35</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="types.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>src: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="types.html#StrategyObject" class="tsd-signature-type" data-tsd-kind="Type alias">StrategyObject</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="InsideFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Inside<wbr/>Function<a href="#InsideFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Inside<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L36">types.d.ts:36</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>selector: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="InstanceIterationCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Instance<wbr/>Iteration<wbr/>Callback<a href="#InstanceIterationCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, splashInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span>, i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L47">types.d.ts:47</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, splashInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SplashInstance</span>, i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li><li><h5>splashInstance: <span class="tsd-signature-type">SplashInstance</span></h5></li><li><h5>i: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="NanosplashOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Nanosplash<wbr/>Options<a href="#NanosplashOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Nanosplash<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>fontSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>imgSrc<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>spinner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L49">types.d.ts:49</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr/>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> img<wbr/>Src<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> spinner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ProgressFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Progress<wbr/>Function<a href="#ProgressFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Progress<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>[]<span class="tsd-signature-symbol">: </span><a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L28">types.d.ts:28</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>[]<span class="tsd-signature-symbol">: </span><a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>[]: <a href="types.html#SplashJob" class="tsd-signature-type" data-tsd-kind="Type alias">SplashJob</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ShowFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Show<wbr/>Function<a href="#ShowFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Show<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ContextualAPIInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L27">types.d.ts:27</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ContextualAPIInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>text: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ContextualAPIInterface</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="SplashJob" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Splash<wbr/>Job<a href="#SplashJob" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Splash<wbr/>Job<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L15">types.d.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StrategyObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Strategy<wbr/>Object<a href="#StrategyObject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Strategy<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>progress<span class="tsd-signature-symbol">: </span><a href="types.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a><span class="tsd-signature-symbol">; </span>show<span class="tsd-signature-symbol">: </span><a href="types.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a><span class="tsd-signature-symbol">; </span>while<span class="tsd-signature-symbol">: </span><a href="types.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L30">types.d.ts:30</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>progress<span class="tsd-signature-symbol">: </span><a href="types.html#ProgressFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ProgressFunction</a></h5></li><li class="tsd-parameter"><h5>show<span class="tsd-signature-symbol">: </span><a href="types.html#ShowFunction" class="tsd-signature-type" data-tsd-kind="Type alias">ShowFunction</a></h5></li><li class="tsd-parameter"><h5>while<span class="tsd-signature-symbol">: </span><a href="types.html#WhileFunction" class="tsd-signature-type" data-tsd-kind="Type alias">WhileFunction</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="WhileFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">While<wbr/>Function<a href="#WhileFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">While<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>asyncTask<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ShowInterface</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/isakhauge/nanosplash/blob/b6fddee/src/types.d.ts#L29">types.d.ts:29</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>asyncTask<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ShowInterface</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>asyncTask: <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ShowInterface</span></h4></li></ul></li></ul></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class=" tsd-kind-module"><a href="Core_Nanosplash.html">Core/<wbr/>Nanosplash</a></li><li class="current tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ContextualAPIObject" class="tsd-kind-icon">ContextualAPIObject</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ImgFunction" class="tsd-kind-icon">Img<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InsideFunction" class="tsd-kind-icon">Inside<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#InstanceIterationCallback" class="tsd-kind-icon">Instance<wbr/>Iteration<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#NanosplashOptions" class="tsd-kind-icon">Nanosplash<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ProgressFunction" class="tsd-kind-icon">Progress<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ShowFunction" class="tsd-kind-icon">Show<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#SplashJob" class="tsd-kind-icon">Splash<wbr/>Job</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#StrategyObject" class="tsd-kind-icon">Strategy<wbr/>Object</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#WhileFunction" class="tsd-kind-icon">While<wbr/>Function</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/index.html CHANGED
@@ -13,8 +13,8 @@
13
13
  </head>
14
14
  <body class="flex flex-col justify-between">
15
15
  <div class="w-100 min-h-screen flex flex-col justify-center items-center">
16
- <div class="text-3xl">Nanosplash</div>
17
- <div class="mt-3">Small. Simple. Reliable.</div>
16
+ <div class="text-4xl text-slate-900 drop-shadow-lg">Nanosplash</div>
17
+ <div class="text-pink-500 mt-3 font-mono text-sm">ns.show('text').inside('#id')</div>
18
18
  <div class="flex flex-col space-y-2 my-10">
19
19
  <div class="flex space-x-2 justify-center">
20
20
  <img src="https://badgen.net/npm/v/nanosplash" />
@@ -28,13 +28,23 @@
28
28
  />
29
29
  </div>
30
30
  </div>
31
- <div class="text-white bg-slate-700 p-3 rounded shadow-xl font-mono text-sm">ns.show('text').inside('#myDiv')</div>
31
+ <div class="flex rounded-xl text-slate-400 shadow-xl overflow-hidden">
32
+ <div data-copy class="p-3 bg-slate-800 text-slate-400 font-mono">
33
+ &lt;script src=&quot;https://unpkg.com/nanosplash/dist/iife/nanosplash.iife.js&quot;&gt;
34
+ </div>
35
+ <div id="copy" class="bg-pink-500 text-pink-200 p-3 cursor-pointer hover:text-white">Copy</div>
36
+ </div>
37
+ <div class="mt-10 flex justify-content items-center divide-x-2 text-slate-400">
38
+ <a href="https://www.npmjs.com/package/nanosplash" target="_blank"><i class="lni lni-npm text-4xl hover:text-pink-500 px-5"></i></a>
39
+ <a href="https://github.com/isakhauge/nanosplash" target="_blank"><i class="lni lni-github-original text-2xl hover:text-pink-500 px-5"></i></a>
40
+ </div>
41
+ <a class="mt-10 text-pink-300 hover:text-pink-500" href="/typedoc">API Reference Documentation</a>
32
42
  </div>
33
- <div class="grid grid-cols-2 gap-1">
43
+ <div class="grid grid-cols-1 xl:grid-cols-2 gap-1">
34
44
  <div id="a" class="p-20 bg-slate-100 flex flex-col items-center">
35
45
  <div class="text-xl mb-10">Give user progress feedback</div>
36
- <div class="text-white bg-slate-800 p-5 rounded-lg shadow-2xl font-mono text-sm">
37
- ns.img(src).progress(<br>
46
+ <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
47
+ ns.progress(<br>
38
48
  &nbsp;&nbsp;[promise1, 'Loading A'],<br>
39
49
  &nbsp;&nbsp;[promise2, 'Loading B'],<br>
40
50
  &nbsp;&nbsp;[promise3, 'Loading C'],<br>
@@ -43,13 +53,13 @@
43
53
  </div>
44
54
  <div id="b" class="p-20 bg-slate-100 flex flex-col items-center">
45
55
  <div class="text-xl mb-10">Handle async functions</div>
46
- <div class="text-white bg-slate-800 p-5 rounded-lg shadow-2xl font-mono text-sm">
56
+ <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
47
57
  ns.while(promise).show('Loading ...').inside('#myDiv')
48
58
  </div>
49
59
  </div>
50
60
  <div id="c" class="p-20 bg-slate-100 flex flex-col items-center">
51
61
  <div class="text-xl mb-10">Display fullscreen</div>
52
- <div class="text-white bg-slate-800 p-5 rounded-lg shadow-2xl font-mono text-sm">
62
+ <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
53
63
  const splash = ns.show('Fullscreen text')<br>
54
64
  splash.moveTo('#myDiv')<br>
55
65
  splash.remove()
@@ -57,27 +67,35 @@
57
67
  </div>
58
68
  <div id="d" class="p-20 bg-slate-100 flex flex-col items-center">
59
69
  <div class="text-xl mb-10">Display multiple, independent instances</div>
60
- <div class="text-white bg-slate-800 p-5 rounded-lg shadow-2xl font-mono text-sm">
61
- ns.img(src).show('Loading component A').inside('#a')<br>
62
- ns.show('Loading component A').inside('#b')<br>
63
- ns.show('Loading component A').inside('#c')<br>
70
+ <div class="text-white bg-slate-800 p-5 rounded-xl shadow-2xl font-mono text-sm break-all">
71
+ ns.show('Loading component A').inside('#a')<br>
72
+ ns.show('Loading component B').inside('#b')<br>
73
+ ns.show('Loading component C').inside('#c')<br>
64
74
  <br><br>
65
- ns.hide() // Removes instances in a FIFO manner.<br>
75
+ ns.hide() // Removes instances in a LIFO manner.<br>
66
76
  ns.hideAll() // Removes all instances.
67
77
  </div>
68
78
  </div>
69
79
  </div>
70
80
  <footer>
71
81
  <script type="module" src="/src/main.ts"></script>
82
+ <script>
83
+ document.getElementById('copy').onclick = function () {
84
+ const text = document.querySelector('[data-copy]').innerText
85
+ navigator.clipboard.writeText(text)
86
+ alert('Copied to clipboard!')
87
+ }
88
+ window.onload = () => {
89
+ setTimeout(() => {
90
+ window.installNanosplash({spinner: true})
91
+ }, 100)
92
+ }
93
+ </script>
72
94
  </footer>
73
95
  <style>
74
96
  body {
75
97
  min-height: 100vh;
76
98
  }
77
- .pill {
78
- font-size: 10px;
79
- padding: 0.2em 0.5em;
80
- }
81
99
  </style>
82
100
  </body>
83
101
  </html>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "nanosplash",
3
- "description": "The simple, 2KB loading screen",
4
- "version": "2.3.3",
3
+ "description": "The simple, tiny loading screen",
4
+ "version": "2.4.0",
5
5
  "author": {
6
6
  "name": "Isak K. Hauge",
7
7
  "email": "isakhauge@gmail.com",
@@ -55,19 +55,19 @@
55
55
  "test": "jest"
56
56
  },
57
57
  "devDependencies": {
58
- "@types/jest": "^27.5.0",
58
+ "@types/jest": "^28.1.1",
59
59
  "@types/jsdom": "^16.2.14",
60
60
  "autoprefixer": "^10.4.7",
61
- "cssnano": "^5.1.7",
62
- "jest": "^28.1.0",
63
- "jest-environment-jsdom": "^28.1.0",
61
+ "cssnano": "^5.1.11",
62
+ "jest": "^28.1.1",
63
+ "jest-environment-jsdom": "^28.1.1",
64
64
  "jsdom": "^19.0.0",
65
- "postcss": "^8.4.13",
66
- "sass": "^1.51.0",
67
- "ts-jest": "^28.0.2",
68
- "ts-node": "^10.7.0",
69
- "typedoc": "^0.22.15",
70
- "typescript": "^4.6.4",
71
- "vite": "^2.9.8"
65
+ "postcss": "^8.4.14",
66
+ "sass": "^1.52.3",
67
+ "ts-jest": "^28.0.4",
68
+ "ts-node": "^10.8.1",
69
+ "typedoc": "^0.22.17",
70
+ "typescript": "^4.7.3",
71
+ "vite": "^2.9.12"
72
72
  }
73
73
  }
package/src/Core/Nanosplash.ts CHANGED
@@ -1,56 +1,105 @@
1
1
  import '../style.sass'
2
2
  import {SplashInstance} from "./SplashInstance";
3
- import {SplashJob, StrategyObject} from "../types";
3
+ import {InstanceIterationCallback, NanosplashOptions, SplashJob} from "../types";
4
4
  import {ShowInterface} from "../Interfaces/ShowInterface";
5
5
  import {NanosplashFactory} from "../Factory/NanosplashFactory";
6
6
  import {NanosplashInterface} from "../Interfaces/NanosplashInterface";
7
7
  import {ContextualAPIInterface} from "../Interfaces/ContextualAPIInterface";
8
8
 
9
+ /**
10
+ * # Nanosplash
11
+ * @author Isak K. Hauge <isakhauge@gmail.com>
12
+ */
9
13
  export class Nanosplash implements NanosplashInterface {
10
14
  public static APP_NAME = 'Nanosplash'
15
+ public imgSrc: string | undefined
16
+ public showSpinner: boolean
17
+ public fontSize: string
11
18
  public readonly instances: Map<string, SplashInstance>
12
19
 
13
- public constructor() {
20
+ /**
21
+ * Options passed to the constructor will persist in the instance.
22
+ * @param {NanosplashOptions | undefined} options Nanosplash options object.
23
+ */
24
+ public constructor(options?: NanosplashOptions) {
25
+ this.imgSrc = options?.imgSrc ?? undefined
26
+ this.showSpinner = options?.spinner ?? false
27
+ this.fontSize = options?.fontSize ?? '18px'
14
28
  this.instances = new Map<string, SplashInstance>()
15
29
  }
16
30
 
17
- public img(src: string): StrategyObject {
18
- return NanosplashFactory.createImgFunction(this, new SplashInstance(this, '', src))(src)
19
- }
20
-
31
+ /**
32
+ * # Show
33
+ * @param {string} text
34
+ */
21
35
  public show(text: string): ContextualAPIInterface {
22
- return NanosplashFactory.createShowFunction(this, new SplashInstance(this, text))(text)
36
+ return NanosplashFactory.createShowFunction(this, new SplashInstance(this, text, this.imgSrc))(text)
23
37
  }
24
38
 
39
+ /**
40
+ * # Progress
41
+ * @param {SplashJob[]} jobs An array or list of Splash jobs.
42
+ * @return ContextualAPIInterface
43
+ */
25
44
  public progress(...jobs: SplashJob[]): ContextualAPIInterface {
26
- return NanosplashFactory.createProgressFunction(this, new SplashInstance(this, ''))(...jobs)
45
+ return NanosplashFactory.createProgressFunction(this, new SplashInstance(this, '', this.imgSrc))(...jobs)
27
46
  }
28
47
 
48
+ /**
49
+ * # While
50
+ * @param {Promise<any>} asyncTask An asynchronous function or Promise.
51
+ * @return ContextualAPIInterface
52
+ */
29
53
  public while(asyncTask: Promise<any>): ShowInterface {
30
- return NanosplashFactory.createWhileFunction(this, new SplashInstance(this, ''))(asyncTask)
54
+ return NanosplashFactory.createWhileFunction(this, new SplashInstance(this, '', this.imgSrc))(asyncTask)
31
55
  }
32
56
 
33
- private fifoIterate(callback: (id: string, splashInstance: SplashInstance, i: number) => boolean): void {
34
- let i = 0
35
- const instanceEntries = this.instances.entries()
36
- for (const [id, splashInstance] of instanceEntries) {
37
- if (!callback(id, splashInstance, i++)) {
57
+ /**
58
+ * # LIFO Iterate
59
+ * This function will iterate through the splash instances in a LIFO (last in, first out) manner, invoke the
60
+ * callback for each instance and pass the instance as an argument.
61
+ * @param {InstanceIterationCallback} callback This callback will be invoked for each instance.
62
+ * @private
63
+ */
64
+ private lifoIterate(callback: InstanceIterationCallback): void {
65
+ const n = this.instances.size
66
+ const instances = Array.from(this.instances.values())
67
+ for (let i = n - 1; i >= 0; i--) {
68
+ console.log({
69
+ size: n,
70
+ lastIdx: n - 1,
71
+ currentIdx: i
72
+ })
73
+ const instance = instances[i]
74
+ const id = instance.getId()
75
+ if (!callback(id, instance, i)) {
38
76
  break
39
77
  }
40
78
  }
41
79
  }
42
80
 
81
+ /**
82
+ * # Delete
83
+ * @param {SplashInstance} splashInstance
84
+ */
43
85
  public delete(splashInstance: SplashInstance): void {
44
86
  this.instances.delete(splashInstance.getId())
45
87
  }
46
88
 
89
+ /**
90
+ * # Hide All
91
+ * Delete all Splash instances.
92
+ */
47
93
  public hideAll(): void
48
94
  {
49
- this.instances.forEach(
50
- (instance: SplashInstance) => instance.delete()
51
- )
95
+ this.instances.forEach((instance: SplashInstance) => instance.delete())
52
96
  }
53
97
 
98
+ /**
99
+ * # Hide
100
+ * Delete specific Splash instance or the latest one.
101
+ * @param id
102
+ */
54
103
  public hide(id?: string): void {
55
104
  if (id) {
56
105
  const splashInstance = this.instances.get(id)
@@ -62,8 +111,9 @@ export class Nanosplash implements NanosplashInterface {
62
111
  )
63
112
  }
64
113
  } else {
65
- this.fifoIterate((_: string, splashInstance: SplashInstance, i: number) => {
66
- const remove = i === 0
114
+ const n = this.instances.size
115
+ this.lifoIterate((_: string, splashInstance: SplashInstance, i: number) => {
116
+ const remove = i === n - 1
67
117
  if (remove) {
68
118
  splashInstance.delete()
69
119
  }
@@ -72,6 +122,11 @@ export class Nanosplash implements NanosplashInterface {
72
122
  }
73
123
  }
74
124
 
125
+ /**
126
+ * # Get Splashes With Destination Node
127
+ * Returns Splash instances having the given destination node.
128
+ * @param {HTMLElement} node
129
+ */
75
130
  public getSplashesWithDestinationNode(node: HTMLElement): SplashInstance[]
76
131
  {
77
132
  const fnSameDestinationNode = (v: SplashInstance) => v.getDestination() === node