nanosplash 4.0.8 → 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,12 +2,23 @@
 
 **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)
 
 ---
 
-### Nanosplash is the ultra-lightweight JavaScript library that makes adding a polished loading experience to your web app effortless. Weighing in at just 3KB and with zero dependencies, it’s designed to be blazingly fast and beautifully simple. Whether you need a fullscreen spinner or a branded loading message within a specific container, Nanosplash’s dead-simple 2-function API (show and hide) and full CSS customization make it the perfect tool for any modern web project. Try it today and elevate your app’s loading experience with zero fuss!
+### 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.
+
+```js
+// Display spinner fullscreen
+show('Loading')
+
+// Display spinner in target
+show('Loading', '#my-div')
+
+// Hide spinner
+hide()
+```
 
 ## Features
 
@@ -41,38 +52,31 @@ 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.
 
-```txt
+```ts
 show(text?: string, target?: string | Element): number
 ```
 
-#### Parameters
-
-| 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. |
-
 #### 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')
@@ -84,31 +88,25 @@ The hide function removes one or more Nanosplash loading indicators from your pa
 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 '*'.
 
-```txt
+```ts
 hide(id?: number | '*'): void
 ```
-#### Arguments
-
-| Parameter | Type                  | Description                                                |
-|-----------|-----------------------|------------------------------------------------------------|
-| `id`      | `number \| undefined` | Optional. The ID of the Nanosplash to remove.              |
-
 #### 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('*')