# ionic-tree-view

**Repository Path**: codeox/ionic-tree-view

## Basic Information

- **Project Name**: ionic-tree-view
- **Description**: This library is used to generate a treeview from an object list
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-08-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Tree-view

This library is used to generate a treeview from an object list, you will find an example of a list below:

```json
[ { "id":1, "name":"features" }, { "id":2, "name":"Add", "parentID":1 }, { "id":3, "name":"Remove", "parentID":1 }, { "id":9, "name":"Update", "parentID":1 }, { "id":11, "name":"UpdateDel", "parentID":9 }, { "id":27, "name":"Add", "parentID":2 }, { "id":28, "name":"master" } ]
```

## Rendering
![alt text](https://user-images.githubusercontent.com/17003290/37466561-5949cd60-285e-11e8-93a2-4b33662a20ed.png)

## Installation

To install this library, run:

```bash
$ npm install ionic-tree-view --save
```
## Use library into Ionic Project

Once you have installed, you can import library in any Ionic application by doing:

```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

// Import library
import { IonicTreeViewModule } from 'ionic-tree-view';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,

    // Specify library as an import
    IonicTreeViewModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }
```

Once your library is imported, you can use component in your Ionic application:

```xml
<!-- You can now use component in home.html -->
  <ion-tree-view [items]="items" [persistedName]="persistedName" [treeViewName]="treeViewName"></ion-tree-view>
```

```typescript
  public items = [..];
  public persistedName = "MyItemsPersisted";
  public treeViewName = "MyItemsTreeView";
```

## Inputs

1. items
This represents the elements that will form the treeview

2. persistedName
This allows you to save checked items in the local storage.

3. treeViewName
This is the name of your treeview

## License

MIT © [Gregory Heyligen](mailto:cudderheyl@gmail.com)