Skip to content

Latest commit

 

History

History
124 lines (79 loc) · 4.67 KB

README.md

File metadata and controls

124 lines (79 loc) · 4.67 KB
Raw

React to Web Component

@r2wc/react-to-web-component converts React components to custom elements! It lets you share React components as native elements that don't require being mounted through React. The custom element acts as a wrapper for the underlying React component. Use these custom elements with any project that uses HTML even in any framework (vue, svelte, angular, ember, canjs) the same way you would use standard HTML elements.

Note: The latest version of this package only works with the React 18. If you are using React 16 or 17, please use version 1.

@r2wc/react-to-web-component:

Setup

To install from npm:

npm install @r2wc/react-to-web-component

Need help or have questions?

This project is supported by Bitovi, a React consultancy. You can get help or ask questions on our:

Or, you can hire us for training, consulting, or development. Set up a free consultation.

Basic Use

For basic usage, we will use this simple React component:

const Greeting = () => {
  return <h1>Hello, World!</h1>
}

With our React component complete, all we have to do is call r2wc and customElements.define to create and define our custom element:

import r2wc from "@r2wc/react-to-web-component"

const WebGreeting = r2wc(Greeting)

customElements.define("web-greeting", WebGreeting)

Now we can use <web-greeting> like any other HTML element!

<body>
  <h1>Greeting Demo</h1>

  <web-greeting></web-greeting>
</body>

In the above case, the web-greeting custom element is not making use of the name property from our Greeting component.

Working with Attributes

By default, custom elements created by r2wc only pass properties to the underlying React component. To make attributes work, you must specify your component's props.

const Greeting = ({ name }) => {
  return <h1>Hello, {name}!</h1>
}

const WebGreeting = r2wc(Greeting, {
  props: {
    name: "string",
  },
})

Now r2wc will know to look for name attributes as follows:

<body>
  <h1>Greeting Demo</h1>

  <web-greeting name="Justin"></web-greeting>
</body>

For projects needing more advanced usage of the web components, see our programatic usage and declarative demos.

We also have a complete example using a third party library.

Examples

  • Hello World - The quintessential software demo!
  • All the Props - A demo of all the prop transform types that R2WC supports.
  • Header Example - An example reusable Header component.
  • MUI Button - An example application using an MUI button with theme customization.
  • Checklist Demo - An example Checklist application.

Blog Posts

R2WC with Vite View Post

R2WC with Create React App (CRA) View Post

How it works

Check out our full API documentation.

Under the hood, r2wc creates a CustomElementConstructor with custom getters/setters and life cycle methods that keep track of the props that you have defined. When a property is set, its custom setter:

  • re-renders the React component inside the custom element.
  • creates an enumerable getter / setter on the instance to save the set value and avoid hitting the proxy in the future.

Also:

  • Enumerable properties and values on the custom element are used as the props passed to the React component.
  • The React component is not rendered until the custom element is inserted into the page.

We want to hear from you.

Come chat with us about open source in our Bitovi community Discord.

See what we're up to by following us on Twitter.