# stencil-solid-output-target

> Solid output target for @stencil/core components.

Latest version **4.0.0** (published 2023-08-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install stencil-solid-output-target
pnpm add stencil-solid-output-target
yarn add stencil-solid-output-target
bun add stencil-solid-output-target
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2023-08-27 |
| First published | 2022-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 2 |
| Unpacked size | 31.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Arthur Fontaine |
| Maintainers | arthur-fontaine |

## Links

- npm: https://www.npmjs.com/package/stencil-solid-output-target
- Repository: https://github.com/arthur-fontaine/stencil-solid-output-target
- Homepage: https://github.com/arthur-fontaine/stencil-solid-output-target#readme
- Issues: https://github.com/arthur-fontaine/stencil-solid-output-target/issues
- npm.io page: https://npm.io/package/stencil-solid-output-target

## Dependencies (2)

- [glob](https://npm.io/package/glob.md) ^10.3.3
- [hyper-dom-expressions](https://npm.io/package/hyper-dom-expressions.md) ^0.33.13

## Recent versions

- 4.0.0 (latest) — 2023-08-27
- 3.0.0 — 2023-08-27
- 0.1.3 — 2023-08-27
- 0.1.2 — 2022-08-23
- 0.1.1 — 2022-07-17
- 0.1.0 — 2022-07-13

## README

# stencil-solid-output-target

[![npm (tag)](https://img.shields.io/npm/v/stencil-solid-output-target/latest)](https://www.npmjs.com/package/stencil-solid-output-target) [![npm](https://img.shields.io/npm/dw/stencil-solid-output-target)](https://www.npmjs.com/package/stencil-solid-output-target) 

Stencil can generate Solid component wrappers for your web components. This allows your Stencil components to be used within a Solid application.

## Installation

```bash
npm install stencil-solid-output-target
```

### Versioning

Here are the versions of `stencil-solid-output-target` that correspond to the different versions of Stencil:

| Stencil Version | `stencil-solid-output-target` Version |
|-----------------|--------------------------------------|
| 2.x             | 0.x                                  |
| 3.x             | 3.x                                  |
| 4.x             | 4.x                                  |

## Usage

In your `stencil.config.ts` add the following configuration to the `outputTargets` section:

```ts
import { Config } from '@stencil/core';
import { solidOutputTarget } from 'stencil-solid-output-target';

export const config: Config = {
  namespace: 'demo',
  outputTargets: [
    solidOutputTarget({
      componentCorePackage: 'component-library',
      proxiesFile: '../component-library-solid/src/components.ts',
    }),
    {
      type: 'dist',
      esmLoaderPath: '../loader',
    },
  ],
};
```

## Config Options

| Property                      | Description                                                                                                                                                                                                                                                                                                                      |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `componentCorePackage`        | The NPM package name of your Stencil component library. This package is used as a dependency for your Solid wrappers.                                                                                                                                                                                                            |
| `proxiesFile`                 | The output file of all the component wrappers generated by the output target. This file path should point to a location within your Solid library/project.                                                                                                                                                                       |
| `excludeComponents`           | An array of tag names to exclude from generating component wrappers for. This is helpful when have a custom framework implementation of a specific component or need to extend the base component wrapper behavior.                                                                                                              |
| `loaderDir`                   | This is the path to where the `defineCustomElements` function exists in your built project. If `loaderDir` is not provided, the `/dist/loader` directory will be used.                                                                                                                                                           |
| `includePolyfills`            | If `true`, polyfills will automatically be imported and the `applyPolyfills` function will be called in your proxies file. This can only be used when lazy loading Web Components and will not work when `includeImportCustomElements` is `true`.                                                                                |
| `includeDefineCustomElements` | If `true`, all Web Components will automatically be registered with the Custom Elements Registry. This can only be used when lazy loading Web Components and will not work when `includeImportCustomElements` is `true`.                                                                                                         |
| `includeImportCustomElements` | If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](https://stenciljs.com/docs/custom-elements) and will not work with lazy loaded components. |
| `customElementsDir`           | This is the directory where the custom elements are imported from when using the [Custom Elements Bundle](https://stenciljs.com/docs/custom-elements). Defaults to the `components` directory. Only applies when `includeImportCustomElements` is `true`.                                                                        |

## Consumption

We can simply import the components we need after installing the package.

```tsx
import { MyComponent } from "component-library";
```

## Notes

This package is very inspired by [@stencil/react-output-target](https://github.com/ionic-team/stencil-ds-output-targets/tree/main/packages/react-output-target). It shares the same logic and the same configuration options.

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