Skip to content

urbandataanalytics/bento-components

Repository files navigation

Bento Components Library

Bento Components Library

Simple, robust & beautiful

๐Ÿฑ (System to contain elements in an organized and beautiful way). Is an open-source component library built by Urban Data Analytics Team made with React

npm bundle size npm CircleCI Test Coverage Code style Dependabot Status

Getting Started

Run the following command using Yarn:

yarn add @uda/bento-components

If you prefer npm, use the following command instead:

npm install @uda/bento-components

๐Ÿš€ Usage

Load Roboto font from CDN:

<link href="https://fonts.googleapis.com/css?family=Roboto:400,500,700" rel="stylesheet" />

or via css:

@import url("https://fonts.googleapis.com/css?family=Roboto:400,500,700");

Now you can start using components:

import { Button } from '@uda/bento-components';

const Sample = () => <Button>Bento rules!</Button>;

๐Ÿ“š Storybook

UI components guide

Storybook

๐Ÿงช Update snapshots

 yarn test --updateSnapshot

๐Ÿ•น๏ธ Playroom

Bento Playroom

Create quick mock-ups and interactive prototypes with real code.

๐Ÿ“‹ Changelog

Please read the changelog.

๐Ÿ“ License

This project is licensed under the terms of the MIT license.