Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-to-custom-element

kytsang71.0.1TypeScript support: included

Convert React components to custom elements

react, custom element, web component, html element

readme

react-to-custom-element

Converts your React component into a custom element that you can register using customElements.define. Props are parsed and handled within the converter such that camel-case names are retained and you don't have to register any custom event handlers for props that start with on.

This library leverages the parsing capability in React 19.

Install

npm i react-to-custom-element

Usage

const element = reactToCustomElement(CustomElement, {
  properties: [
    "propString",
    "propNumber",
    "propBoolean",
    "propObject",
    "propArray",
    "propFunction",
    "onMyEvent",
  ],
  attributes: ["my-first-attribute", "my-second-attribute"],
});

customElements.define("custom-element", element);