react-webcomponentify

Build and export React Components as Web Components without any extra effort.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-webcomponentify
6591.3.2a year ago4 years agoMinified + gzip package size for react-webcomponentify in KB

Readme

react-webcomponentify
npm version
logo
Build and export React Components as Web Components without any extra effort.
Size = ~3kb after gzip
\ works nicely with preact aswell: See demo

Show me live demo?

  • Demo Link:
  • Demo source code (recommended):

Table of Contents

- Basic
- Advanced
- [Sending non string props to react](#sending-non-string-props-to-react)
- [What about child elements?](#what-about-child-elements)
- TypeScript support

Use cases

  • Export existing react components as web components so you can use them with Vue or Angular.
  • Use react's rich api to build web components with state management, etc. Instruction on how to do exactly that and Live Demo here:
  • Lets say you are writing a component library with web components but you already have a huge collection of component in react.You can use this library to generate a component library with the existing components. And then safely continue to rewrite each one of them behind the scene. This makes sure other teams are not waiting for you to finish.
  • For more crazy people - You can even export your entire react app as a web component and embed it into another app made with Angular or Vue. So you can keep writing newer parts of code in react while keeping your legacy code working on the side.
  • Maybe (not tried) you can embed another old react app (wrapped with this module) inside ur current react app.

Install

npm install react-webcomponentify

or
yarn add react-webcomponentify

Usage

Basic

Simple use case
import React from "react";
import { registerAsWebComponent } from "react-webcomponentify";

export const ExampleReactComponent = () => {
  return <div> Hello </div>;
};

registerAsWebComponent(ExampleReactComponent, "example-component");

In HTML:
<!DOCTYPE html>
<html>
  ....
  <body>
    <example-component />
  </body>
  ....
</html>

Advanced

Sending non string props to react

You can send serializable string props via the html attributes itself. But for props like callback functions or complex objects you can use the setProps method on the element as shown below.
import React from "react";
import { registerAsWebComponent } from "react-webcomponentify";

export const ButtonComponent = props => {
  return (
    <div>
      Hello <button onClick={props.onClick}>{props.text}</button>
    </div>
  );
};

registerAsWebComponent(ButtonComponent, "button-web");

In HTML:
<!DOCTYPE html>
<html>
  ....
  <body>
    <button-web text="click me" id="mybutton" />
  </body>
  ....
  <script>
    const myBtn = document.getElementById("mybutton");
    myBtn.setProps({
      onClick: () => console.log("btn was clicked")
    });
  </script>
</html>

Every custom component built using react-webcomponentify will have an instance method setProps
element.setProps({
  ....
  /* set the props here that you want to send to react */
  ....
})

What about child elements?

Thats possible too 😎
import React from "react";
import { registerAsWebComponent } from "react-webcomponentify";

// You access the children just like you would in react (using this.props.children)
export const ComponentWithChild = props => {
  return (
    <div>
      Hello World
      {this.props.text}
      <div>{this.props.children}</div>
    </div>
  );
};

registerAsWebComponent(ComponentWithChild, "component-with-child");

In HTML:
<!DOCTYPE html>
<html>
  ....
  <body>
    <component-with-child text="I love children">
      <p>Some child</p>
    </component-with-child>
  </body>
  ....
</html>

This will send <p>Some Child</p> via this.props.children to the React component ComponentWithChild. Note that <p>Some Child</p> is a dom node and not a react component. So it will be wrapped with a simple react component found here: https://github.com/a7ul/react-webcomponentify/blob/master/src/react-dom-child.js But for implementation purposed use it like a regular child component.

TypeScript support

This library is written in TypeScript. All declarations are included.

Maintainers

<td align="center"><a href="https://github.com/a7ul"><img src="https://avatars.githubusercontent.com/u/4029423?v=4" width="100px;" alt=""/><br /><sub><b>Atul R</b></sub></a></td>
<td align="center"><a href="https://github.com/kopach"><img src="https://avatars.githubusercontent.com/u/8749624?v=4" width="100px;" alt=""/><br /><sub><b>
Ihor
</tr>