# svg-inline-react

> Inline SVG wrapper component for React

Latest version **3.2.1** (published 2021-10-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install svg-inline-react
pnpm add svg-inline-react
yarn add svg-inline-react
bun add svg-inline-react
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.1 |
| Published | 2021-10-06 |
| First published | 2015-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Unpacked size | 26.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 133 |
| Author | Jaeho Lee |
| Maintainers | sairion |
| Keywords | svg, react |

## Links

- npm: https://www.npmjs.com/package/svg-inline-react
- Repository: https://github.com/sairion/svg-inline-react
- Issues: https://github.com/sairion/svg-inline-react/issues
- npm.io page: https://npm.io/package/svg-inline-react

## Dependencies (1)

- [prop-types](https://npm.io/package/prop-types.md) ^15.5.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.2.1 (latest) — 2021-10-06
- 3.2.0 — 2019-09-23
- 3.1.0 — 2018-05-14
- 3.0.0 — 2017-09-09
- 2.1.0 — 2017-04-14
- 2.0.1 — 2017-04-07
- 2.0.0 — 2017-02-27
- 1.0.3 — 2017-01-11
- 1.0.2 — 2016-07-07
- 1.0.1 — 2016-03-23
- 1.0.0 — 2016-03-09
- 0.3.1 — 2015-11-26
- 0.3.0 — 2015-11-26
- 0.2.0 — 2015-11-26
- 0.1.0 — 2015-11-17

## README

# `svg-inline-react`: Inline SVG wrapper component for React

This component wraps `dangerouslyInnerHTML` prop for easier use. Inlining SVG has pros and cons; See ["Using SVG"](https://css-tricks.com/using-svg/) for further detail. However, I recommended to use static svg transformed as React component, since React now supports svg properly.

## note for 1.x.x user: transpiling is discontinued

I removed `dist` and `es` and made `lib` (which is ES2015 source) default, and there are several reason for it. For now use of ES2015 (and modules) is widespread, there are many tools supporting it (i.e. Webpack 2, Rollup), and you will use them anyway – if you are using React/etc. If you want to stay in CommonJS land, please specify deps as `1.x.x`. i.e) `svg-inline-react: 1.x.x`

## Usage

You can use [`svg-inline-loader`](https://github.com/sairion/svg-inline-loader) with [Webpack](https://webpack.github.io) to inline SVG.

Example:

```jsx
import InlineSVG from 'svg-inline-react';

// Use with loader
<InlineSVG src={require("svg-inline-loader!icon.svg")} />

// Use without loader
const svgSource = `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid" width="48" height="48" viewBox="0 0 48 48">
  <g id="artboard-1">
    <path d="m-115.8,119.6c-12.8-22-3.2,33.6-3.2,33.6,8.8,34.4,145.6-17.6,145.6-17.6s168.8-30.4,180-34.4,96.8,1.6,96.8,1.6l-4.8-22.4c-64.8-46.4-75.2-16.8-88.8-20.8s-11.2,5.6-14.4,6.4-42.4-24-48.8-23.2-31.62-23.007-16.8,8.8c22.23,47.707-60.759,37.627-75.2,28-16.8-11.2,7.2,18.4,7.2,18.4,18.4,20-16,3.2-16,3.2-34.4-12.8-58.4,12.8-61.6,13.6s-8,4-8.8-2.4-6.865-21.256-40,3.2c-33.6,24.8-44,8.8-44,8.8l-7.2-4.8z" class="cls-1"/>
  </g>
</svg>`;
<InlineSVG src={svgSource} />
```

### prop `src` : string

valid SVG element string.

### prop `element` : string

You can change element where svg included using `element` prop, default is `<i />`. But self closed tags like `img` is not allowed, and an error will be thrown from React side.

### prop `raw` : bool (experimental!)

This prop allows your svg file to be rendered directly, without a container element wraps it. This is an experimental feature. Also, the prop will be ignored on server side rendering environment.

## Notes

[inspired by](https://gist.github.com/MoOx/1eb30eac43b2114de73a)

---
_Source: https://npm.io/package/svg-inline-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._