@addapptables/menu
v2.1.1
Published
Material menu library for angular
Downloads
33
Maintainers
Readme
ADDAPPTABLES menu
ADAPTABLES menu is a library for angular
Getting Started
To get started, let's install the package through npm:
Choose the version corresponding to your Angular version:
Angular | @addapptables/menu ----------- | ------------------- 8 | 2.x 7 | 1.x
npm i @addapptables/menu --S
Install peer dependencies
npm i
@addapptables/responsive
@addapptables/ngrx-actions
@addapptables/perfect-scrollbar
@addapptables/core
perfect-scrollbar
@ngrx/store
@ngx-translate/core --S
Configuration
- First, you have to configure the library @ngx-translate/core to have the translation into the menu
The library is configured as follows:
import { TranslateModule, TranslateLoader } from '@ngx-translate/core';
import { HttpClient, HttpClientModule } from '@angular/common/http';
import { TranslateHttpLoader } from '@ngx-translate/http-loader';
export function createTranslateLoader(http: HttpClient) {
return new TranslateHttpLoader(http, './assets/i18n/', '.json');
}
@NgModule({
imports: [
HttpClientModule,
TranslateModule.forRoot({
loader: {
provide: TranslateLoader,
useFactory: (createTranslateLoader),
deps: [HttpClient]
}
})
]
})
export class AppModule { }
To obtain more information about @ngx-translate/core view link
Addapptables menu uses the library ngrx as a base, you have to set this library in your AppModule as follows:
import { ResponsiveModule } from '@addapptables/responsive';
@NgModule({
imports: [
StoreModule.forRoot(...your configuration),
EffectsModule.forRoot([]),
ResponsiveModule // important
],
})
export class AppModule { }
- To obtain more information about ngrx view link
How to use?
- First, you have to create a module and import MenuModule as follows:
import { MenuModule } from '@addapptables/menu';
@NgModule({
imports: [MenuModule]
declarations: [MenuComponent]
})
export class YourModule { }
// component
import { MenuModel, MenuHeaderModel, MenuUserModel } from '@addapptables/menu';
@Component(
...
)
export class MenuComponent {
// variable to show the links of the menu
menus: MenuModel[] = [
{
id: '1',
class: 'material-icons',
value: 'dashboard',
title: 'menu.dashboard',
isOpen: false,
multiOption: false,
url: '/admin/dashboard',
exact: true,
},
{
id: '2',
class: 'material-icons',
value: 'chrome_reader_mode',
title: 'menu.forms',
isOpen: false,
multiOption: true,
exact: true,
children: [
{
id: '3',
value: 'BF',
title: 'menu.form.basicForm',
isOpen: false,
multiOption: false,
url: '/admin/forms/basic-form',
exact: true
}
]
}]
// header of the menu
header: MenuHeaderModel = {
companyName: 'ADDAPPTABLES',
logoUrl: 'assets/images/logo/addaptables.svg'
};
// user data
user: MenuUserModel = {
initialName: 'MG',
fullName: 'Mateo Guerra',
email: '[email protected]',
avatarUrl: 'assets/images/avatars/Velazquez.jpg'
};
}
- So now you can use the variables into the html as follows
<addapptable-menu>
<addapptable-menu-header [header]="header">
</addapptable-menu-header>
<addapptable-menu-user [user]="user">
</addapptable-menu-user>
<addapptable-menu-items-link [menus]="menus">
</addapptable-menu-items-link>
</addapptable-menu>
- In cellphone mode you can use the following component to colpase the menu
<addapptable-colapse-button-mobile></addapptable-colapse-button-mobile>
- Finaly, it is important to import the styles to the application
@import '~@addapptables/core/addapptables-grid.theme';
@import '~@angular/material/theming';
@import '~@addapptables/menu/_addapptables-menu.theme.scss';
$addapptable-app-primary: mat-palette($mat-teal, 800);
$addapptable-app-accent: mat-palette($mat-pink, 800, A100, 100);
$addapptable-app-warn: mat-palette($mat-red);
$addapptable-app-theme: mat-light-theme($addapptable-app-primary, $addapptable-app-accent, $addapptable-app-warn);
$addapptable-theme-variables: (
text: white,
transition-time: 250ms,
border-radius: 5px
);
@include mat-core();
body.theme-default {
@include angular-material-theme($addapptable-app-theme);
@include addapptable-menu($addapptable-app-theme, $addapptable-theme-variables);
}
- Do not forget to put the theme-default class on the html body
<body class="theme-default"></body>
Assets
Background menu sidebar
/assets/images/backgrounds/sidebar.jpg