mirror of
https://github.com/akveo/ngx-admin.git
synced 2025-12-23 02:40:14 +01:00
101 lines
No EOL
6.3 KiB
HTML
101 lines
No EOL
6.3 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<meta name="viewport" content="width=device-width">
|
||
<meta name="keywords" content="admin,dashboard,template,angular,bootstrap,blur,panel,html,css,javascript">
|
||
<title>BlurAdmin documentation - Sidebar</title>
|
||
<link rel="alternate" href="http://localhost:8080/feed.xml" type="application/rss+xml" title="">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900italic,900|Anonymous+Pro:400,700,400italic,700italic&subset=latin,greek,greek-ext,vietnamese,cyrillic-ext,latin-ext,cyrillic">
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.min.css">
|
||
<link rel="stylesheet" href="/ng2-admin/css/main.css">
|
||
<link rel="shortcut icon" href="/ng2-admin/images/favicon.png">
|
||
</head>
|
||
<body>
|
||
<div class="container">
|
||
<div class="nav-main">
|
||
<div class="wrap"><a href="/ng2-admin/" class="nav-home"><img src="/ng2-admin/images/logo.png" width="24" height="24" class="nav-logo"> <span class="blur-label">ng2-</span>admin</a>
|
||
<ul class="nav-site nav-site-internal">
|
||
<li><a href="/ng2-admin/">Home</a></li>
|
||
<li><a href="/ng2-admin/articles/001-getting-started/" class="active">Docs</a></li>
|
||
</ul><span class="nav-docs-right">Need some help? Let us know! <a href="mailto:contact@akveo.com">contact@akveo.com</a></span>
|
||
</div>
|
||
</div>
|
||
<section class="content wrap documentationContent">
|
||
<div class="nav-docs">
|
||
<div class="nav-docs section">
|
||
<h3>Quick Start</h3>
|
||
<ul>
|
||
<li><a href="/ng2-admin/articles/001-getting-started/">Getting Started</a></li>
|
||
<li><a href="/ng2-admin/articles/002-installation-guidelines/">Installation Guidelines</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="nav-docs section">
|
||
<h3>Customization</h3>
|
||
<ul>
|
||
<li><a href="/ng2-admin/articles/011-changing-color-scheme/">Changing Color Scheme</a></li>
|
||
<li><a href="/ng2-admin/articles/014-switch-to-blur-theme/">Enabling blur theme</a></li>
|
||
<li><a href="/ng2-admin/articles/012-project-structure/">Project Structure</a></li>
|
||
<li><a href="/ng2-admin/articles/013-create-new-page/">Create New Page</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="nav-docs section">
|
||
<h3>Components</h3>
|
||
<ul>
|
||
<li><a href="/ng2-admin/articles/016-spinner/">Theme Spinner</a></li>
|
||
<li><a href="/ng2-admin/articles/015-sidebar/" class="active">Sidebar</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="inner-content">
|
||
<h1>Sidebar</h1>
|
||
<div class="subHeader"></div><p>Sidebar is used to provide convenient way of navigation in the application.
|
||
Application supports only one sidebar per angular application.
|
||
That means sidebar is basically a singletone object.
|
||
Currently sidebar supports level 1 and 2 sub menus.</p>
|
||
<p>Sidebar can be added to the page using <code>BaSidebar</code> component:</p>
|
||
<pre><code class="lang-html"><span class="tag"><<span class="name">ba-sidebar</span>></span><span class="tag"></<span class="name">ba-sidebar</span>></span>
|
||
</code></pre>
|
||
<p>At the moment sidebar menu items configuration and Angular 2 Router should be configured independently. We probably will come up with a better solution once new Angular Router is released and stable.</p>
|
||
<h2 id="menu-configuration">Menu Configuration</h2>
|
||
<p>All menu items are located inside <code>src/app/app.menu.ts</code> file. The file contains a list of Menu Item objects with the following fields:</p>
|
||
<pre><code class="lang-javascript"> {
|
||
title: <span class="string">'Dashboard'</span>, <span class="comment">// menu item title</span>
|
||
component: <span class="string">'Dashboard'</span>, <span class="comment">// component where the menu should lead, has a priority over url property</span>
|
||
url: <span class="string">'http://google.com'</span> <span class="comment">// manual url address (used only when component is not specified)</span>
|
||
icon: <span class="string">'ion-android-home'</span>, <span class="comment">// icon class</span>
|
||
target: <span class="string">'_blank'</span>, <span class="comment">// link target attribute (used only when url is specified)</span>
|
||
selected: <span class="literal">false</span>, <span class="comment">// is item selected</span>
|
||
expanded: <span class="literal">false</span>, <span class="comment">// is item expanded (used only when subItems list specified)</span>
|
||
order: <span class="number">0</span> <span class="comment">// order in a list</span>
|
||
}
|
||
</code></pre>
|
||
<p>You also can define a list of sub-menu items like this:</p>
|
||
<pre><code class="lang-javascript"> {
|
||
title: <span class="string">'Charts'</span>,
|
||
component: <span class="string">'Charts'</span>,
|
||
icon: <span class="string">'ion-stats-bars'</span>,
|
||
selected: <span class="literal">false</span>,
|
||
expanded: <span class="literal">false</span>,
|
||
order: <span class="number">200</span>,
|
||
subMenu: [ <span class="comment">// list of sub-menu items</span>
|
||
{
|
||
title: <span class="string">'Chartist.Js'</span>, <span class="comment">// sub-item title</span>
|
||
component: <span class="string">'ChartistJs'</span> <span class="comment">// sum-item component </span>
|
||
},
|
||
]
|
||
}
|
||
</code></pre>
|
||
<h2 id="routes-configuration">Routes configuration</h2>
|
||
<p>Routes configuration is specified in the Page Components according to Angular 2 Router specification. More information you can find <a href="https://angular.io/docs/ts/latest/guide/router-deprecated.html">here</a>.</p>
|
||
|
||
</div>
|
||
</section>
|
||
<footer class="wrap">
|
||
<div class="left">Powered by Angular 2, Bootstrap 4, Webpack and many more...</div>
|
||
<div class="right">© 2015–2016 Akveo LLC<br />Documentation licensed under <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>.</div>
|
||
</footer>
|
||
</div><a href="https://github.com/akveo/ng2-admin" title="Star & Fork on GitHub" class="github-fork-ribbon"></a>
|
||
</body>
|
||
</html> |