Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

mandala

1.3.2 • Public • Published

mandala

Mandala UI

CircleCI Coverage Status bitHound Overall Score bitHound Dependencies DeepScan grade

Mandala is a UI Component Library built with React and Tachyons, a tiny (30kb GZIP) Declarative CSS library

Installation

Check out our Interactive Docs before you decide if this package is right for you.

The only real dependencies to use Mandala are React, and Tachyons.io

You can add the CDN version of tachyons to the head of your project to easily get started.

<link rel="stylesheet" href="https://unpkg.com/tachyons@4.9.1/css/tachyons.min.css"/>

If you have a CSS build pipeline in your React project, you can also

yarn install tachyons

Components

If you like you can install the Mandala UI Components as a whole with:

yarn install mandala

And then import the relevant ones with

import { ProgressBar } from 'mandala'

Each of the Mandala components are published to NPM separately as scoped packages.

If you'd just like to use a single component (e.g. you are already using Tachyons) you can install the scoped packages.

yarn install @mandala-ui/progress-bar

then import the component

import ProgressBar from '@mandala-ui/progress-bar'

Either way you will need Tachyons installed

Contributing

Mandala is set up to easily get you contributing new components.

It uses React Storybook as a development environment.

So to get started, run:

yarn run generate

And follow the prompts. This will scaffold a new component and generate the Jest test files, as well as a Storybook Story for interactive documentation.

Storybook stories use mostly these two addons for development.

yarn start

Go to http://localhost:6006/

and find your component which will render empty, now you can start composing CSS classes.

A PR of a new Component requires 3 things:

  • A README that completely documents the props and their usage
  • Interactive documentation in the form of a Storybook Story
  • 100% Jest Test Coverage.

mandala-bottom

Install

npm i mandala

DownloadsWeekly Downloads

32

Version

1.3.2

License

MIT

Unpacked Size

11.1 kB

Total Files

30

Last publish

Collaborators

  • avatar