nanosplash 2.5.3 → 3.0.1

package/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: Build and Test
+
+on:
+  push:
+    branches:
+      - production
+  pull_request:
+    branches:
+      - production
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20'
+
+      - name: Set up Git and update production branch
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "actions@github.com"
+          git checkout production
+          git fetch
+          git pull --no-rebase
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build (Vite)
+        run: yarn build
+
+      - name: Test (Vitest)
+        run: yarn test
+
+      - name: Generate Code Coverage (Vitest)
+        run: yarn coverage
+
+      - name: Commit and push changes
+        run: |
+          git add .
+          git commit --allow-empty -m "Build, test, and coverage report"
+          git push

package/.prettierrc

@@ -1,11 +1,12 @@
 {
-	"tabWidth": 2,
-	"useTabs": true,
-	"singleQuote": true,
-	"bracketSpacing": true,
-	"jsxSingleQuote": true,
-	"endOfLine": "lf",
-	"trailingComma": "es5",
-	"arrowParens": "avoid",
-	"semi": false
+  "tabWidth": 2,
+  "useTabs": true,
+  "singleQuote": true,
+  "bracketSpacing": true,
+  "jsxSingleQuote": true,
+  "endOfLine": "lf",
+  "trailingComma": "es5",
+  "arrowParens": "avoid",
+  "semi": false,
+  "printWidth": 80
 }

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Isak Hauge
+Copyright (c) 2023 Isak Hauge
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,124 +1,191 @@
-# nanosplash 🍩
+# Nanosplash
 
-![npm](https://img.shields.io/npm/v/nanosplash)
-![Minified+gzip size](https://badgen.net/bundlephobia/minzip/nanosplash)
-![Minified size](https://badgen.net/bundlephobia/dependency-count/nanosplash)
-![Tree shaking](https://badgen.net/bundlephobia/tree-shaking/nanosplash)
+### The tiny loading screen for web artisans
 
-![npm maintenance score](https://img.shields.io/npms-io/maintenance-score/nanosplash)
-![npm quality score](https://img.shields.io/npms-io/quality-score/nanosplash)
-![npm final score](https://img.shields.io/npms-io/final-score/nanosplash)
-![npm popularity score](https://img.shields.io/npms-io/popularity-score/nanosplash)
+<br>
 
-<strong>The simple, tiny loading screen</strong>
+[![Build](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml/badge.svg?branch=production)](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/nanosplash) [![Coverage](https://img.shields.io/badge/Coverage-99%25-brightgreen)](./coverage/index.html) [![TypeScript](https://badges.frapsoft.com/typescript/version/typescript-next.svg?v=101)](https://github.com/ellerbrock/typescript-badges/) [![Last Commit](https://img.shields.io/github/last-commit/isakhauge/nanosplash)](https://github.com/isakhauge/nanosplash/commits/production)
 
-# Getting started
+<br>
 
-## Import via CDN (recommended)
+## Get started
+
+### Install via CDN
+
+When installing via CDN, you will always get the latest version, and CSS is included inside the bundle.
 
 ```html
-<script src="https://unpkg.com/nanosplash/dist/iife/nanosplash.iife.js"></script>
-```
-```js
-// Install Nanosplash in the browser
-window.installNanosplash()
-// Display your first Nanosplash
-window.ns.show('Hello world')
+<script src="https://unpkg.com/nanosplash/dist/latest/iife/ns.iife.js">
 ```
 
-## Install (advanced)
+Pros:
+
+- Easy to get started.
+- Always get the latest version.
+- CSS is included inside the bundle.
+
+Cons:
+
+- Always get the latest version.
+
+### Install via NPM
+
 ```bash
 yarn add nanosplash
 ```
 
-### Modules
+```js
+import { Service } from 'nanosplash'
+Service.start()
+```
 
-When including either ES or CJS modules, you need the CSS in the dist folder, whereas in the IIFE variant, everything is included. If you are using a modern bundler e.g Vite, NextJS, NuxtJS, you can import the CSS directly into your code.
+The CSS file is located in the following path:
 
-```js
-import 'nanosplash/dist/module/style.css'
+```text
+node_modules/nanosplash/dist/latest/es/style.css
 ```
 
-> ### Location of the stylesheet
->
-> Full: `node_modules/nanosplash/dist/module/style.css`<br>
-> Relative: `nanosplash/dist/module/style.css`
+### Example usage
 
-#### ESM (ES modules)
+It's so simple to use.
 
 ```js
-import { Nanosplash } from 'nanosplash'
+// Display a fullscreen loading screen
+ns.show('Loading')
+
+axios.get('/api/users')
+    .then((response) => /* Do something */ )
+    .finally(() => {
+        // Hide it when you're done
+        ns.hide()
+    })
 ```
 
-#### CJS (CommonJS)
+### TLDR
 
 ```js
-const Nanosplash = require('nanosplash')
+// Fullscreen spinning wheel
+ns.show()
+
+// Fullscreen spinning wheel with text
+ns.show('Loading')
+
+// Display inside an element
+ns.showInside('#my-table', 'Fetching data')
+
+// Hide the last created loading screen (LIFO)
+ns.hide()
+
+// Hide loading screen inside an element
+ns.hideInside('#my-table')
+
+// Hide specific loading screen
+const id = ns.show('Loading')
+ns.hideId(id)
+
+// Hide all loading screens
+ns.hideAll()
 ```
 
-### Inject Nanosplash into global scope
-#### Using CDN
-```js
-const nsOptions = {
-    spinner: true,
-    fontSize: '18px',
-}
-window.installNanosplash(nsOptions)
+## API Documentation
+
+### Show
+
+This method displays a fullscreen loading screen and returns a GUID string.
+
+```ts
+ns.show(text?: string): GUIDString
 ```
-#### Using modules
+
+If you enter no text, it will display the spinning wheel only.
+
 ```js
-const nsOptions = {
-    spinner: true,
-    fontSize: '18px',
-}
-window.ns = new Nanosplash(nsOptions)
+ns.show() // Spinner only
+ns.show('Loading') // Spinner with text
 ```
 
-## Basic usage
+### Show inside
 
-### Display the loading screen
+This method displays a fullscreen loading screen inside an element and returns a GUID string.
 
-```js
-ns.show('Loading the good stuff')
+```ts
+ns.showInside(ref: Reference, text?: string): GUIDString | null
 ```
 
-### Hide the loading screen
+The `Reference` type is a union type of `string | Element`. The `string` type is a CSS selector string. The `Element` type is a DOM element.
 
 ```js
-// Hide one at a time
-ns.hide()
+// Both works
+const selector = '#my-table'
+const element = document.getElementById('my-table')
+ns.showInside(selector, 'Loading')
+ns.showInside(element, 'Loading')
+```
 
-// Hide all
-ns.hideAll()
+### Hide
+
+Hides the last created loading screen (LIFO).
+
+```ts
+ns.hide(): GUIDString | null
+```
+
+The reason why the hide function works in a LIFO (last in first out) manner is because you should always see the loading screen that you want to hide, which will always be the last one you created.
+
+```js
+ns.show('a')
+ns.show('b')
+ns.show('c')
+ns.hide() // Hides 'c'
+ns.hide() // Hides 'b'
+ns.hide() // Hides 'a'
 ```
 
-## Advanced usage
+> 💡 **PRO Tip:** If you have multiple loading screens open at the same time, I would recommend that you hide specific elements based on their GUID or host element. See `hideId` and `hideInside` for more information.
 
-### Display the loading screen inside an element
+### Hide by ID
+
+Hides the Nanosplash loading screen with the given GUID string.
+
+```ts
+ns.hideId(guid: GUIDString): GUIDString | null
+```
+
+The show methods always retrun a GUID. This identifier can be used to hide specific loading screens.
 
 ```js
-// Use CSS selector string
-ns.show('Loading component').inside('#my-element')
+const id = ns.show('Loading')
+ns.hideId(id)
+```
+
+### Hide inside
 
-// Use HTMLElement objects directly
-ns.show('Loading component').inside(document.getElementById('my-element'))
+Hides the Nanosplash loading screen inside another element — if any — that corresponds with the given element reference. Returns the GUID string of the loading screen that was hidden, or null if no loading screen was found inside.
+
+```ts
+ns.hideInside(ref: Reference): GUIDString | null
 ```
 
-### Combine Nanosplash with async tasks
+This method works almost the same way as `hideId`, but instead of using the GUID string as the identifier, it uses the host element as the identifier.
 
 ```js
-const task1 = new Promise(r => setTimeout(r, 3000))
-const task2 = async () => await getDataFromApi()
+const selector = '#my-table'
+ns.showInside(selector, 'Loading')
+ns.hideInside(selector)
+```
 
-ns.while(task1).show('Loading resources')
-ns.while(task2).show('Fetching table data').inside('#my-table')
+You can also use the `Element` type as the reference.
 
-ns.progress(
-    [task1, 'Loading data from API'],
-    [task2, 'Processing data']
-).inside('#my-table')
+```js
+const element = document.getElementById('my-table')
+ns.showInside(element, 'Loading')
+ns.hideInside(element)
 ```
 
-<hr>
+### Hide all
 
-## If you like it, give it a star! ⭐️
+Hide all Nanosplash loading screens.
+
+```ts
+ns.hideAll(): void
+```

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);