Slash Web APP Component - React
Project structures:
For TypeScript setup: https://blog.harveydelaney.com/creating-your-own-react-component-library/
Placement in project structure:
--src/
---components/
---input/
---input.tsx
---inputBluePrintDecorator.tsx
---inputAntDesignDecorator.tsx
---inputReactstrap.tsx
---patterns/
---observer
---facade
---strategy
---decorator
---builder
---factory/
---formFactory.tsx
https://refactoring.guru/design-patterns/decorator/typescript/example
Using Decorator Pattern:Write the text component
/**
* The base Component interface defines operations that can be altered by
* decorators.
*/
interface TextInputInterface {
onChange(): void;
setValue(): void;
getValue(): string;
render(): object;
}
/*
* Class implementation
*/
class TextInput implements TextInputInterface {
public onChange(e): void {
this.value = e;
}
public setValue(value): void {
this.value = value;
}
public getValue(): string {
return this.value;
}
public render() {
return <></>;
}
}
/*
* Base Decorator
*/
class TextInputDecorator implements TextInputInterface {
protected component: Component;
constructor(component: Component) {
this.component = component;
}
public onChange(e): void {
this.component.onChange(e);
}
public setValue(value): void {
this.component.setValue(e);
}
public getValue(): string {
return this.component.getValue();
}
public render(): object {
return <input type="text" onChange={this.onChange} />;
}
}
/*
* Blueprint Decorator
*/
import { Input } from "@blueprint/core";
class TextInputBlueprintDecorator extends TextInputDecorator {
public render(): object {
return <Input onValueChange={({ target }) => super.onChange(target.value)}/>;
}
}
/*
* Reactstrap Decorator
*/
import { Input } from "reactstreap";
class TextInputBlueprintDecorator extends TextInputDecorator {
public render(): object {
return <Input onChange={({ target }) => super.onChange(target.value)}/>;
}
}
============== React TypeScript,Storybook Setup ===============
# React Component Library
[![Build status](https://badge.buildkite.com/90ff98db996bb137c5be1bdce666c4b1ce68a25b17af0a6a04.svg)](https://buildkite.com/harvey/react-component-library)
This project skeleton was created to help people get started with creating their own React component library using:
- [Rollup](https://github.com/rollup/rollup)
- [Sass](https://sass-lang.com/)
- [TypeScript](https://www.typescriptlang.org/)
It also features:
- [Storybook](https://storybook.js.org/) to help you create and show off your components
- [Jest](https://jestjs.io/) and [React Testing Library](https://github.com/testing-library/react-testing-library) enabling testing of the components
[**Read my blog post about why and how I created this project skeleton ▸**](https://blog.harveydelaney.com/creating-your-own-react-component-library/)
## Development
### Testing
```shell
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
You can then serve the files under storybook-static
using S3, GitHub pages, Express etc. I've hosted this library at: https://www.harveydelaney.com/react-component-library
Generating New Components
I've 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/components
/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
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;
Using Internal 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 harvey-component-library
into your project. To use the exported variables/mixins, in a SASS file you would do the following:
@import '~harvey-component-library/build/typography';
.example-container {
@include heading;
color: $harvey-white;
}
Can I code split my components?
Yes you can.
Read this section of my blog post to find out how.
Or check out this commit to see what changes are neccesary to implement it.