@svgr/core

Transform SVG into React Components.

Last updated 6 years ago by neoziro .

MIT · Repository · Original npm · Tarball · package.json

$ gnpm install @svgr/core

SYNC missed versions from official npm registry.

@svgr/core

Node API of SVGR.

npm install @svgr/core

Usage

import { transform } from '@svgr/core'

const svgCode = `
<svg xmlns="http://www.w3.org/2000/svg"
  xmlns:xlink="http://www.w3.org/1999/xlink">
  <rect x="10" y="10" height="100" width="100"
    style="stroke:#ff0000; fill: #0000ff"/>
</svg>
`

transform(svgCode, { icon: true }, { componentName: 'MyComponent' }).then(
  (jsCode) => {
    console.log(jsCode)
  },
)

Use svgr.sync(code, config, state) if you would like to use sync version.

Plugins

By default @svgr/core doesn't include any plugin, if you want them, you have to install them and include them in config.

svgr(svgCode, {
  plugins: ['@svgr/plugin-svgo', '@svgr/plugin-jsx', '@svgr/plugin-prettier'],
}).then((jsCode) => {
  console.log(jsCode)
})

License

MIT

Current Tags

2.0.0-alpha.26fa501a ... canary (6 years ago)
7.0.0 ... latest (2 years ago)
6.0.0-alpha.4 ... next (3 years ago)

43 Versions

Maintainers (1)

Downloads

Today 0

This Week 0

This Month 1

Last Day 0

Last Week 1

Last Month 0

Dependencies (3)

@svgr/plugin-jsx ^4.3.0
camelcase ^5.3.1
cosmiconfig ^5.2.0

Dev Dependencies (0)

None

Dependents (1)

@svgr/webpack

Copyright 2013 - present © cnpmjs.org | Home |