Andreas/ngx-admin
1
0
Fork 0
mirror of https://github.com/akveo/ngx-admin.git synced 2025-12-23 02:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #91 from myadhdoutlet/patch-1

Browse source 
Copy-editing and fixed some typos
This commit is contained in:
Dmitry 2016-07-18 12:17:53 +03:00 • committed by GitHub
commit 7dd32c9fd6
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/contents/articles/015-sidebar/index.md
View file

@ -6,21 +6,21 @@ group: Components
template: article.jade template: article.jade
--- ---
Sidebar is used to provide convenient way of navigation in the application. The sidebar provides a convenient way to navigate the application.
Application supports only one sidebar per angular application. Only one sidebar is supported per angular application.
That means sidebar is basically a singletone object. This means that sidebar is basically a singleton object.
Sidebar can be added to the page using `BaSidebar` component: Sidebar can be added to the page using the `BaSidebar` component:
```html ```html
<ba-sidebar></ba-sidebar> <ba-sidebar></ba-sidebar>
``` ```
The sidebar contains a `<ba-menu></ba-menu>` component which defines and renders application menu based on routes provided. Generally `ba-menu` component can be used separately from `ba-sidebar`. The sidebar contains a `<ba-menu></ba-menu>` component which defines and renders the application menu based on routes provided. Generally the `ba-menu` component can be used separately from `ba-sidebar`.
All menu items information defined inside the `data` properly of a route. All menu items information is defined inside the `data` property of a route.
## Menu Configuration ## Menu Configuration
All menu items are located inside `src/app/app.routes.ts` file. Each route item can have a `menu` property under `data` defining a menu item: All menu items are located inside the `src/app/app.routes.ts` file. Each route item can have a `menu` property under `data` defining a menu item:
```javascript ```javascript
{ {
@ -28,13 +28,13 @@ All menu items are located inside `src/app/app.routes.ts` file. Each route item
path: 'dashboard', path: 'dashboard',
component: Dashboard, component: Dashboard,
data: { data: {
// here additionaly we difine how the menu item should look like // here additionaly we define how the menu item should look
menu: { menu: {
title: 'Dashboard', // menu title title: 'Dashboard', // menu title
icon: 'ion-android-home', // menu icon icon: 'ion-android-home', // menu icon
selected: false, // selected or not selected: false, // selected or not
expanded: false, // expanded or not (if item has children) expanded: false, // expanded or not (if item has children)
order: 0 // and item order in the menu list order: 0 // item order in the menu list
} }
} }
} }