Next Phenomenal Microbrewery

    rollup-plugin-vue-inline-svg

    1.1.2 • Public • Published

    rollup-plugin-vue-inline-svg

    Unit tests

    A simple plugin to import svg files as vue components. This is intended to be used with rollup-plugin-vue and is based on vue-svg-loader.

    installation

    npm install --save-dev rollup-plugin-vue-inline-svg

    usage

    rollup.config.js

    import svg from 'rollup-plugin-vue-inline-svg';
    import vue from 'rollup-plugin-vue'; // optional
    
    export default {
      // ...
      plugins: [
        svg(config)
        vue(), // optional
      ]
    }

    config

    By default this plugin will attempt to transform all files that end with the extension .svg. You can be more explicit by passing include and exclude options.

    // `include` and `exclude` can each be a minimatch
    // pattern, or an array of minimatch patterns, relative to process.cwd()
    {
      include: string or array of minimatch,
      exclude: string or array,
      svgoConfig: svgo config object,
    }

    See SVGO for configuration options that it accepts.

    Import svgs from node_modules

    The plugin is able to import svg files from node_modules packages:

    import AlertSvg from 'octicons/build/svg/alert.svg'

    The only important thing to remember is that the rollup build process needs to be started from the project root directory (e.g. via npm scripts). This is because the plugin will search the node_modules directory, via the process.cwd() node method, from where the process has started.

    Install

    npm i rollup-plugin-vue-inline-svg

    DownloadsWeekly Downloads

    1,734

    Version

    1.1.2

    License

    ISC

    Unpacked Size

    14.7 kB

    Total Files

    19

    Last publish

    Collaborators

    • e-e-e