{"id":26898734,"url":"https://github.com/yisibell/nuxt-spritesmith","last_synced_at":"2026-02-26T15:40:21.385Z","repository":{"id":284346669,"uuid":"954625514","full_name":"yisibell/nuxt-spritesmith","owner":"yisibell","description":"A Nuxt(3) module for generate sprite image icons via spritesmith","archived":false,"fork":false,"pushed_at":"2025-04-25T10:05:36.000Z","size":2740,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-25T10:43:04.899Z","etag":null,"topics":["nuxt","nuxt3","sprite-icon","sprite-image","spritesheet","spritesmith"],"latest_commit_sha":null,"homepage":"","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/yisibell.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":"2025-03-25T11:20:28.000Z","updated_at":"2025-04-25T10:05:40.000Z","dependencies_parsed_at":"2025-03-25T12:49:58.233Z","dependency_job_id":null,"html_url":"https://github.com/yisibell/nuxt-spritesmith","commit_stats":null,"previous_names":["yisibell/nuxt-spritesmith"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yisibell%2Fnuxt-spritesmith","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yisibell%2Fnuxt-spritesmith/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yisibell%2Fnuxt-spritesmith/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yisibell%2Fnuxt-spritesmith/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yisibell","download_url":"https://codeload.github.com/yisibell/nuxt-spritesmith/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253857187,"owners_count":21974695,"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":["nuxt","nuxt3","sprite-icon","sprite-image","spritesheet","spritesmith"],"created_at":"2025-04-01T05:55:55.423Z","updated_at":"2026-02-26T15:40:16.366Z","avatar_url":"https://github.com/yisibell.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.org/package/nuxt-spritesmith\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/nuxt-spritesmith.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://npmcharts.com/compare/nuxt-spritesmith?minimal=true\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/nuxt-spritesmith.svg\"\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n# nuxt-spritesmith\n\n\u003e A Nuxt(3) module for generate sprite image icons via [spritesmith](https://github.com/twolfson/spritesmith) \n\n- [✨ \u0026nbsp;Release Notes](/CHANGELOG.md)\n\n\n## Features\n\n- Powered by [spritesmith](https://github.com/twolfson/spritesmith).\n- Support Multi sprite sheet generation.\n\n\n## Quick Setup\n\n1. Add `nuxt-spritesmith` dependency to your project\n\n```bash\n# Using pnpm\npnpm add -D nuxt-spritesmith\n\n# Using yarn\nyarn add --dev nuxt-spritesmith\n\n# Using npm\nnpm install --save-dev nuxt-spritesmith\n```\n\n2. Add `nuxt-spritesmith` to the `modules` section of `nuxt.config.ts`\n\n```js\nexport default defineNuxtConfig({\n  modules: [\n    'nuxt-spritesmith'\n  ],\n  // custom nuxt-spritesmith options\n  spritesmith: {\n    // ...\n  }\n})\n```\n\n3. Put your icons in `~/assets/sprites` folder.\n\n\n\n4. Using your sprite icon.\n\n``` vue\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n     \u003cspan class=\"sprite-some sprite-some--your-icon-name\"\u003e\u003c/span\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\nThat's it! You can now use **nuxt-spritesmith** in your Nuxt app ✨\n\n\n## Options\n\n| Key | Default value | Description |\n| :---: | :---: | :---: |\n| `srcDir`| `assets/sprites` | Sprite image source dir |\n| `outputDir` | `public/sprites` | Sprite sheet output dir |\n| `spriteConfig` | - | Spritesmith generate CSS options |\n| `retina` | - | Config for retina |\n| `prefix` | `'sprite-'` | Define sprite icon class name prefix |\n| `cssTemplate` | - | Custom css template |\n| `enableDevWatch` | - | Whether to enable watcher for the development env |\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Generate type stubs\npnpm dev:prepare\n\n# Develop with the playground\npnpm dev\n\n# Build the playground\npnpm dev:build\n\n# Run ESLint\npnpm lint\n\n# Run Vitest\npnpm test\npnpm test:watch\n\n# Release new version\nnpm run release\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyisibell%2Fnuxt-spritesmith","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyisibell%2Fnuxt-spritesmith","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyisibell%2Fnuxt-spritesmith/lists"}