# wonka-ui

> [![npm version](https://badge.fury.io/js/wonka-ui.svg)](https://badge.fury.io/js/wonka-ui)

Latest version **1.0.1** (published 2020-04-17) · CC-BY-4.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install wonka-ui
pnpm add wonka-ui
yarn add wonka-ui
bun add wonka-ui
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-04-17 |
| First published | 2020-04-16 |
| Weekly downloads | 0 |
| License | CC-BY-4.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 621.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | emmalitzler |

## Links

- npm: https://www.npmjs.com/package/wonka-ui
- Repository: https://github.com/SINTEF/wonka-ui
- Homepage: https://github.com/SINTEF/wonka-ui#readme
- Issues: https://github.com/SINTEF/wonka-ui/issues
- npm.io page: https://npm.io/package/wonka-ui

## Dependencies (3)

- [tslib](https://npm.io/package/tslib.md) ^1.9.0
- [chart.js](https://npm.io/package/chart.js.md) ^2.9.2
- [ng2-charts](https://npm.io/package/ng2-charts.md) ^2.3.0

## Recent versions

- 1.0.1 (latest) — 2020-04-17
- 1.0.1-beta.4 — 2020-04-17
- 1.0.1-beta.3 — 2020-04-16
- 1.0.1-beta.2 — 2020-04-16
- 1.0.1-beta.1 — 2020-04-16
- 1.0.1-beta.0 — 2020-04-16

## README

[![npm version](https://badge.fury.io/js/wonka-ui.svg)](https://badge.fury.io/js/wonka-ui)

# Angular wonka-ui - UI component library using Bulma CSS framework styles
wonka-ui is a front-end/user interface framework written in Angular and Typescript, aimed towards making front-end components and code re-usable within SINTEF Connect.

---

## Versions

| Angular| wonka-ui|
| ------|:------:| 
| >=8.0.0 <9.0.0  | v1.x |

---

Table of contents

  * [Components](#components)
  * [Getting started](#getting-started)
  * [Demo application](#demo-application)
  * [License](#license)
  
## Components
- [x] ChartModule - simple wrapper for chart.js
- [x] KeyValueUnitListModule - module for creating a simple key-value list
- [x] ListModule - module for creating a simple list, emits event on item click
- [x] TableModule - module for creating a simple table, emits event on row click
- [x] FormModule - simple reactive form 
- [x] InfoModule - info module with header, content and image
- [x] NavigationBarModule - simple navigation bar

## Warning
Library is under active development and may have API breaking changes for subsequent major versions after 1.0.0.

## Getting started
### Step 1: Install `wonka-ui`:

#### NPM
```shell
npm install --save wonka-ui
```
### Step 2: Import the chosen wonka-ui modules:
```js
import { NavigationBarModule, InfoPanelModule } from 'wonka-ui';

@NgModule({
  declarations: [AppComponent],
  imports: [NavigationBarModule, InfoPanelModule],
  bootstrap: [AppComponent]
})
export class AppModule {}
```
## Demo application
The github repository includes a demo application that demonstrates use of the wonka-ui modules.

### Run demo application on default port 4200
```
git clone https://github.com/SINTEF/wonka-ui.git
cd wonka-ui
npm install
cd projects/application/src
npm run start-demo
```
Open demo-app on http://localhost:4200
### Testing
```
npm run test
```

## License
Shield: [![CC BY 4.0][cc-by-shield]][cc-by]

This work is licensed under a [Creative Commons Attribution 4.0 International
License][cc-by].

[![CC BY 4.0][cc-by-image]][cc-by]

[cc-by]: http://creativecommons.org/licenses/by/4.0/
[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg
=======

---
_Source: https://npm.io/package/wonka-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._