pub-test-comp v1.0.0

React Component Library

This project skeleton was created to help people get started with creating their own React component library using:

• Rollup
• Sass
• TypeScript

It also features:

• :white_check_mark: Storybook to help you create and show off your components
• :white_check_mark: Jest and Enzyme enabling testing of the components

Read my blog post about why and how I created this project skeleton ▸

Development

Testing

npm run test

Building

npm run build

Storybook

npm run storybook

Installing component library locally

Let's say you have another project (test-app) on your machine that you want to try installing the component library into without having to first publish the component library. In the test-app directory, you can run:

npm i --save ../react-component-library

which will install the local component library as a dependency in test-app. Your components can then be imported and used.

Publishing

First make sure that you've updated the name field in package.json to reflect your NPM package name in your private or public NPM registry. Then run:

npm publish

Component Usage

Let's say you created a public NPM package called harvey-component-library with the TestComponent component created in this repository.

Usage of the component (after the library installed as a dependency into another project) will be:

import React from "react";
import { TestComponent } from "harvey-component-library";

const App = () => (
    <div className="app-container">
        <h1>Hello I'm consuming the component library</h1>
        <TestComponent theme="primary" />
    </div>
);

export default App;