nanosplash 4.0.7 → 4.0.16

package/.github/workflows/bun-build.reusable.yml

@@ -0,0 +1,32 @@
+# .github/workflows/reusables/bun-build.yml
+name: Reusable - Bun Build
+
+on:
+  workflow_call:
+    inputs:
+      working-directory:
+        description: "Directory of the project (if not repo root)"
+        required: false
+        type: string
+        default: "."
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ${{ inputs.working-directory }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Build
+        run: bun run build

package/.github/workflows/bun-lint.reusable.yml

@@ -0,0 +1,32 @@
+# .github/workflows/reusables/bun-lint.yml
+name: Reusable - Bun Lint
+
+on:
+  workflow_call:
+    inputs:
+      working-directory:
+        description: "Directory of the project (if not repo root)"
+        required: false
+        type: string
+        default: "."
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ${{ inputs.working-directory }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Lint
+        run: bun run lint

package/.github/workflows/bun-npm-publish.reusable.yml

@@ -0,0 +1,47 @@
+name: Reusable - Bun NPM Publish (Trusted Publisher)
+
+on:
+  workflow_call:
+    inputs:
+      working-directory:
+        description: "Directory of the package"
+        required: false
+        type: string
+        default: "."
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    # Required for npm Trusted Publishing (OIDC)
+    permissions:
+      id-token: write
+      contents: read
+
+    defaults:
+      run:
+        working-directory: ${{ inputs.working-directory }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # 1) Use Bun for install & build
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Build package
+        run: bun run build
+
+      # 2) Use Node 24 + newest npm *just* for publication
+      - name: Setup Node for publish
+        uses: actions/setup-node@v4
+        with:
+          node-version: "24.x"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm publish

package/.github/workflows/bun-test.reusable.yml

@@ -0,0 +1,43 @@
+name: Reusable - Bun Test + Coverage (Coveralls)
+
+on:
+  workflow_call:
+    inputs:
+      working-directory:
+        description: "Directory of the project (if not repo root)"
+        required: false
+        type: string
+        default: "."
+      upload-to-coveralls:
+        description: "Whether to upload coverage to Coveralls"
+        required: false
+        type: boolean
+        default: true
+
+jobs:
+  test-coverage:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ${{ inputs.working-directory }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Run tests with coverage
+        run: bun run test
+
+#      - name: Upload coverage to Coveralls
+#        if: ${{ inputs.upload-to-coveralls }}
+#        uses: coverallsapp/github-action@v2
+#        with:
+#          github-token: ${{ secrets.GITHUB_TOKEN }}
+#          path-to-lcov: ${{ inputs.working-directory }}/coverage/lcov.info

package/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+# .github/workflows/ci.yml
+name: Nanosplash CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  build:
+    uses: ./.github/workflows/bun-build.reusable.yml
+    with:
+      working-directory: .
+
+  test:
+    needs: build
+    uses: ./.github/workflows/bun-test.reusable.yml
+    with:
+      working-directory: .
+      upload-to-coveralls: true
+
+  lint:
+    needs: build
+    uses: ./.github/workflows/bun-lint.reusable.yml
+    with:
+      working-directory: .

package/.github/workflows/release.yml

@@ -0,0 +1,13 @@
+# .github/workflows/release.yml
+name: Release Nanosplash
+
+on:
+  push:
+    tags:
+      - "v*.*.*"  # e.g. v1.2.3
+
+jobs:
+  publish:
+    uses: ./.github/workflows/bun-npm-publish.reusable.yml
+    with:
+      working-directory: .

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Nanosplash, Copyright (c) 2025 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,30 +2,35 @@
 
 **The tiny loading screen for web artisans**
 
-[![CI Production: Build, Test, Publish](https://github.com/isakhauge/nanosplash/actions/workflows/ci.prod.push.yml/badge.svg)](https://github.com/isakhauge/nanosplash/actions/workflows/ci.prod.push.yml)
-[![Coverage Status](https://coveralls.io/repos/github/isakhauge/nanosplash/badge.svg?branch=production)](https://coveralls.io/github/isakhauge/nanosplash?branch=production)
+[![CI Production: Build, Test](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml/badge.svg)](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/isakhauge/nanosplash/badge.svg?branch=main)](https://coveralls.io/github/isakhauge/nanosplash?branch=main)
 
 ---
 
-## 🚀 Introduction
+### Nanosplash is a 3KB zero-dependency library for effortless loading screens. Its 2-function API lets you add fullscreen or container-based spinners in seconds, fully customizable with CSS. Fast, beautiful, and simple.
 
-Nanosplash provides a lightweight and customizable loading screen for your web applications. Whether you want a simple spinner or a fully branded loading experience, Nanosplash makes it easy to implement and customize.
+```js
+// Display spinner fullscreen
+show('Loading')
 
----
+// Display spinner in target
+show('Loading', '#my-div')
 
-## ✨ Features
+// Hide spinner
+hide()
+```
 
-- 🔬 Tiny size: Only 3KB – ideal for lean, fast applications.
-- ⚡ High performance: Engineered for speed and responsiveness.
-- ✅ Zero dependencies: No extra baggage – pure JavaScript!
-- 🎨 Minimalistic design: Easily integrates with other designs.
-- 🚚 Exports in multiple formats: Supports ESM, CJS, and IIFE.
-- 📘 TypeScript support: Fully typed. Better DX.
-- ✌️ 2 Function API: Small, simple – just what you need.
+## Features
 
----
+- **Tiny**: Only 3KB
+- **Performance**: Created to be fast.
+- **Zero dependencies**: Pure JS.
+- **Beautiful**: Good and generic design.
+- **Modules**: Supports ESM, CJS, and IIFE.
+- **TypeScript support**: Fully typed.
+- **2 Function API**: Easy to use.
 
-## 📦 Installation
+## Installation
 
 Include Nanosplash in your project via your preferred method (e.g., CDN, module bundler). Example:
 
@@ -39,79 +44,75 @@ or
 npm install nanosplash
 ```
 
----
-
-## 🎯 API Documentation
+## API Documentation
 
-### `ns.show(text?, target?)`
+### Show
 
-Displays a Nanosplash.
+The show function displays a Nanosplash loading indicator on your page.
+You can pass in optional text to display with the spinner, and an optional target element (or CSS selector) to control where it appears.
+If no target is provided, Nanosplash will create a fullscreen splash covering the entire viewport.
 
-| Parameter | Type                             | Description                                                 |
-|-----------|----------------------------------|-------------------------------------------------------------|
-| `text`    | `string \| undefined`            | Optional. Text to display alongside the spinner.            |
-| `target`  | `string \| Element \| undefined` | Optional. CSS selector or an element to contain the splash. |
+```ts
+show(text?: string, target?: string | Element): number
+```
 
 #### Examples:
 
-- **Fullscreen spinner only:**
+**Fullscreen spinner only:**
 
   ```js
   ns.show()
   ```
 
-- **Fullscreen text and spinner:**
+**Fullscreen text and spinner:**
 
   ```js
   ns.show('Loading...')
   ```
 
-- **Spinner only within a specific element:**
+**Spinner only within a specific element:**
 
   ```js
   ns.show(null, '#my-div')
   ```
 
-- **Text and spinner within a specific element:**
+**Text and spinner within a specific element:**
 
   ```js
   ns.show('Please wait', '#my-div')
   ```
 
----
-
-### `ns.hide(id?)`
-
-Hides or removes a Nanosplash.
+### Hide
 
-| Parameter | Type                  | Description                                                |
-|-----------|-----------------------|------------------------------------------------------------|
-| `id`      | `number \| undefined` | Optional. The ID of the Nanosplash to remove.              |
+The hide function removes one or more Nanosplash loading indicators from your page.
+By default, it removes the oldest fullscreen splash (FIFO). If you want to remove a specific splash, you can pass its ID (returned by show).
+You can also remove all splashes at once by passing the wildcard '*'.
 
+```ts
+hide(id?: number | '*'): void
+```
 #### Examples:
 
-- **Remove the oldest (FIFO) fullscreen Nanosplash:**
+**Remove the oldest (FIFO) fullscreen Nanosplash:**
 
   ```js
   ns.hide()
   ```
 
-- **Remove a specific Nanosplash by ID:**
+**Remove a specific Nanosplash by ID:**
 
   ```js
   const id = ns.show() // 1700000000000
   ns.hide(id)
   ```
 
-- **Remove all Nanosplashes:**
+**Remove all Nanosplashes:**
 
   ```js
   ns.hide('*')
   ```
 
----
-
-## 🎨 Customization
+## Customization
 
 Nanosplash is designed to be fully customizable with CSS. You can style its key parts using these selectors:
 
@@ -122,9 +123,7 @@ Nanosplash is designed to be fully customizable with CSS. You can style its key
 | `.nst`          | Text element                              |
 | `.nss`          | Spinner element                           |
 
----
-
-## 🛠️ Examples
+## Examples
 
 Here’s a quick snippet to show a loading indicator while fetching data:
 
@@ -147,10 +146,6 @@ Here’s a quick snippet to show a loading indicator while fetching data:
 </script>
 ```
 
----
-
 ## 💖 Contributing & Feedback
 
-Found a bug or have a feature request? Visit the [GitHub repository](https://github.com/isakhauge/nanosplash) and open an issue or pull request!
-
----
+Found a bug or have a feature request? Visit the [GitHub repository](https://github.com/isakhauge/nanosplash) and open an issue or pull request!