https://github.com/maxigimenez/react-web-component
Expose web component using React
https://github.com/maxigimenez/react-web-component
custom-elements react react-component-boilerplate react-components react-web-component typescript web-components
Last synced: about 2 months ago
JSON representation
Expose web component using React
- Host: GitHub
- URL: https://github.com/maxigimenez/react-web-component
- Owner: maxigimenez
- Created: 2020-04-05T14:11:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T18:35:42.000Z (over 2 years ago)
- Last Synced: 2025-02-11T14:57:47.018Z (3 months ago)
- Topics: custom-elements, react, react-component-boilerplate, react-components, react-web-component, typescript, web-components
- Language: TypeScript
- Size: 4.06 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Web Component
**Disclaimer: I don't recommend to use this code for production widgets, this is was made for testing purpose**
> This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
The purpose of this repository is to have a simple boilerplate to create [web-components](https://www.webcomponents.org/) using React.
At the moment we cover some basics needs:
- Full encapsulated CSS via the shadow-dom
- [Build a single bundle](#yarn-buildbundle) in order of make the distribution easier.
- Use [react-shadow-dom-retarget-events package](https://www.npmjs.com/package/react-shadow-dom-retarget-events) to be able of use React events.
- Typescript 🚀
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `yarn test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn build:bundle`
Same as `yarn build` but it generates an unique bundle file (`build/static/js/bundle.js`) in order to make the distribution of the web component more easy.