@ugikie/inputs v1.4.0
Input Components
This project contains custom Input components created using the following:
It also features:
- Storybook to help you test the variants of the components
- Jest and React Testing Library enabling testing of the components
Read this blog post about how to use this project skeleton ▸
Check out this CodeSandbox to see the component in action (WIP) ▸
Development
Developing
npm run start
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
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
Included in the project is 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 into without having to first publish the component. In the test-app
directory, you can run:
npm i --save ../Npm.Inputs
which will install the local component as a dependency in test-app
. It'll then appear as a dependency in package.json
like:
...
"dependencies": {
...
"@ugikie/inputs": "file:../Npm.Inputs",
...
},
...
Your components can then be imported and used in that project.
Usage
Let's say you are using the public NPM package called @ugikie/inputs
with the InputField
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 { InputField } from "@ugikie/inputs";
const App = () => (
<div className="app-container">
<h1>Hello I'm consuming the InputField component</h1>
<InputField name='Username' type='text' label='Username' />
</div>
);
export default App;
Check out this Code Sandbox for a live example (WIP).
Using Component SASS Variables
It's helpful to export SASS variables to projects consuming the component. As such, the rollup-plugin-copy
NPM package is included and is used 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.
For example, let's say you installed @ugikie/inputs
into your project. To use the exported variables/mixins, in a SASS file you would do the following:
@import '~@ugikie/inputs/build/typography';
.example-container {
@include heading;
color: $ugikie-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, you will need to look into how the original author of the library created a branch where they got styled-components
working in the component library, check it out here.
Component Code Splitting
Code splitting of your components is not supported by default.
Read this section of my blog post to find out how and why you would enable code splitting of your components. In summary, code splitting enables users to import components in isolation like:
import InputField from '@ugikie/inputs/build/InputField';
This can reduce the bundle size for projects using older (CJS) module formats.
You can check out this branch or this commit to see what changes are neccesary to implement it.
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 @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 @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.
Credit to Harvel Delaney for the original component library template HarveyD
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago