bloqzone-react-components v1.0.41

bloqzone-components

Install

yarn add bloqzone-react-components

Commands

TSDX scaffolds your new library inside /src, and also sets up a Parcel-based playground for it inside /example.

The recommended workflow is to run TSDX in one terminal:

yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

Then run either Storybook or the example playground:

Storybook

Run inside another terminal:

yarn storybook

This loads the stories from ./stories.

NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.

Example

Then run the example inside another:

cd example
yarn
yarn start

The default example imports and live reloads whatever is in /dist, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. No symlinking required, we use Parcel's aliasing.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Usage

import React, { FC } from 'react';

import { Example } from 'bloqzone-react-components';
import "../node_modules/bloqzone-react-components/public/tailwind.css";
import "../node_modules/bloqzone-react-components/public/fonts.css";

const App = () => {
  return <Example text="Bloqzone React Components Library Example" />;
};