shashank-first-npm-build
v0.1.0
Published
For refrence[https://levelup.gitconnected.com/publish-react-components-as-an-npm-package-7a671a2fb7f]
Downloads
2
Readme
Shashank Maurya
Creating Own NPM component
For refrence[https://levelup.gitconnected.com/publish-react-components-as-an-npm-package-7a671a2fb7f]
Steps
- I created added a folder called lib inside src that will store everything I want to publish on npm. Inside lib , there is a folder called components to store the component elements and a file called index.js to export them. (This seems to be a standard, based on other tutorials and the Carbon’s library.)
2.Inside the components folder, I create new files called Button.js and Badge.js, which will be the components to use from the npm package. The code for these components isn’t very important, but I’ll list it below.
Button.js
import React from 'react';
const Button = (props) => {
return (
<button className={btn btn--${props.kind} CTA
}
data-id={props.id}
type={props.type}
name={props.name}
value={props.value}
disabled={props.disabled}
onClick={props.handleClick}>
{props.label}
)
}
export default Button;
Badge.js
import React from 'react';
const Badge = (props) => {
return (
<div className={badge ${!props.value ? 'badge--none' :''}
}
{props.value || 0}
)
}
export default Badge;
Install Babel and build the dist folder
npm install --save-dev @babel/core @babel/cli @babel/preset-env npm install -save @babel/polyfill
In the top-level folder of your project, add a file called babel.config.json and add the following presets: { "presets": [ [ "@babel/env", { "targets": { "edge": "17", "firefox": "60", "chrome": "67", "safari": "11.1" }, "useBuiltIns": "usage", "corejs": "3.6.5" } ], "@babel/preset-react" ] }
In package.json , under scripts, replace the build script with the following: "build": "babel src/lib --out-dir dist --copy-files";
Run the command npm run build in the CLI.
Change package.json
"name": "first-npm-component-shashank", //unique name for npm module that has not been taken
"description": "Two test npm component creation",
"author": "shashank",
"keywords": ["react", "components", "ui"],
"version": "0.1.0",
"private": false,
"main": "dist/index.js", //main js file where all component are exported
"module": "dist/index.js",
"files": [ "dist", "README.md" ],
"repository": { //optional not done in my case
"type": "git",
"url": "git+https://github.com/jawblia/npm-test.git"
},
- npm publish
Use the new package
1.npm install jawblia
import { Button } from 'jawblia'; import Flex from './layout/Flex'; function App() { return (