laravel-mix-svg
v0.4.1
Published
A laravel mix package to add SVG images to your project.
Downloads
1,620
Readme
Laravel Mix SVG
A laravel mix plugin that adds a svg.js
file to your project. This is the JavaSript counterpart to Adam's Laravel Blade SVG composer package.
Install
npm install --save-dev laravel-mix-svg
Add the following to the top of your webpack.mix.js
file
require('laravel-mix-svg');
Add the following to your webpack.mix.js
file
mix.svg();
Usage
By default it grabs any svg file from resources/assets/svg
folder (including subdirectories) and makes it available as the filename without extension.
It creates a new file called resources/assets/js/svg.js
that contains a single public method to render a svg method.
const svg = require('./svg')
svg('my-thing'); // Spits out svg tag of the file my-thing.svg
svg('other-folder/my-thing'); // Spits out svg tag of the file my-thing.svg inside the other-folder
svg('my-thing', 'icon bg-blue'); // Adds icon & bg-blue css class to the svg.
With VueJs
Vue.prototype.svg = require('./svg');
Insisde a template tag you can use v-html
to render out a svg image.
<template>
...
<span v-html="svg('my-thing', 'icon bg-blue')" />
...
Configuration
You can give a object to mix.svg
mix.svg({
class: 'icon', // Applied to all svg's
assets: ['./resources/svg/'], // a list of directories to search svg images
output: './resources/js/svg.js', // Where the craeted js file needs to go.
})