Terminus UI Library
The library of UI components used for Terminus applications.
[![CircleCI][circle-badge]][circle-link]
[![codecov][codecov-badge]][codecov-project]
[![DavidDM][david-badge]][david-link]
[![DavidDM Dev][david-dev-badge]][david-link]
[![semantic-release][semantic-release-badge]][semantic-release]
[![Renovate][renovate-badge]][renovate-link]
[![MIT License][license-image]][license-url]
[![ZenHub][zenhub-image]][zenhub-url]
[![NPM version][npm-version-image]][npm-url]
[![Github release][gh-release-badge]][gh-releases]
[![Library size][file-size-badge]][raw-distribution-js]
Table of Contents
- Library Purpose
- Documentation
- Available Features
- Installation
- SCSS Helpers
- Contributing
- Contributors
- Project Resources
Library Purpose
This library was created to assist Terminus engineers in maintaining a consistent experience across
applications while following a unified design language.
The library is open source with the hopes that others may find solutions and ideas here, as we have
done while browsing so many other repositories. While we want to make decisions that are best for
everyone, in the end, the needs of the Terminus engineering team must come first.
If a deviation makes sense for the feature itself, but not for Terminus, we support (and will assist
in) abstracting the functionality out for generalization.
This library is heavily based on Material Design currently. This provides us a way to rely on very
well thought out usability and accessibility decisions for areas we have not yet addressed
internally. While we hold Material in high regard, we do not believe that all of their decisions are
best for the Terminus UI specifically.
Documentation
The available features table contains links for functional and usage documentation
for each feature.
Versioned Documentation and Demos
latest- [Latest TypeScript Documentation][docs-latest]
- [Latest Demos][demo-latest]
Available Features
- :hammer: started
- :white_check_mark: available
- :hankey: deprecated