1. Why do we need to create it?
- I’ve noticed that some of my own custom components I use in different projects. Up until now, I’ve used the copy-paste method” to share these components between projects. But now I think I’m old enough to publish my own components to npm and then import them into my projects.
- Reusable of this component with different different projects and reduce copy and paste work.
e.g. Basic Use Case Example let’s assume we have two different projects and we use the same component in both projects.
Here we have two different projects like project 1 and project 2 and they both project the same library as grid component library so here we have to manage two different libraries for 2 different projects which is very difficult to manage in both projects at the same time.
To overcome this type of problem we can create one npm component library and we can use that library in both projects.
Here we create one npm grid component library and that library publishes to npm library. Now we install that library into our project project 1 and project 2 and if we want to update and manage just one library we need to manage.
2. What is create-react -library?
- It’s CLI(command line interface) for creating reusable, modern React libraries using create-react-library.
- E.g. When we use create-react-app at times it’s given ready to use application structure for react application. For the same way using create-react-library gives ready to use structure for creating react-library and publish to npm.
3. What are the prerequisites for it?
- Installed node and npm.
- Npm account (if not then sign up here: https://www.npmjs.com/signup).
- Public git repo.
- First of all, you need to come up with the name of your package and make sure that it’s available. Go to https://www.npmjs.com/ and check it through the search bar.
4. How to Create a React custom package library and publish it into npm?
Step: 1Login to NPM via CLI (How can we Login with NPM CLI?)
npm install -g npm-cli-login
npm-cli-login -u username -p PASSWORD -e email
- Step: 2Open your terminal, go to the directory, where you are going to create your package and enter the following command.
npx create-react-library <name of your package>After entering the above command, it will ask some questions about your package, provide details.
- Step: 3After follow above two step in that directory below files are created and sample demo component.
- Step: 4After successfully creating library project, enter the below command for starting library project.
cd && npm start
cd example && npm startfor starting example project which have used our created library.
Step: 6For publishing library enter below command
npm publish --access=public
Scopes and package visibilityThere are two types of libraries: public and private. public library called Unscoped packages and private library called scoped library. For publishing a scoped package you must have a paid version of npm account or organisation account.
After hitting the above command if your package successfully published then the below screen is visible.For cross verification you can also check on the npm website by searching your package.
- Unscoped packages are always public.
- Private packages are always scoped.
- Scoped packages are private by default; you must pass a command-line flag when publishing to make them public.
How can we implement it in other projects?
- Step : 1 Install package in your project e.g. npm install –save.
- Step : 2 Import package in component in which you want to use.
- Step : 3 import css file from package.
Some Important Points
- To publish a package as private for that we need a Paid account or organization account.
- For public packages we can set additional authentication methods that add another level of security for your package.
- For Update the package version change version in package.json file and again publish package.
- If you find any error like 403 forbidden then check your package name, make sure your npm email verification is done, your npm login via CLI is done, check package version.