ornamentum/README.md

Angular Toolkit

<p align="center">
  <img src="https://ornamentum.app/assets/docs/ornamentum.svg" alt="ornamentum"/>
  
  <a href="https://travis-ci.org/yohangz/ornamentum">
    <img src="https://travis-ci.org/yohangz/ornamentum.svg?branch=master" alt="travis build" height="18">
  </a>
  <a href="https://github.com/yohangz/ornamentum/blob/master/LICENSE">
    <img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="license" height="18">
  </a>  
  <a href="https://badge.fury.io/js/ornamentum">
    <img src="https://badge.fury.io/js/ornamentum.svg" alt="npm version" height="18">
  </a>
</p>

> Ornamentum data table is a lightweight, feature rich, highly configurable, UI framework agnostic, fully responsive, reactive Angular data table with no external dependencies. 

> Check out [demos](https://ornamentum.app) & [docs](https://ornamentum.app/api-docs/) for more information!

## :book: Table of Contents

  - [Features](#bulb-features)
  - [Peer Dependencies](#zap-peer-dependencies)
  - [Installation](#rocket-installation)
  - [Contributions](#palm_tree-contributions)
    - [Contributors](#dizzy-contributors)    
    - [How to Contribute](#seedling-how-to-contribute)
  - [Changelog](#warning-changelog)
  - [License](#copyright-license)
  
## :bulb: Features

<img src="https://ornamentum.app/assets/docs/data-client.svg" alt="Client data bind"/> Client-side data binding support </br>
<img src="https://ornamentum.app/assets/docs/data-server.svg" alt="Server data bind"/> Server-side data binding support </br>
<img src="https://ornamentum.app/assets/docs/data-realtime.svg" alt="Real time data bind"/> Realtime data source support with observables </br>
<img src="https://ornamentum.app/assets/docs/sort.svg" alt="Sorting"/> Single and Multi column sorting </br>
<img src="https://ornamentum.app/assets/docs/filter.svg" alt="Filtering"/> Single and Multi value filtering </br>
<img src="https://ornamentum.app/assets/docs/layout.svg" alt="Layouting"/> Custom Layout templating support </br>
<img src="https://ornamentum.app/assets/docs/persist.svg" alt="Persistence"/> Data table state persistence with session or local storage modes </br>
<img src="https://ornamentum.app/assets/docs/paging.svg" alt="Paging"/> Client and Server-side pagination </br>
<img src="https://ornamentum.app/assets/docs/select.svg" alt="Selection"/> Single, Multi and Single toggle row selection modes </br>
<img src="https://ornamentum.app/assets/docs/palette.svg" alt="Theming"/> UI Theme support </br>
<img src="https://ornamentum.app/assets/docs/row-expand.svg" alt="Detail row"/> Detail row expand support </br>
<img src="https://ornamentum.app/assets/docs/resize.svg" alt="Resizing"/> Experimental column resizing </br>
<img src="https://ornamentum.app/assets/docs/group.svg" alt="Grouping"/> Experimental row grouping support </br>
<img src="https://ornamentum.app/assets/docs/event-bind.svg" alt="Global configuration"/> Global Configuration overriding capability </br>
<img src="https://ornamentum.app/assets/docs/translate.svg" alt="Translation"/> Translation support and much more

## :zap: Peer Dependencies

- [@angular/common](https://www.npmjs.com/package/@angular/common): ^8.0.0-rc.0 || ^8.0.0
- [@angular/core](https://www.npmjs.com/package/@angular/core): ^8.0.0-rc.0 || ^8.0.0
- [@angular/forms](https://www.npmjs.com/package/@angular/forms): ^8.0.0-rc.0 || ^8.0.0
- [rxjs](https://www.npmjs.com/package/rxjs): ^6.0.0

## :rocket: Installation

Install the Ornamentum node module using either of following command depending on your package manager.

```npm install ornamentum --save```

or

```yarn add ornamentum```

Ornamentum major versions are aligned with Angular Major versions hence, You can ony use Ornamentum 8.x.x versions with Angular 8.x.x version.

## :palm_tree: Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
| [<img src="https://avatars2.githubusercontent.com/u/5279079?s=400&v=4" width="100px;"/><br /><sub><b>Yohan Gomez</b></sub>][yohan-profile]<br />[💻](https://github.com/yohangz/ornamentum/commits?author=yohangz "Code") [💬](https://github.com/yohangz/ornamentum/issues "Answering Questions") [📖](https://ornamentum.app "Documentation") [🎨](#design-yohangz "Design") [💡](https://ornamentum.app/feature/data-table/overview "Examples") [🤔](#ideas-yohangz "Ideas & Planning") [🚇](https://github.com/yohangz/ornamentum/blob/master/.travis.yml "Infrastructure") [👀](https://github.com/yohangz/ornamentum/pulls "Review Pull Requests") | [<img src="https://avatars1.githubusercontent.com/u/6312524?s=460&v=4" width="100px;"/><br /><sub><b>Lahiru Jayamanna</b></sub>][lahiru-profile]<br />[💻](https://github.com/yohangz/ornamentum/commits?author=lahiruz "Code") [💬](https://github.com/yohangz/ornamentum/issues "Answering Questions") [📖](https://ornamentum.app "Documentation") [🎨](#design-lahiruz "Design") [💡](https://ornamentum.app/feature/data-table/overview "Examples") [🤔](#ideas-lahiruz "Ideas & Planning") [👀](https://github.com/yohangz/ornamentum/pulls "Review Pull Requests") | [<img src="https://avatars3.githubusercontent.com/u/35022498?s=460&v=4" width="100px;"/><br /><sub><b>Samuditha Wadigamangawa</b></sub>][samuditha-profile]<br />[💻](https://github.com/yohangz/ornamentum/commits?author=samudithaw "Code") [💬](https://github.com/yohangz/ornamentum/issues "Answering Questions") [📖](https://ornamentum.app "Documentation") [🎨](#design-samudithaw "Design") [💡](https://ornamentum.app/feature/data-table/overview "Examples") [🤔](#ideas-samudithaw "Ideas & Planning") [👀](https://github.com/yohangz/ornamentum/pulls "Review Pull Requests") | [<img src="https://avatars2.githubusercontent.com/u/29842949?s=460&v=4" width="100px;"/><br /><sub><b>Aravinda Rathnayake</b></sub>][aravinda-profile]<br />[💬](https://github.com/yohangz/ornamentum/issues "Answering Questions") [📖](https://ornamentum.app "Documentation") [💡](https://ornamentum.app/feature/data-table/overview "Examples") [🤔](#ideas-samudithaw "Ideas & Planning") [👀](https://github.com/yohangz/ornamentum/pulls "Review Pull Requests") [🐛](https://github.com/yohangz/ornamentum/issues "Bug Reports") |
| :---: | :---: | :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
Contributions of any kind are welcome!

## :seedling: How to Contribute

Setup project in local development environment

```sh
# clone project
git clone git@github.com:yohangz/ornamentum.git && cd $_

# install dependencies
npm install

# start the app
npm run start
```
You can read more about Ornamentum build tasks [here](https://github.com/yohangz/ornamentum/blob/master/docs/BUILD_TASK.md) and refer [Contribution Guide](https://github.com/yohangz/ornamentum/blob/master/docs/CONTRIBUTING.md) for more details.

## :warning: Changelog

Recent changes can be viewed on [CHANGELOG.md](https://github.com/yohangz/ornamentum/blob/master/docs/CHANGELOG.md)

## :copyright: License

Ornamentum was license under [MIT](https://opensource.org/licenses/MIT). Please refer [LICENSE][license] for more information.

[license]: https://github.com/yohangz/ornamentum/blob/master/LICENSE

[yohan-profile]: https://github.com/yohangz
[lahiru-profile]: https://github.com/lahiruz
[samuditha-profile]: https://github.com/samudithaw
[aravinda-profile]: https://github.com/aravindarr