Giter Club home page Giter Club logo

sass-inline-svg's Introduction

Build Status Coverage Status Dependency Status devDependency Status

sass-inline-svg

Install

$ npm install --save-dev sass-inline-svg

Usage

You can use this function in node-sass or any project that depends on node-sass. The only thing you need to do to make this work is add the inlinerfunction to the functions option.

You should initialize the inliner with a basepath where it will look for the svg files.

node-sass

var sass = require('node-sass');
var inliner = require('sass-inline-svg')

sass.render({
  data: '.logo-icon{ background: svg("logo.svg")}',
  functions: {

    svg: inliner('./', [options])
  }
});

node-sass CLI usage

node-sass --functions=node_modules/sass-inline-svg/default [other node-sass arguments]

This is equivalent to specifying the following:

functions: {
  'svg': inliner('./', {}),
  'inline-svg': inliner('./', {})
}

grunt-sass

var inliner = require('sass-inline-svg')


grunt.initConfig({

    sass:{

        options: {
            functions: {

                svg: inliner('./', [options])
            }
        },
        ...
    }

})

options

optimize (default false)

{optimize: true} uses svgo internally to optmize the svg.

encodingFormat (default: base64)

base64 will encode the SVG with base64, while uri will do a minimal URI-encoding of the svg โ€“ uri is always smaller, and has good browser support as well.

svg transformation

The inliner accepts a second argument, a sass-map, that describes a css like transformation. The first keys of this map are css-selectors. Their values are also sass-maps that holds a key-value store of the svg-attribute transformation you want to apply to the corresponding selector.


.logo-icon{

  background: svg("logo.svg", (path: (fill: green), rect: (stroke: white)));
}

In this example path and rect are selectors and fill: green and stroke: white are the associated applied attributes.

License

MIT

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.