{"id":20196132,"url":"https://github.com/joepocalyptic/nuxt-particles","last_synced_at":"2025-04-09T20:14:30.977Z","repository":{"id":189626363,"uuid":"680986177","full_name":"Joepocalyptic/nuxt-particles","owner":"Joepocalyptic","description":"Run lightweight, heavily customizable particle simulations in your Nuxt project with tsParticles.","archived":false,"fork":false,"pushed_at":"2025-04-08T19:28:55.000Z","size":670,"stargazers_count":34,"open_issues_count":15,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T20:14:26.365Z","etag":null,"topics":["animations","nuxt","nuxt-module","nuxt3","particles","particles-animations","tsparticles"],"latest_commit_sha":null,"homepage":"https://nuxt-particles.joeypereira.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Joepocalyptic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-21T02:37:16.000Z","updated_at":"2025-03-16T21:50:22.000Z","dependencies_parsed_at":"2023-10-12T17:44:07.049Z","dependency_job_id":"7cf8ac64-7ab3-4636-b9ef-b7566cbd9c87","html_url":"https://github.com/Joepocalyptic/nuxt-particles","commit_stats":{"total_commits":21,"total_committers":2,"mean_commits":10.5,"dds":"0.19047619047619047","last_synced_commit":"1be6b87316ca99d3ca27dcd9d5ccc4bb7c92c0a7"},"previous_names":["joepocalyptic/nuxt-particles"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-particles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-particles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-particles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-particles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Joepocalyptic","download_url":"https://codeload.github.com/Joepocalyptic/nuxt-particles/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103872,"owners_count":21048245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animations","nuxt","nuxt-module","nuxt3","particles","particles-animations","tsparticles"],"created_at":"2024-11-14T04:21:55.829Z","updated_at":"2025-04-09T20:14:30.931Z","avatar_url":"https://github.com/Joepocalyptic.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nuxt Particles\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n\nRun lightweight, heavily customizable particle simulations in your Nuxt project with tsParticles.\n\n- [📖 \u0026nbsp;Documentation](https://nuxt-particles.joeypereira.dev)\n- [✨ \u0026nbsp;Release Notes](/CHANGELOG.md)\n- [🏀 Online playground](https://stackblitz.com/github/Joepocalyptic/nuxt-particles?file=playground%2Fapp.vue)\n\n## Features\n\n- Built for **Nuxt 3**\n- **Lazy loading** by default\n- Built-in full, slim, and basic bundles, or\n- Use a custom bundle for extra performance\n- All with just **one component**!\n\n## Quick Setup\n\n1. Add the `nuxt-particles` dependency to your project\n\n```bash\n# Using pnpm\npnpm add -D nuxt-particles\n\n# Using yarn\nyarn add --dev nuxt-particles\n\n# Using npm\nnpm install --save-dev nuxt-particles\n```\n\n2. Add `nuxt-particles` to the `modules` section of `nuxt.config.ts`\n\n```js\nexport default defineNuxtConfig({\n  modules: [\n    'nuxt-particles'\n  ]\n})\n```\n\nThat's it! You can now use the \u0026lt;NuxtParticles\u0026gt; component in your application! ✨\n\nRead the [documentation](https://nuxt-particles.joeypereira.dev) for more information, including\nconfiguration and optimization options. Documentation on how to configure the particles themselves\nis available on [tsparticles's website](https://particles.js.org/).\n\nExample:\n\n```vue\n\u003ctemplate\u003e\n  \u003cNuxtParticles\n    id=\"tsparticles\"\n    url=\"/path/to/particles.json\"\n    @load=\"onLoad\"\n  \u003e\u003c/NuxtParticles\u003e\n  \n  \u003c!-- or --\u003e\n  \n  \u003cNuxtParticles\n    id=\"tsparticles\"\n    :options=\"options\"\n    @load=\"onLoad\"\n  \u003e\u003c/NuxtParticles\u003e\n\u003c/template\u003e\n\n\u003cscript setup lang=\"ts\"\u003e\nimport type { Container } from '@tsparticles/engine'\n\nconst options = {\n  // See https://particles.js.org/docs/interfaces/tsParticles_Engine.Options_Interfaces_IOptions.IOptions.html\n}\n\nconst onLoad = (container: Container) =\u003e {\n  // Do something with the container\n  container.pause()\n  setTimeout(() =\u003e container.play(), 2000)\n}\n\u003c/script\u003e\n```\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Generate type stubs\npnpm run dev:prepare\n\n# Develop with the playground\npnpm run dev\n\n# Build the playground\npnpm run dev:build\n\n# Run ESLint\npnpm run lint\n\n# Release new version\npnpm run release\n```\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-particles/latest.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/nuxt-particles\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-particles.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-downloads-href]: https://npmjs.com/package/nuxt-particles\n\n[license-src]: https://img.shields.io/npm/l/nuxt-particles.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[license-href]: https://npmjs.com/package/nuxt-particles\n\n[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoepocalyptic%2Fnuxt-particles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoepocalyptic%2Fnuxt-particles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoepocalyptic%2Fnuxt-particles/lists"}