sw-components-library v1.0.1
React Component Library
Sweatworks React component library using:
It also features:
- Storybook to help you create and show off your components
- Jest and React Testing Library enabling testing of the components
Development
Testing
npm run test
Building
npm run build
Storybook
To run a live-reload Storybook server on your local machine:
npm run storybook
To export your Storybook as static files:
npm run storybook:export
Generating New Components
We included a handy NodeJS util file under util
called create-component.js
. Instead of copy pasting components to create a new component, you can instead run this command to generate all the files you need to start building out a new component. To use it:
npm run generate YourComponentName
This will generate:
/src
/YourComponentName
YourComponentName.tsx
YourComponentName.stories.tsx
YourComponentName.test.tsx
YourComponentName.types.ts
YourComponentName.scss
The default templates for each file can be modified under util/templates
.
Don't forget to add the component to your index.ts
exports if you want the library to export the component!
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
. It'll then appear as a dependency in package.json
like:
...
"dependencies": {
...
"react-component-library": "file:../react-component-library",
...
},
...
Your components can then be imported and used in that project.
Publishing
Usage
Usage of the component (after the library installed as a dependency into another project) will be:
import React from "react";
import { TestComponent } from "sweatworks-component-library";
const App = () => (
<div className="app-container">
<h1>Hello I'm consuming the component library</h1>
<TestComponent theme="primary" />
</div>
);
export default App;
Using Component Library SASS Variables
I've found that it's helpful to export SASS variables to projects consuming the library. As such, I've added the rollup-plugin-copy
NPM package and used it to copy the typography.scss
and variables.scss
into the build
directory as part of the Rollup bundle process. This allows you to use these variables in your projects consuming the component library.
For example, let's say you installed sweatworks-component-library
into your project. To use the exported variables/mixins, in a SASS file you would do the following:
@import '~sweatworks-component-library/build/typography';
.example-container {
@include heading;
color: $sweatworks-white;
}
Additional Help
Using Alternatives to Sass
Less or Stylus
The Rollup plugin rollup-plugin-postcss
supports Sass, Less and Stylus:
- For Stylus, install stylus:
yarn add stylus --dev
- For Less, install less:
yarn add less --dev
You can then remove node-sass
from your dependencies.
CSS Modules
If you want to use CSS Modules, update postcss
in rollup-config.js
to:
postcss({
modules: true
})
Styled Components
If you want to use styled-components
, the changes required are a bit more involved. As such, I've created a branch where I've got styled-components
working in this component library.
Component Code Splitting
Code splitting of your components is not supported by default.
In summary, code splitting enables users to import components in isolation like:
import TestComponent from 'sweatworks-component-library/build/TestComponent';
This can reduce the bundle size for projects using older (CJS) module formats.
Please note, there's an issue with code splitting and using rollup-plugin-postcss
. I recommend using rollup-plugin-sass
instead alongside code splitting.
Supporting Image Imports
Add the following library to your component library @rollup/plugin-image:
npm i -D @rollup/plugin-image
Then add it to rollup-config.js
:
...
plugins:[
...,
image(),
...
]
...
You can then import and render images in your components like:
import logo from "./rollup.png";
export const ImageComponent = () => (
<div>
<img src={logo} />
</div>
);
Supporting JSON Imports
Add the following library to your component library @rollup/plugin-json:
npm i -D @rollup/plugin-json
Then add it to rollup-config.js
:
...
plugins:[
...,
json(),
...
]
...
You can then import and use JSON as ES6 Modules:
import data from "./some-data.json";
export const JsonDataComponent = () => <div>{data.description}</div>;
Checkout the official Rollup plugin list for additional helpful plugins.
3 years ago