Skip to content
This repository has been archived by the owner on Sep 25, 2021. It is now read-only.

Latest commit

 

History

History
183 lines (133 loc) · 4.99 KB

README.md

File metadata and controls

183 lines (133 loc) · 4.99 KB
Raw

SVG to React Loader

A Webpack Loader to turn SVGs into React Components

NOTE: version 0.4.0 is currently in beta and versions prior to that will no longer be supported. After sufficient testing can be completed that will be the latest release. Until then you can use the beta by npm install svg-react-loader@next.

Summary

A wepack loader allowing for inline usage of a SVG as a React component, or for composing individual SVGs into larger ones.

Handles namespaced attributes (xlink), and other non-react attributes/tags, on component mounting, so the returned jsx will compile cleanly with babel.

Installation

% npm install svg-react-loader

Usage

var React = require('react');
var Icon = require('babel!svg-react!../svg/my-icon.svg?name=Icon');

module.exports = React.createClass({
    render () {
        return <Icon className='normal' />;
    }
});

Documentation

Query Params

Query params can be used on the loader path, or on the resource's path. Those on the resource will override those given for the loader.

name: displayName to use for the compiled component. Defaults to using the resource's file name, capitalized and camelCased. ex. "?name=MyIcon"

tag: Override the root-level tag. If given, will blow-away any attributes given for the tag. ex.: "?tag=symbol"

attrs: Attributes to apply to the root-level tag. If a certain attribute is already assigned to the tag, the value here will override that. ex.: "?attrs={className: 'mySymbol'}"

reactDom: A string to require an alternaitve 'react-dom' module. ex.: ?reactDom=react

Dependencies

As of [email protected] it no longer specifies any peerDependencies. It is left up to individual users to configure their local webpack installation to support this loader.

svg-react-loader requires the following dependencies:

react
react-dom
babel-loader
babel-core
babel-preset-es2015
babel-preset-react

NOTE: you can review the devDependences of the package.json file for specific version numbers.

The following cover specific dependencies and how to configure your webpack installation fro them.

Babel

As of [email protected] you must specify your presets to get this to work with React.

Presets can be specified as part of a Babel config as outlined in Setting up Babel 6, or you may specify Babel presets for your loader within your webpack configuration:

// file: webpack.config.js
module.exports = {
    
    loaders: [
        { test: /\.svg$/, loader: 'babel?presets[]=es2015,presets[]=react!svg-react' }
    ],

}

React Before Version 0.14.0

As of [email protected] the DOM methods have been moved into its own library react-dom.

svg-react-loader requires this library to find the rendered component and update its namespaced xml attributes (and some other things).

If you do not want to install react-dom alongside your deprecated version of react, you can work-around this by creating an alias to react-dom in your webpack configuration that points to your installed version of react:

// file: webpack.config.js
module.exports = {
    
    loaders: [
        { test: /\.svg$/, loader: 'babel!svg-react' }
    ],

    // ...

    resolve: {
        alias: {
            'react-dom': __dirname + '/node_modules/react'
        }
    },

    // ...
}

Or, you can pass the correct module name to load with the query params.

Report an Issue

License

Copyright (c) 2015 Jerry Hamlet [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The Software shall be used for Good, not Evil.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.