# ngx-dashboard-tammle

> Providing components to build basic dashboard layout

Latest version **0.0.6** (published 2019-06-03) · 0 weekly downloads

## Install

```sh
npm install ngx-dashboard-tammle
pnpm add ngx-dashboard-tammle
yarn add ngx-dashboard-tammle
bun add ngx-dashboard-tammle
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2019-06-03 |
| First published | 2019-05-29 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 110 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tam Minh Le |
| Maintainers | tammle |

## Links

- npm: https://www.npmjs.com/package/ngx-dashboard-tammle
- Repository: https://github.com/tammle/library
- Homepage: https://github.com/tammle/library#readme
- Issues: https://github.com/tammle/library/issues
- npm.io page: https://npm.io/package/ngx-dashboard-tammle

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.9.0

## Recent versions

- 0.0.6 (latest) — 2019-06-03
- 0.0.5 — 2019-06-03
- 0.0.4 — 2019-05-31
- 0.0.3 — 2019-05-31
- 0.0.2 — 2019-05-30
- 0.0.1 — 2019-05-29

## README

# NgxDashboard

## Installation instructions
Install from NPM:
`npm install ngx-dashboard-tammle --save`

## Usage
`import { NgxDashboardModule } from 'ngx-dashboard-tammle';`

```javascript
@NgModule({
  imports: [
    NgxDashboardModule
  ],
  ...
})
export class AppModule { }
```

### Provided Components
`<dashboard-header></dashboard-header>`

This will show your template content that passed within the opening & closing tags. E.g:

```html
  <dashboard-header>
    <p>Your content here!</p>  
  </dashboard-header>
```
Pre-made components that could compose with `<dashboard-header>`, use it, at your convenience, or build your own templates:
```html
<dashboard-header>
  <!-- @Input title: string 
       @Input imgUrl: string -->
  <header-logo
        [title]="'Home'"
        [imgUrl]="'Your Url Here'">
  </header-logo>
  
  <!-- @Input title: string 
       @Input profileLink: string
       @Input avatarUrl: string -->
  <user-avatar
        [title]="'User Avatar'"
        [profileLink]="'/'"
        [avatarUrl]="'/'"
      >
      </user-avatar>
  
  <!--Dropdown menu-->
  <user-profile></user-profile>
</dashboard-header>
```

`<dashboard-sidebar></dashboard-sidebar>`

Comes with default template. You can also customize the template if needed. E.g:
```html
<dashboard-sidebar [sidebarTemplate]="customSidebar"></dashboard-sidebar>
    <ng-template #customSidebar>
      Customized template here!
    </ng-template>
```

`<dashboard-footer></dashboard-footer>` - Static content, non-configurable.

`<dashboard-login></dashboard-login>`

Callback `loginSubmitted` provided with `User` model as argument, use this to handle business on form submitted.E.g: 

```html
<dashboard-login (loginSubmitted)="showProfilePopup($event)"></dashboard-login>
```

### Build
The src files for the library lives under projects/ngx-dashboard/src/lib directory. 

`ng build NgxDashboardTammle`

### Publish
Change your terminal working directory to /dist/ngx-dashboard. Then run:

`npm publish`

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