Light

vladshcherbin / rollup-plugin-svg-sprite Goto Github PK

View Code? Open in Web Editor NEW

20.0 1.0 5.0 347 KB

Create external svg sprite file from your bundle using Rollup

JavaScript 100.00%

rollup rollup-plugin svg sprite svg-sprite svgo create generate extract minify

rollup-plugin-svg-sprite's Introduction

rollup-plugin-svg-sprite

Create external svg sprite file from your bundle using Rollup and optimize it using SVGO.

Installation

# yarn
yarn add rollup-plugin-svg-sprite -D

# npm
npm install rollup-plugin-svg-sprite -D

Usage

// rollup.config.js
import svgSprite from 'rollup-plugin-svg-sprite'

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/app.js',
    format: 'iife'
  },
  plugins: [
    svgSprite({
      outputFolder: 'dist/public'
    })
  ]
}

Next, import svg files in your project:

import './svg/trash.svg'
import './svg/user.svg'

Configuration

There are some useful options:

outputFolder

Type: string

Folder where generated svg sprite will be saved.

svgSprite({
  outputFolder: 'dist/public'
})

minify

Type: boolean | Default: true

Minify generated svg sprite.

svgSprite({
  outputFolder: 'dist/public',
  minify: false
})

All other options are passed to svgo package which is used inside.

License

MIT

rollup-plugin-svg-sprite's People

Contributors

Stargazers

Watchers

Forkers

warmrobot russelgal e-pavlica mhassan1 jameswragg

rollup-plugin-svg-sprite's Issues

TypeError: Cannot read property 'append' of undefined

It seems a bug：

Import all files.svg from target folder(s)

Thnx for useful plugin 👍🏻
Maybe also import all *.svg files from target folder(s) by mask or only by folders name?

Like:
https://github.com/rollup/rollup-plugin-multi-entry/blob/master/README.md
https://github.com/elcarim5efil/rollup-plugin-require-context
https://github.com/Vehmloewff/rollup-plugin-glob-files

How to apply SVGO plugins

I'm trying to get this to take SVGO plugins like this:

// rollup.config.js

const config = {
  ...,
  plugins: [
    svgSprite({
      outputFolder: './build,
      plugins: [
        'preset-default',
        {
          name: 'addAttributesToSVGElement',
          params: {
            attributes: [
              { 'fill-rule': 'currentColor' },
              { 'aria-hidden': 'true' },
              { role: 'presentation' },
            ]
          }
        }
      ]
    })
  ]
}

But I am not seeing the plugins take effect in the generated sprite sheet.
Am I doing this incorrectly?

Thanks.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.