Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/egoist/svg-to-vue-component
Transform SVG files into Vue SFC (with hot reloading and SVGO support)
https://github.com/egoist/svg-to-vue-component
Last synced: 5 days ago
JSON representation
Transform SVG files into Vue SFC (with hot reloading and SVGO support)
- Host: GitHub
- URL: https://github.com/egoist/svg-to-vue-component
- Owner: egoist
- License: mit
- Created: 2018-11-08T07:33:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-08T12:13:30.000Z (over 2 years ago)
- Last Synced: 2024-10-23T00:03:12.110Z (12 days ago)
- Language: JavaScript
- Homepage:
- Size: 252 KB
- Stars: 235
- Watchers: 4
- Forks: 18
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# svg-to-vue-component
[](https://npmjs.com/package/svg-to-vue-component) [](https://npmjs.com/package/svg-to-vue-component) [](https://circleci.com/gh/egoist/svg-to-vue-component/tree/master) [](https://patreon.com/egoist) [](https://chat.egoist.moe)
## Why
When you import the `.svg` file as a Vue component instead of using the URL to the file, you can style it with CSS and add addtional DOM properties or event handlers to the component directly.
The differences between this project and [vue-svg-loader](https://github.com/visualfanatic/vue-svg-loader) are:
- This one has built-in hot reloading support for webpack since the SVG code is compiled via `vue-loader`.
- The latter only supports `class` and `style` attributes on the generated component while we support all DOM props and events.
- This one supports project-wise and file-relative configuration for [SVGO](https://github.com/svg/svgo).
## Install
```bash
yarn add svg-to-vue-component --dev
```
## Usage
### With Webpack
```js
// webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.svg$/,
// If you want to import svg in css files
// You need to configure another rule to use file-loader for that
issuer: /\.(vue|js|ts|svg)$/,
use: [
// This loader compiles .svg file to .vue file
// So we use `vue-loader` after it
'vue-loader',
'svg-to-vue-component/loader'
]
}
]
}
// ...other configurations
}
```
Then you can import `.svg` files directly and use them as Vue components:
```vue
import CheckIcon from './check-icon.svg'
export default {
components: {
CheckIcon
},
methods: {
handleClick() {
console.log('It works!')
}
}
}
```
### With Vue CLI
In your `vue.config.js`:
```js
module.exports = {
chainWebpack(config) {
// Only convert .svg files that are imported by these files as Vue component
const FILE_RE = /\.(vue|js|ts|svg)$/
// Use vue-cli's default rule for svg in non .vue .js .ts files
config.module.rule('svg').issuer(file => !FILE_RE.test(file))
// Use our loader to handle svg imported by other files
config.module
.rule('svg-component')
.test(/\.svg$/)
.issuer(file => FILE_RE.test(file))
.use('vue')
.loader('vue-loader')
.end()
.use('svg-to-vue-component')
.loader('svg-to-vue-component/loader')
}
}
```
## With Poi
In your `poi.config.js`:
```js
module.exports = {
plugins: ['svg-to-vue-component/poi'],
// Or with options for the webpack loader
plugins: [
{
resolve: 'svg-to-vue-component/nuxt',
options: {}
}
]
}
```
### Nuxt.js 2
In your `nuxt.config.js`:
```js
module.exports = {
modules: ['svg-to-vue-component/nuxt'],
// Or with options for the webpack loader
modules: [
['svg-to-vue-component/nuxt',
{
// ...
}
]
]
}
```
## Loader Options
Pass loader options like this:
```js
// ...
{
test: /\.svg$/,
use: [
'vue-loader',
{
loader: 'svg-to-vue-component/loader',
options: {
// ...Your options here
}
}
]
}
```
| Option | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `svgoConfig` | Project-wise configuration for [SVGO](https://github.com/svg/svgo), if you want file-relative configuration, use the config file instead, supported format: `.svgo.{yml,js,json}`, see [here](https://github.com/svg/svgo/blob/master/.svgo.yml) for an example file. If you want to turn off SVGO entirely, pass `false` here. |
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
**svg-to-vue-component** © [EGOIST](https://github.com/egoist), Released under the [MIT](./LICENSE) License.
Authored and maintained by EGOIST with help from contributors ([list](https://github.com/egoist/svg-to-vue-component/contributors)).
> [Website](https://egoist.sh) · GitHub [@EGOIST](https://github.com/egoist) · Twitter [@\_egoistlily](https://twitter.com/_egoistlily)