Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 3.3 KB

README.md

File metadata and controls

83 lines (58 loc) · 3.3 KB

Tenrec UI

License: GPL v3 Build Status Coverage Status Contributor Covenant

Tenrec UI is a set of React UI components.

About the Name

Tenrec UI is named after the "Tenrec" - a kitten-sized, stout-bodied, nocturnal mammal endemic to Madagascar.

Tenrec

Why Tenrec UI

While we were aiming to use as many Material Design components as possible in our applications and web sites, there were many components that just fell short of the rich user experience that were being implemented by other companies and web sites. At that point Tenrec UI was born. If similar components are adopted by Material Design, we will work towards deprecating them (not removing them) from our library.

Installation

The best way to consume Tenrec UI is via the npm package which you can install with npm or yarn if you prefer.

// with npm
npm install tenrec-ui

Usage

These are the components available in the latest version of the library:

Component Example
Block Quote Block Quote
Box Tail Box Tail Left
Bullseye Bullseye Solid
Divider Divider Solid
Copyright Year Copyright Year
Emphasized Heading Emphasized Heading
Embossed Heading Embossed Heading
Estimated Read Time Estimated Read Time
Tag Cloud Tag Cloud Tag
Tag Cloud Tag Tag Cloud Tag
Time Line Time Line
Time Line Card Time Line Card
Zoom Image N/A

Importing Components

You should import individual components like tenrec-ui/bullseye rather than the entire library.

import { Bullseye } from 'tenrec-ui';

Demo

You can view a demo here.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Comprehensive documentation on how to contribute to this project are available here

This documentation is always being added to and please feel free to recommend additional areas where it can be improved.

License

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