{"id":13506662,"url":"https://github.com/gaven/nuxt-svg-sprite-module","last_synced_at":"2025-03-30T05:31:16.334Z","repository":{"id":33780724,"uuid":"160267677","full_name":"gaven/nuxt-svg-sprite-module","owner":"gaven","description":"A quick and dirty way to inline svg sprites in your Nuxt app.","archived":false,"fork":false,"pushed_at":"2022-12-08T22:05:39.000Z","size":410,"stargazers_count":21,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T10:49:17.590Z","etag":null,"topics":["nuxt","nuxt-module","sprites","vue"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gaven.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-03T23:32:17.000Z","updated_at":"2025-02-11T21:34:22.000Z","dependencies_parsed_at":"2023-01-15T02:28:34.147Z","dependency_job_id":null,"html_url":"https://github.com/gaven/nuxt-svg-sprite-module","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaven%2Fnuxt-svg-sprite-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaven%2Fnuxt-svg-sprite-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaven%2Fnuxt-svg-sprite-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaven%2Fnuxt-svg-sprite-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gaven","download_url":"https://codeload.github.com/gaven/nuxt-svg-sprite-module/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246281099,"owners_count":20752203,"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","nuxt-module","sprites","vue"],"created_at":"2024-08-01T01:00:55.179Z","updated_at":"2025-03-30T05:31:16.013Z","avatar_url":"https://github.com/gaven.png","language":"JavaScript","funding_links":[],"categories":["Uncategorized","JavaScript"],"sub_categories":["Uncategorized"],"readme":"# nuxt-svg-sprite-module\n\n\u003e A quick and dirty way to inline svg sprites in your Nuxt app.\n\n## Install\n\n```sh\n$ yarn add nuxt-svg-sprite-module\n\n$ npm install nuxt-svg-sprite-module --save\n```\n\n## Configure\n\nIn `nuxt.config.js`\n\n```js\nmodules: [\n  [\n    \"nuxt-svg-sprite-module\",\n    {\n      directory: \"~/assets/icons\",\n      // Optional template location: defaults to __dirname + /app.html\n      templateLocation: \"src/app.html\",\n      options: {\n        // Configuration options:\n        // https://github.com/jkphl/svg-sprite#configuration-basics\n      },\n    },\n  ],\n];\n```\n\n## Usage\n\nThis module finds svgs in your specified directory and inlines them in Nuxt's [app template](https://nuxtjs.org/guide/views/#app-template). You can pass [svg-sprite options](https://github.com/jkphl/svg-sprite#configuration-basics) to be merged with the the default configuration options.\n\nBy default, icons are prefixed with the word `icon`.\n\n```html\n\u003csvg\u003e\n  \u003cuse xlink:href=\"#icon-foo\"\u003e\u003c/use\u003e\n\u003c/svg\u003e\n```\n\nIn order to tell this module where to inline your sprite you need to include a comment within your `app.html` file. Idealy this comment would proceed the opening `\u003cbody\u003e` tag. If an `app.html` file does not exist, one will be generated in its absence.\n\n```html\n\u003c!-- svg-sprite --\u003e\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/gaven/nuxt-svg-sprite-module/issues/new)\n\n## Author\n\n#### Gaven Heim\n\n- [github/gaven](https://github.com/gaven)\n- [twitter/gavenheim](https://twitter.com/gavenheim)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaven%2Fnuxt-svg-sprite-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgaven%2Fnuxt-svg-sprite-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaven%2Fnuxt-svg-sprite-module/lists"}