Git Product home page Git Product logo

svgit's Introduction

svgit

Customizeable SVG to React Component

NPM JavaScript Style Guide

This is a simple react library built on react-inlinesvg for manipulating svgs. You can pretty much manipulate path,g, and other svg components by using their index (more to come) and attrs. This is still at its crude stage.

Install

npm install --save svgit

Usage

import React, { Component } from 'react'

import SVG from 'svgit'

class Example extends Component {
  render () {
    return (
      <SVG width="50" title="New title" height="50" selectors={{index:1, attrs: { width: "20", height: "30" }}} />
    )
  }
}

Props


src {string}
The SVG file you want to load. It can be an url or a string (base64 or encoded)

wrapper {function} ▶︎ React.createFactory('span')
A React class or a function that returns a component instance to be used as the wrapper component.

preloader {node}
A component to be shown while the SVG is loading.

selector {object}
Select a single svg element to be customized. E.g - {index:4, attrs: { fill:"yellow" }}.

index - index of the element starting from 0 attrs - any applicable svg attributes and properties

selectors {array}
Select multiple svg elements to be customized. E.g - [{index:4, attrs: { fill:"yellow" }}].

index - index of the element starting from 0 attrs - any applicable svg attributes and properties

className {string}
A class to add to the default wrapper.

onLoad {function} ▶︎ a random 8 characters string [A-Za-z0-9]
A callback to be invoked upon successful load.
This will receive 2 arguments: the src prop and a isCached boolean

onError {function}
A callback to be invoked if loading the SVG fails.
This will receive a single argument:

  • a xhr RequestError with:
{
    ...,
    isHttpError: bool,
    status: number
}
  • or an InlineSVGError, which has the following properties:
{
    name: 'InlineSVGError',
    isSupportedBrowser: bool,
    isConfigurationError: bool,
    isUnsupportedBrowserError: bool,
    message: string
}

You should head over to react-inlinesvg for more info on react-inlinesvg

Contribution

Yes you can contribute by sending a PR. Much code.

License

MIT © Oyetoke Toby

svgit's People

Contributors

citguru avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

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.