@tsparticles/nuxt3 4.0.0-beta.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Matteo Bruni
+
+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

@@ -0,0 +1,56 @@
+[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)
+
+# @tsparticles/nuxt3
+
+Nuxt module for [@tsparticles/vue3](https://www.npmjs.com/package/@tsparticles/vue3) with client-side registration only.
+
+This package does not enforce `slim`/`full` presets. The app controls what to load in its own `registerParticles` function.
+
+## Installation
+
+```bash
+pnpm add @tsparticles/nuxt3 @tsparticles/vue3 @tsparticles/engine
+```
+
+## Usage
+
+Add the module in `nuxt.config.ts`:
+
+```ts
+import { defineNuxtConfig } from "nuxt/config";
+
+export default defineNuxtConfig({
+  modules: ["@tsparticles/nuxt3"],
+});
+```
+
+Create `utils/particlesInit.ts`:
+
+```ts
+import type { Engine } from "@tsparticles/engine";
+
+export async function registerParticles(engine: Engine): Promise<void> {
+  const [{ loadSlim }] = await Promise.all([import("@tsparticles/slim")]);
+
+  await loadSlim(engine);
+}
+```
+
+The module loads `~/utils/particlesInit` by default. You can customize it:
+
+```ts
+import { defineNuxtConfig } from "nuxt/config";
+
+export default defineNuxtConfig({
+  modules: ["@tsparticles/nuxt3"],
+  tsparticles: {
+    initPath: "~/particles/customInit",
+  },
+});
+```
+
+## Notes
+
+- The module registers `@tsparticles/vue3` only on the client.
+- Required export in the init file: `registerParticles(engine)`.
+- Keep `registerParticles` focused on your app needs (load only desired plugins/bundles).

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import type { NuxtModule } from "@nuxt/schema";
+export interface ITsParticlesNuxtOptions {
+    initPath?: string;
+}
+declare module "@nuxt/schema" {
+    interface NuxtConfig {
+        tsparticles?: ITsParticlesNuxtOptions;
+    }
+    interface NuxtOptions {
+        tsparticles?: ITsParticlesNuxtOptions;
+    }
+}
+declare const tsParticlesNuxtModule: NuxtModule<ITsParticlesNuxtOptions>;
+export default tsParticlesNuxtModule;

package/dist/index.js

@@ -0,0 +1,34 @@
+import { addPlugin, addTemplate, defineNuxtModule } from "@nuxt/kit";
+const tsParticlesNuxtModule = defineNuxtModule({
+    meta: {
+        name: "@tsparticles/nuxt3",
+        configKey: "tsparticles",
+        compatibility: {
+            nuxt: ">=3.0.0 <4",
+        },
+    },
+    defaults: {
+        initPath: "~/utils/particlesInit",
+    },
+    setup(options) {
+        const initPath = options.initPath ?? "~/utils/particlesInit";
+        const pluginPath = addTemplate({
+            filename: "tsparticles.client.mjs",
+            getContents: () => `import { defineNuxtPlugin } from "#app";
+import VueParticles from "@tsparticles/vue3";
+import { registerParticles } from "${initPath}";
+
+export default defineNuxtPlugin((nuxtApp) => {
+  nuxtApp.vueApp.use(VueParticles, {
+    init: registerParticles,
+  });
+});
+`,
+        }).dst;
+        addPlugin({
+            src: pluginPath,
+            mode: "client",
+        });
+    },
+});
+export default tsParticlesNuxtModule;

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@tsparticles/nuxt3",
+  "version": "4.0.0-beta.12",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "prettier --write README.md && pnpm run prettify && tsc -p tsconfig.json",
+    "build:ci": "prettier --check README.md && pnpm run prettify:ci && tsc -p tsconfig.json",
+    "lint": "eslint . --max-warnings 0",
+    "prettify": "prettier --write \"lib/**/*.ts\"",
+    "prettify:ci": "prettier --check \"lib/**/*.ts\"",
+    "prepublishOnly": "pnpm run build"
+  },
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@nuxt/kit": "^4.4.2",
+    "@tsparticles/engine": "^4.0.0-beta.12",
+    "@tsparticles/vue3": "^4.0.0-beta.12"
+  },
+  "peerDependencies": {
+    "nuxt": "^3.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@nuxt/schema": "^4.4.2",
+    "@typescript-eslint/eslint-plugin": "^8.58.2",
+    "@typescript-eslint/parser": "^8.58.2",
+    "eslint": "^10.2.0",
+    "globals": "^17.5.0",
+    "typescript": "^6.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "bdbc95716ce44665fbecfaca8757445e248b562d"
+}