stencil-inline-svg/readme.md

A Stenciljs plugin to insert inline SVGs into components

# stencil-inline-svg

A Stenciljs plugin to insert inline SVGs into components on build time.

> Requires stenciljs version ^1.4.0 - `"@stencil/core": "^1.4.0"`

## Installation

```bash
npm install -D stencil-inline-svg
```

## Usage

Import the plugin on your `stencil.config.ts` file and add the `inlineSvg` function to your plugins list.

```javascript
import { Config } from '@stencil/core';
import { inlineSvg } from 'stencil-inline-svg';

export const config: Config = {
  namespace: 'mycomponent',
  outputTargets: [
    { type: 'dist' },
    { type: 'docs-readme' },
    {
      type: 'www',
      serviceWorker: null, // disable service workers
    },
  ],
  plugins: [inlineSvg()],
};
```

Now, just import your file and set it as the `innerHTML` property of an element inside your component.

```javascript
import { Component } from '@stencil/core';
import Lambo from '../../assets/img/gallardo.svg';

@Component({
  tag: 'my-component',
  styleUrl: 'my-component.css',
  shadow: true,
})
export class MyComponent {
  render() {
    return <div class='svg-container' innerHTML={Lambo} />;
  }
}
```

## Links

Stenciljs - https://stenciljs.com/

Lamborghini SVG - https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/gallardo.svg