tenrec-ui v1.0.63

Tenrec UI

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.

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
Box Tail
Bullseye
Divider
Copyright Year
Emphasized Heading
Embossed Heading
Estimated Read Time
Tag Cloud
Tag Cloud Tag
Time Line
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

Contributing guidelines are available here

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

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