jsDocs.io logo

@stencil/react-output-target

  • Version 0.3.1
  • Published
  • 68.1 kB
  • No dependencies
  • MIT license

Install

npm i @stencil/react-output-target
yarn add @stencil/react-output-target
pnpm add @stencil/react-output-target

Overview

React output target for @stencil/core components.

Index

Functions

Interfaces

Functions

function reactOutputTarget

reactOutputTarget: (outputTarget: OutputTargetReact) => OutputTargetCustom;

  • Creates an output target for binding Stencil components to be used in a React context

    Parameter outputTarget

    the user-defined output target defined in a Stencil configuration file

    Returns

    an output target that can be used by the Stencil compiler

Interfaces

interface OutputTargetReact

interface OutputTargetReact {}

  • An output target configuration interface used to configure Stencil to properly generate the bindings necessary to use Stencil components in a React application

property componentCorePackage

componentCorePackage?: string;

    property customElementsDir

    customElementsDir?: string;

      property excludeComponents

      excludeComponents?: string[];

        property includeDefineCustomElements

        includeDefineCustomElements?: boolean;

          property includeImportCustomElements

          includeImportCustomElements?: boolean;

            property includePolyfills

            includePolyfills?: boolean;

              property loaderDir

              loaderDir?: string;

                property proxiesFile

                proxiesFile: string;

                  Package Files (3)

                  Dependencies (0)

                  No dependencies.

                  Dev Dependencies (5)

                  Peer Dependencies (1)

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@stencil/react-output-target.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@stencil/react-output-target)
                  • HTML
                    <a href="https://www.jsdocs.io/package/@stencil/react-output-target"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>