SVGR RS

Speedy SVGR rewritten in Rust 🦀

If you are using SVGR RS from Rust, see rustdoc and for most uses.

Webpack

SVGR RS provides an webpack loader to import SVG as React components.

Install

``sh
npm install --save-dev @svgr-rs/svgrs-plugin


or use yarn


yarn add --dev @svgr-rs/core
`

Usage

webpack.config.js

`js
{
test: /\.svg$/i,
issuer: /\.[jt]sx?$/,
resourceQuery: /react/,
use: [
{
loader: '@svgr-rs/svgrs-plugin/webpack',
options: {
exportType: 'named',
namedExport: 'ReactComponent',
},
},
],
}
`

Vite

SVGR RS provides an vite plugin to import SVG as React components.

Install

`sh
npm install --save-dev @svgr-rs/svgrs-plugin


or use yarn


yarn add --dev @svgr-rs/core
`

Usage

vite.config.js

`js
import react from '@vitejs/plugin-react'
import { svgrs } from '@svgr-rs/svgrs-plugin/vite'
import { defineConfig } from 'vite'

export default defineConfig({
plugins: [
react(),
svgrs({
exportType: 'named',
namedExport: 'ReactComponent',
})
],
})
`

Node.js

Use SVGR RS in Node.js to complex transformations or tools.

Install

`sh
npm install --save-dev @svgr-rs/core


or use yarn


yarn add --dev @svgr-rs/core
`

Usage

Import transform from @svgr-rs/core to transform a file. It takes three arguments:

* source: the SVG source code to transform
* options: the options used to transform the SVG
* state: a state linked to the transformation

`js
import { transform } from '@svgr-rs/core'

const svgCode =
xmlns:xlink="http://www.w3.org/1999/xlink">
style="stroke:#ff0000; fill: #0000ff"/>

const jsCode = await transform(
svgCode,
{ icon: true },
{ componentName: 'MyComponent' },
)
``

Benchmarks

Transform time without SVGO and Prettier in W3C SVG 1.1 TestSuite:

!Transform time

Roadmap

- [x] jsxRuntime
- [x] jsxRuntimeImport
- [x] icon
- [x] native
- [x] typescript
- [x] dimensions
- [x] expandProps
- [ ] prettier
- [ ] prettierConfig
- [ ] svgo (Speedy SVGO rewritten in Rust is working in progress)
- [ ] svgoConfig
- [x] ref
- [x] memo
- [x] replaceAttrValues
- [x] svgProps
- [x] titleProp
- [x] descProp

License

MIT