Convert React components to native Web Components.
npm install react-to-webcomponentreact-to-webcomponent 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: This is a compatibility wrapper around our new, simpler API. We highly reccomend using the new @r2wc/react-to-web-component package.
react-to-webcomponent:
- Works in all modern browsers. (Edge needs a customElements polyfill).
- Is 1.37KB minified and gzipped.
To install from npm:
``
npm install react-to-webcomponent
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.
For basic usage, we will use this simple React component:
`js`
const Greeting = () => {
return Hello, World!
}
With our React component complete, all we have to do is call r2wc and customElements.define to create and define our custom element:
`js
import React from "react"
import ReactDOM from "react-dom/client" // if using React 18
// import ReactDOM from "react-dom" // if using React 17
import r2wc from "react-to-webcomponent"
const WebGreeting = r2wc(Greeting, React, ReactDOM)
customElements.define("web-greeting", WebGreeting)
`
Now we can use like any other HTML element!
`html
Greeting Demo
`
In the above case, the web-greeting custom element is not making use of the name property from our Greeting component.
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.
`js
const Greeting = ({ name }) => {
return Hello, {name}!
}
const WebGreeting = r2wc(Greeting, React, ReactDOM, {
props: {
name: "string",
},
})
`
Now r2wc will know to look for name attributes
as follows:
`html
Greeting Demo
``
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.
- Hello World - The quintessential software demo!
- All the Props - A demo of all the prop transform types that R2WC supports.
R2WC with Vite View Post
R2WC with Create React App (CRA) View Post
Check out our full API documentation.
Come chat with us about open source in our Bitovi community Discord.
See what we're up to by following us on Twitter.