# gatsby-plugin-stencil

> Gatsby server side rendering for your Stencil web components.

Latest version **0.2.0** (published 2021-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-plugin-stencil
pnpm add gatsby-plugin-stencil
yarn add gatsby-plugin-stencil
bun add gatsby-plugin-stencil
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2021-07-15 |
| First published | 2020-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 0 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jon Earley |
| Maintainers | earley |
| Keywords | gatsby, gatsby-plugin, stencil, web components, server side rendering |

## Links

- npm: https://www.npmjs.com/package/gatsby-plugin-stencil
- Repository: https://github.com/jonearley/gatsby-plugin-stencil
- Issues: https://github.com/jonearley/gatsby-plugin-stencil/issues
- npm.io page: https://npm.io/package/gatsby-plugin-stencil

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2021-07-15
- 0.1.0 — 2020-05-06
- 0.0.1 — 2020-02-21

## README

# gatsby-plugin-stencil

Gatsby server side rendering for your Stencil web components.

## Install

```
npm install --save gatsby-plugin-stencil
```

## How to use

**Note**: Make sure you you have added the [`dist-hydrate-script` as output target](https://stenciljs.com/docs/hydrate-app) to your Stencil library

Add the plugin to your `gatsby-config.js`

```js
module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-stencil`,
      options: {
        // The module of your components (required), eg "@ionic/core".
        // Add multiple modules by using an array eg ["@ionic/core", "my-stencil-components"]
        module: "your-stencil-components-package",

        // Stencil renderToString options (optional): https://stenciljs.com/docs/hydrate-app#configuration-options
        renderToStringOptions: {
          prettyHtml: true,
        },
      },
    },
  ],
};
```

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