@tyb-u/tyb-ui-components NPM

🧱 tyb-ui-components

npm version

TYB's React component library. Visit the our storybook to learn more.

✅ React
✅ Styled components
✅ TypeScript
✅ Storybook
✅ Jest and React Testing Library
✅ CLI tool for creating new components

Additional support for:

✅ JSON
✅ images
✅ Code splitting

⚠️ Prerequisites

Node (v14.1.16) + NPM

🎉 Getting Started

Clone the repo and cd into the directory. Once there run npm install to download all the node dependencies.

Testing

npm run test

Building

npm run build

Storybook

npm run storybook

Generating New Components

npm run generate YourComponentName

🚀 Deployment

Hosting via NPM

Commits pushed to the main branch are automatically published to npm registry by Github Actions if all tests pass and a bigger package version is found in the package.json file.

Chromatic Storybook

Commits pushed to the main branch triggers a chromatic Storybook update. The chromatic storybook is published here:

💻 Usage

npm i --save @tyb-u/tyb-ui-components

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

import React from "react";
import { Box, Text } from "@tyb-u/tyb-ui-components";

const Component = () => (
  <Box>
    <Text>Hello I'm consuming the component library</Text>
  </Box>
);

export default Component;

More examples to be added