Skip to content

Commit 072b8da

Browse files
lazabogdanlazabogdan
committed
update docs
1 parent 0f7c626 commit 072b8da

7 files changed

Lines changed: 200 additions & 6 deletions

File tree

‎docs/src/html/code/sidebar-menu/collapse.html‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{% markdown %}
2+
```html
3+
<!-- Collapsible sidebar menu -->
4+
<ul class="sidebar-menu" data-toggle="sidebar-collapse">
5+
6+
<!-- Open menu item -->
7+
<li class="sidebar-menu-item open">
8+
<a href="#" class="sidebar-menu-button">Dashboard</a>
9+
10+
<!-- Submenu -->
11+
<ul class="sidebar-submenu">
12+
<li class="sidebar-menu-item active">
13+
<a href="#" class="sidebar-menu-button">Active menu item</a>
14+
</li>
15+
<li class="sidebar-menu-item">
16+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
17+
</li>
18+
</ul>
19+
</li>
20+
21+
<!-- Menu item -->
22+
<li class="sidebar-menu-item">
23+
<a href="#" class="sidebar-menu-button">Reports</a>
24+
25+
<!-- Submenu -->
26+
<ul class="sidebar-submenu">
27+
<li class="sidebar-menu-item">
28+
<a href="#" class="sidebar-menu-button">Another menu item</a>
29+
</li>
30+
<li class="sidebar-menu-item">
31+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
32+
</li>
33+
</ul>
34+
</li>
35+
36+
</ul>
37+
```
38+
{% endmarkdown %}

‎docs/src/html/layouts/default.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@
7777
<li class="sidebar-menu-item{% if slug === 'sidebar/menus' %} active{% endif %}">
7878
<a href="{{ path or '' }}sidebar/menus.html" class="sidebar-menu-button">Sidebar menus</a>
7979
</li>
80+
<li class="sidebar-menu-item{% if slug === 'sidebar/collapse' %} active{% endif %}">
81+
<a href="{{ path or '' }}sidebar/collapse.html" class="sidebar-menu-button">Sidebar menu collapse</a>
82+
</li>
8083
<li class="sidebar-menu-item{% if slug === 'sidebar/brand' %} active{% endif %}">
8184
<a href="{{ path or '' }}sidebar/brand.html" class="sidebar-menu-button">Sidebar brand</a>
8285
</li>
@@ -122,6 +125,7 @@
122125
<!-- // END Sidebar -->
123126

124127
{% include 'layouts/_footer.html' %}
128+
{% block footer %}{% endblock %}
125129

126130
</body>
127131
</html>

‎docs/src/html/layouts/sidebars/blank.html‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,65 @@
162162
</ul>
163163
{% endif %}
164164
<!-- // END Menu -->
165+
166+
{% if sm_collapse %}
167+
<!-- Sidebar menu -->
168+
<ul class="sidebar-menu {{ sm_collapse_opt or 'sm-active-button-bg' }}" data-toggle="sidebar-collapse">
169+
170+
<!-- Menu item -->
171+
<li class="sidebar-menu-item open">
172+
<a href="#" class="sidebar-menu-button">
173+
<i class="sidebar-menu-icon material-icons">home</i> Dashboard
174+
</a>
175+
176+
<!-- Submenu -->
177+
<ul class="sidebar-submenu {{ ssm_collapse_opt }}">
178+
<li class="sidebar-menu-item active">
179+
<a href="#" class="sidebar-menu-button">Active menu item</a>
180+
</li>
181+
<li class="sidebar-menu-item">
182+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
183+
</li>
184+
<li class="sidebar-menu-item">
185+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
186+
</li>
187+
<li class="sidebar-menu-item">
188+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
189+
</li>
190+
<li class="sidebar-menu-item">
191+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
192+
</li>
193+
</ul>
194+
</li>
195+
196+
<!-- Menu item -->
197+
<li class="sidebar-menu-item">
198+
<a href="#" class="sidebar-menu-button">
199+
<i class="sidebar-menu-icon material-icons">pie_chart</i> Reports
200+
</a>
201+
202+
<!-- Submenu -->
203+
<ul class="sidebar-submenu {{ ssm_collapse_opt }}">
204+
<li class="sidebar-menu-item">
205+
<a href="#" class="sidebar-menu-button">Another menu item</a>
206+
</li>
207+
<li class="sidebar-menu-item">
208+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
209+
</li>
210+
<li class="sidebar-menu-item">
211+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
212+
</li>
213+
<li class="sidebar-menu-item">
214+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
215+
</li>
216+
<li class="sidebar-menu-item">
217+
<a href="#" class="sidebar-menu-button">Regular menu item</a>
218+
</li>
219+
</ul>
220+
</li>
221+
222+
</ul>
223+
{% endif %}
165224

166225
{% if sm_text !== false %}
167226
<p class="sidebar-text">Lorem ipsum dolor sit amet, consectetur adipisicing elit. Fuga est asperiores mollitia, ut, qui totam? Accusantium asperiores nostrum ut temporibus inventore error iste sequi, quam, veritatis minus quod cum, sint?</p>

‎docs/src/html/pages/demo/sidebar-menu-basic.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ <h1 class="h3">{{ title }}</h1>
1717
<p>A basic sidebar menu.</p>
1818
</div>
1919
</div>
20-
{% include 'layouts/sidebars/blank.html' { sm_basic: true, sm_basic_opts: '', sm_brand: false, sm_heading: false, sm_text: false } %}
20+
{% include 'layouts/sidebars/blank.html' { sm_basic: true, sm_basic_opt: '', sm_brand: false, sm_heading: false, sm_text: false } %}
2121
</div>
2222

2323
{% endblock %}

‎docs/src/html/pages/demo/sidebar-menu-collapse.html‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Sidebar menu collapse
3+
path: ../
4+
---
5+
{% extends "layouts/demo.html" %}
6+
7+
{% block page %}
8+
9+
<div class="layout-container layout-sidebar-l3-md-up ls-top">
10+
<div class="layout-content" data-scrollable>
11+
<div class="container-fluid">
12+
<div class="hidden-md-up">
13+
<button class="btn btn-primary" data-target="#sidebar-blank-1" data-toggle="sidebar">Toggle Sidebar</button>
14+
<hr>
15+
</div>
16+
<h1 class="h3">{{ title }}</h1>
17+
<p>Collapsible sidebar menus.</p>
18+
</div>
19+
</div>
20+
{% include 'layouts/sidebars/blank.html' { style: 'sidebar-dark bg-primary', sm_collapse: true, ssm_collapse_opt: 'sm-condensed', sm_brand: false, sm_heading: false, sm_text: false } %}
21+
</div>
22+
23+
{% endblock %}

‎docs/src/html/pages/sidebar/collapse.html‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Sidebar menu collapse
3+
slug: sidebar/collapse
4+
path: ../
5+
---
6+
{% extends "layouts/default.html" %}
7+
8+
{% block page %}
9+
<h1>{{ title }}</h1>
10+
11+
<div class="card card-block">
12+
<ul class="nav nav-pills">
13+
<li class="nav-item">
14+
<a href="#usage-basic" data-toggle="pill" class="nav-link active">Usage</a>
15+
</li>
16+
<li class="nav-item">
17+
<a href="#usage-css" data-toggle="pill" class="nav-link">CSS</a>
18+
</li>
19+
<li class="nav-item">
20+
<a href="../demo/sidebar-menu-collapse.html" target="_blank" class="nav-link">Demo</a>
21+
</li>
22+
</ul>
23+
<div class="tab-content">
24+
<div class="tab-pane active" id="usage-basic">
25+
<blockquote>
26+
To create a collapsible sidebar menu, add the <code>data-toggle="sidebar-collapse"</code> attribute to any <code>.sidebar-menu</code> container. To create a basic sidebar submenu:
27+
</blockquote>
28+
<ul>
29+
<li>add an <code>ul.sidebar-submenu</code> within a top-level <code>li.sidebar-menu-item</code></li>
30+
<li>submenu items use the <code>.sidebar-menu-item</code> class</li>
31+
<li>submenu links use the <code>.sidebar-menu-button</code> class</li>
32+
<li><em><strong>optional</strong></em> add the <code>.open</code> class to any top-level <code>.sidebar-menu-item</code></li>
33+
</ul>
34+
35+
{% include 'code/sidebar-menu/collapse.html' %}
36+
</div>
37+
<div class="tab-pane" id="usage-css">
38+
<div class="table-responsive">
39+
<table class="table table-sm">
40+
<thead>
41+
<tr>
42+
<th>CSS Class</th>
43+
<th>Description</th>
44+
</tr>
45+
</thead>
46+
<tbody>
47+
<tr>
48+
<td><code>.sidebar-menu</code></td>
49+
<td>The sidebar menu wrapper (unordered list)</td>
50+
</tr>
51+
<tr>
52+
<td><code>.sidebar-submenu</code></td>
53+
<td>The sidebar submenu wrapper (unordered list placed within a top level <code>.sidebar-menu-item</code>)</td>
54+
</tr>
55+
<tr>
56+
<td><code>.sidebar-menu-item</code></td>
57+
<td>The sidebar menu item and sidebar submenu item (unordered list item)</td>
58+
</tr>
59+
<tr>
60+
<td><code>.sidebar-menu-button</code></td>
61+
<td>The sidebar menu link and sidebar submenu link</td>
62+
</tr>
63+
</tbody>
64+
</table>
65+
</div>
66+
</div>
67+
</div>
68+
</div>
69+
70+
{% endblock %}

‎docs/src/js/app.browserify.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
// Vendor libraries
22
// jQuery
3-
window.$ = window.jQuery = require('jquery');
3+
window.$ = window.jQuery = require('jquery')
44

55
// Tether (required by Bootstrap 4)
6-
window.Tether = require('tether');
6+
window.Tether = require('tether')
77

88
// Bootstrap 4
9-
require('bootstrap');
9+
require('bootstrap')
1010

1111
// Simplebar
12-
require('simplebar/dist/simplebar.min');
12+
require('simplebar/dist/simplebar.min')
1313

1414
// Bootstrap Layout
15-
require('bootstrap-layout');
15+
require('bootstrap-layout')
1616

1717
// Bootstrap Layout Scrollable
1818
require('bootstrap-layout-scrollable')

0 commit comments

Comments
 (0)