@chrisbielak/svg-module

forked from https://github.com/nuxt-community/svg-module

_Super simple svg loading module for Nuxt.js

📖 Release Notes

Introduction

SVG module for Nuxt.js, allows you to import .svg files in multiple ways depending on the resource query you provide. Currently, this allows you to do the following:

• file.svg - normal import using file-loader
• file.svg?data - base64 data url import using url-loader
• file.svg?inline - inline import using vue-svg-loader

Installation

Using Yarn: /**

• This is the original RegExp cloned from the original Nuxt.js configuration
• files, with only the search for ".svg" files removed. Keep tabs on this in
• case the core decides to add additional qualifiers to the pattern. */ const ORIGINAL_TEST = /.(png|jpe?g|gif|svg|webp)$/; const REPLACEMENT_TEST = /.(png|jpe?g|gif|webp)$/;

yarn add @chrisbielak/svg-module

Using NPM:

npm install @chrisbielak/svg-module

// nuxt.config.js
export default {
  modules: [
    '@chrisbielak/svg-module'
  ]
};

And that's it! You don't have to install anything else, you're ready to go.

Usage

The usage examples are documented as:

<!-- Nuxt.js code -->

<!-- Outputted html -->

Standard external import

Import normally as an external resource using file-loader

<template>
  <img src="~assets/nuxt.svg" />
</template>

<img src="/_nuxt/9405b9978eb50f73b53ac1326b93f211.svg" />

Inline base64 url

Inline as a URL (no external requests) using url-loader

<template>
  <img src="~assets/nuxt.svg?data" />
</template>

<img src="data:image/svg+xml;base64,P...2h913j1g18h98hr" />

Inline svg element

Inline as an actual svg element using vue-svg-loader

<template>
  <NuxtLogo />
</template>

<script>
  import NuxtLogo from "~/assets/nuxt.svg?inline";

  export default {
    components: {
      NuxtLogo
    }
  };
</script>

<svg xmlns="http://www.w3.org/2000/svg"><path></path></svg>

Raw SVG loader

Load the raw SVG data using raw-loader. Useful if anything in the SVG needs to be modified

<template>
  <div v-html="rawSvg" />
</template>

<script>
  import nuxtLogoRaw from '~/assets/nuxt.svg?raw'

  export default {
    data () {
      return {
        rawSvg: nuxtLogoRaw
      }
    }
  };
</script>

Caveats

In order for this module to work correctly, the default .svg Nuxt.js webpack rule gets replaced with this handler.

The only difference between this and the handler is that there is no limit for when file-loader replaces url-loader.

So when using the ?data query, it will always use url-loader regardless of file size, and when not using either resource query, it will always use file-loader).

Contributing

As this loader attempts to abstract webpack configuration from the process and make it easier to use multiple svg loaders, any contributions that add more svg loader methods to the configuration will be accepted wholeheartedly!

Also I'll be actively maintaining this project so if you'd rather just make a request for a loader or a feature; I'd be happy to take a look and see what I can do myself :)

License

MIT License

Copyright (c) Sam Holmes