Facebook’s React.js UI framework takes a component-based approach to building user experiences. We’d like to easily share and reuse these components. Based on Noel Broda’s article, I have published two simple repositories:
After cloning/forking these repos, it’s a good idea to edit the
package.json files to change the names and repositories. Of course, you’ll need to install the dependencies in the usual way:
The boilerplate has everything needed for a simple component or component library. In
./src/index.js contains a single exported React Component,
Fancy, that simply emits a
div. It is possible to export additional components.
Since we are publishing this component, we must first
npm run build it, which produces its output in the
./build directory. This component can now be pushed back to Github or published to an NPM registry.
We assume here the component has been published to Github. To install it in another project, simply:
npm i github:witt3rd/react-component-boilerplate.git (or whatever you’ve named your component).
Smoke Testing The Component
To see if your component can be installed and used in a React project, switch to the test project which provide a very simple Next.js application that depends on the above component (ensure you’ve changed the names to match).
./pages/index.js for an example use of the component, which simply imports the component and uses it as you would expect.
To see it in action:
npm run dev.