@blackboxsa/library NPM

Introduction

This documentation is for the component library built using Storybook and TypeScript. The library contains a set of reusable UI components that can be easily integrated into any project.

Development

install npm package from:

https://www.npmjs.com/package/@blackboxsa/library

npm install @blackboxsa/library

Import the components in your project:

import { [ComponentName] } from '@blackboxsa/library';

Rebase workflow

Make sure you have a local development branch in sync with your remote development branch at all times.

Make your local feature branch from the local development branch.

Develop as you usually would on your feature branch and make sure to run git pull origin development everytime you feel you've made a significant change.

Once you feel your feature branch is complete. Run git rebase development within your feature branch.

NB* ONLY REBASE BEFORE MERGING. ( NOT DURING ACTIVE DEVELOPMENT )

run git push

go to github, create a PR for your feature branch, then select the rebase branch option.

Follow that workflow and you should not get merge conflicts.

Further Usage

Each component has a set of props that can be passed to customize its behavior.

<[ComponentName] prop1={value1} prop2={value2} />

Storybook

The components in this library are developed and documented using Storybook. To run the Storybook locally, run the following command in your terminal:

npm run storybook This will start a local development server and open the Storybook in your browser. You can view the different components and their usage examples in the Storybook.

TypeScript Support The components in this library are written in TypeScript and include type definitions for all props. You can use these components in your TypeScript project with ease.

Conclusion This component library is a great resource for building UI components in a fast and efficient manner. The components are easy to use and customize, and the Storybook provides an excellent platform for documentation and development. Whether you are a seasoned developer or just starting out, this library is a great tool to have in your toolkit.