React component library template/boilerplate

Template and quick-starter to create your own modern React library includes awesome features and bandled using Rollup.

Note: At date of writing this (April 2023), since the create-react-library tool is no longer actively maintained (https://github.com/transitive-bullshit/create-react-library#readme) then I thought about creating this boilerplate to help bootstrap a modern react library with some nice features

Note

This repository created for:

Help to bootstrap your own react library with some nice features and without bothering with configuration and saving time.
Learning purposes (especially how to bundle complicated things with Rollup).

Intro

This boilerplate uses Rollup as a bundler https://rollupjs.org/

As mentioned in readme of create-react-library there are some others tools(you can use it as a bundler) as an alternative to Rollup like tsup, tsdx, or microbundle.

Features

Rollup for bundling
Bundles commonjs and es module formats
Jest & React Testing Library : For testing our components
Support for TypeScript
Sourcemap creation
Support of CSS/SASS: For exporting components with style
Storybook: For testing our components within the library itself as we design them
Supports complicated peer-dependencies (example here is Antd so here the power of rollup-plugin-peer-deps-external we can use complicated peer dependency such Antd without having it bundled as a part of your module.)
Optimizing bundle size: @rollup/plugin-terser A Rollup plugin to generate a minified bundle with terser.
Automatically externalize peerDependencies in a rollup bundle, thanks to rollup-plugin-peer-deps-external
Eslint
Deploy Storybook to GitHub Pages

Getting started

Copy over the template by cloning this repository and install its dependencies:

git clone https://github.com/MidoAhmed/rollup-react-library-starter.git
cd rollup-react-library-starter
npm install

Development:

Storybook:
- Storybook gives you an easy way to see and use your components while working on them in your library project, without having to build an unnecessary testing page just to display them.
```
npm run storybook # runs the host Storybook application locally for quick and easy testing
```

Now, anytime you make a change to your library or the stories, the storybook will live-reload your local dev server so you can iterate on your component in real-time.

Rollup watch and build:
- for Local development run rollup to watch your src/ module and automatically recompile it into dist/ whenever you make changes.
```
npm run dev # runs rollup with watch flag
```

Scripts:

npm run build : builds the library to dist
npm run dev : builds the library, then keeps rebuilding it whenever the source files change.
npm test : tests the library and show the coverage.
npm run lint : runs eslint.
npm run storybook : runs the host Storybook application locally for quick and easy testing
npm run build-storybook : builds a static HTML/JS bundle that can easily be hosted on a remote server, so all members of your team can try your components.
npm run deploy-storybook : build & deploy the storybook to GitHub Pages

Publishing to npm:

publish to GitHub Packages registry:

you need to have this in your ~/.npmrc

registry=https://registry.npmjs.org/
@YOUR_GITHUB_USERNAME:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_AUTH_TOKEN

and run:

npm publish

Tutorials and inspirations used to create this boilerplate

big thanks to this tuto and his author : https://dev.to/alexeagleson/how-to-create-and-publish-a-react-component-library-2oe#adding-scss

License

MIT.

Bug: Unable to use hooks

Steps to Reproduce:

Clones and installed deps.
Tested storybook and created build. (Working)
Tested by installing and importing Button component in new react cra project. (Working)
Modified the original Button component and added useState hook.
Tested component in storybook (Working)
Created Build (Build created without errors successfully)
Installed again in CRA project.
CRA App Crashes after starting. (Not Working)

Expected Behavior:

Should also work with hooks.

Screenshots:

This issue usually happens when multiple react versions are conflicting.

I also tried removing react and react-dom from devDependencies and only keeping them in peer deps. (Got same error, didn't worked)

Using state in a react button component seems a very basic functionality to me so it should not give any errors. I maybe missing something obvious.

This is the modified code of Button.tsx component:

import React, { useState } from "react";
import "./Button.scss";

export interface ButtonProps extends React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>{
  label: string;
}

const Button = ({label, ...others}: ButtonProps) => {
  const [state, setState] = useState(label)
  return <button {...others} onClick={() => setState("Clicked")}>{state}</button>;
};

export default Button;

midoahmed / rollup-react-library-starter Goto Github PK

rollup-react-library-starter's Introduction

React component library template/boilerplate

Note

Intro

Features

Getting started

Development:

Scripts:

Publishing to npm:

Tutorials and inspirations used to create this boilerplate

License

rollup-react-library-starter's People

Contributors

Stargazers

Watchers

Forkers

rollup-react-library-starter's Issues

Steps to Reproduce:

Expected Behavior:

Screenshots:

Recommend Projects

Recommend Topics

Recommend Org