simple_navigation_renderers 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/README.md +10 -23
- data/lib/simple_navigation_renderers/version.rb +1 -1
- data/simple_navigation_renderers.gemspec +3 -3
- metadata +11 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c00cff95a1185a8b873b98134a0bb6b19d0fac1a
|
4
|
+
data.tar.gz: ebd99ce35657e86dd9afba9860b96eaf37416624
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bb1fa84e2e7239206b7682aabd95b5ef57084f762328e9a4ffeffa34ec71dd6cc6de723feb999698ccc2a0729dad2eaa302f3395b801b1981ba99510ada3d71d
|
7
|
+
data.tar.gz: 01014f95772c346e50baa52069606e8a4a6d934aec7f87694ba70e2463f3f9f52b3218f0b99812ee5799fa1391dea8c6569ea729ad5f2890206b98b7cef7bf84
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -5,7 +5,7 @@ For now, it is include renderers for:
|
|
5
5
|
* [Bootstrap 2 navigation](http://getbootstrap.com/components/#navbar)
|
6
6
|
* [Bootstrap 3 navigation](http://getbootstrap.com/2.3.2/components.html#navbar)
|
7
7
|
|
8
|
-
With these renderers you
|
8
|
+
With these renderers you will be able create **any bootstrap navigation elements**, such as: **submenus**, **dividers**, **headers**. As well as add **icons** to menu elements, such as: gliphicons, font-awesome icons, even custom icons. Also you have **split** option for main menu containing submenu.
|
9
9
|
|
10
10
|
## Installation
|
11
11
|
|
@@ -30,31 +30,16 @@ $ gem install simple_navigation_renderers
|
|
30
30
|
|
31
31
|
## Usage
|
32
32
|
|
33
|
-
###
|
33
|
+
### Simply set up renderer and you are done!!
|
34
34
|
|
35
35
|
There are two ways to say that you want to use any of renderers.
|
36
36
|
|
37
37
|
1. You can specify it in you view as a parameter to `render_navigation`:
|
38
38
|
|
39
39
|
```erb
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
|
44
|
-
<span class="sr-only">Toggle navigation</span>
|
45
|
-
<span class="icon-bar"></span>
|
46
|
-
<span class="icon-bar"></span>
|
47
|
-
<span class="icon-bar"></span>
|
48
|
-
</button>
|
49
|
-
<%= link_to "Name", root_path, class: "navbar-brand" %>
|
50
|
-
</div>
|
51
|
-
<div class="collapse navbar-collapse navbar-ex1-collapse">
|
52
|
-
|
53
|
-
<%= render_navigation( expand_all: true, renderer: :bootstrap3 ) %>
|
54
|
-
|
55
|
-
</div>
|
56
|
-
</div>
|
57
|
-
</nav>
|
40
|
+
...
|
41
|
+
<%= render_navigation( expand_all: true, renderer: :bootstrap3 ) %>
|
42
|
+
...
|
58
43
|
```
|
59
44
|
|
60
45
|
2. Or you can set it in the very navigation configuration file (e.g. `config/navigation.rb`):
|
@@ -66,7 +51,7 @@ There are two ways to say that you want to use any of renderers.
|
|
66
51
|
end
|
67
52
|
```
|
68
53
|
|
69
|
-
###
|
54
|
+
### Explicit example of using all features
|
70
55
|
|
71
56
|
I think you already using `simple-navigation` gem and know how to define navigation items.
|
72
57
|
If not, you can always look at the [configuration instructions](https://github.com/andi/simple-navigation/wiki/Configuration) on the Simple Navigation wiki or read comments and examples in the generated by default `config/navigation.rb` file.
|
@@ -96,6 +81,8 @@ SimpleNavigation::Configuration.run do |navigation|
|
|
96
81
|
end
|
97
82
|
```
|
98
83
|
|
84
|
+
#### Features
|
85
|
+
|
99
86
|
Specific options used in the example:
|
100
87
|
|
101
88
|
* `:split` - Use it to split first level item link with caret. If you add `split: true` option to item, then caret itself will toggle first level submenu and link will have standard behaviour, instead of toggle submenu. You can use `:split` only with first level items, for the rest it will not do anything.
|
@@ -105,7 +92,7 @@ Specific options used in the example:
|
|
105
92
|
* `{text: "News", icon: "fa fa-fw fa-bullhorn"}` will create Font Awesome icon and add text after it (name of the item)
|
106
93
|
* `{icon: "glyphicon glyphicon-book", title: "Info"}` will create Bootstrap icon with title without any text after it
|
107
94
|
|
108
|
-
####
|
95
|
+
#### Notes
|
109
96
|
|
110
97
|
1. Bootstrap 3 has only one level submenu. If you want to use nested submenus as in example above, import `bootstrap2_dropdown_submenu.css.scss` file into your Sass file (e.g. `application.css.scss`) as following:
|
111
98
|
|
@@ -131,7 +118,7 @@ or you can add them all together:
|
|
131
118
|
@import "simple_navigation_bootstrap";
|
132
119
|
```
|
133
120
|
|
134
|
-
#### Result
|
121
|
+
#### Result of the example
|
135
122
|
|
136
123
|
Thus, above example will produce something like following code:
|
137
124
|
|
@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
|
|
8
8
|
spec.version = SimpleNavigationRenderers::VERSION
|
9
9
|
spec.authors = ["Pavel Shpak"]
|
10
10
|
spec.email = ["shpakvel@gmail.com"]
|
11
|
-
spec.description = %q{simple_navigation_renderers gem adds renderers for Bootstrap 2 and 3. With these renderers you
|
12
|
-
spec.summary = %q{simple_navigation_renderers gem adds renderers for Bootstrap 2 and 3. With these renderers you
|
13
|
-
spec.homepage = ""
|
11
|
+
spec.description = %q{simple_navigation_renderers gem adds renderers for Bootstrap 2 and 3. With these renderers you will be able create any bootstrap navigation elements, such as: submenus, dividers, headers. As well as add icons to menu elements, such as: gliphicons, font-awesome icons, even custom icons. Also you have split option for main menu containing submenu. }
|
12
|
+
spec.summary = %q{simple_navigation_renderers gem adds renderers for Bootstrap 2 and 3. With these renderers you will be able create any bootstrap navigation elements, such as: submenus, dividers, headers. As well as add icons to menu elements, such as: gliphicons, font-awesome icons, even custom icons. Also you have split option for main menu containing submenu. }
|
13
|
+
spec.homepage = "http://github.com/ShPakvel/simple_navigation_renderers"
|
14
14
|
spec.license = "MIT"
|
15
15
|
|
16
16
|
spec.files = `git ls-files`.split($/)
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: simple_navigation_renderers
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Pavel Shpak
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2013-11-
|
11
|
+
date: 2013-11-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: simple-navigation
|
@@ -81,9 +81,10 @@ dependencies:
|
|
81
81
|
- !ruby/object:Gem::Version
|
82
82
|
version: '0'
|
83
83
|
description: 'simple_navigation_renderers gem adds renderers for Bootstrap 2 and 3.
|
84
|
-
With these renderers you
|
85
|
-
submenus, dividers, headers. As well as add icons to menu elements, such
|
86
|
-
font-awesome icons, even custom icons.
|
84
|
+
With these renderers you will be able create any bootstrap navigation elements,
|
85
|
+
such as: submenus, dividers, headers. As well as add icons to menu elements, such
|
86
|
+
as: gliphicons, font-awesome icons, even custom icons. Also you have split option
|
87
|
+
for main menu containing submenu. '
|
87
88
|
email:
|
88
89
|
- shpakvel@gmail.com
|
89
90
|
executables: []
|
@@ -113,7 +114,7 @@ files:
|
|
113
114
|
- vendor/assets/stylesheets/bootstrap2_navbar_divider_vertical.css.scss
|
114
115
|
- vendor/assets/stylesheets/simple_navigation_bootstrap.css.scss
|
115
116
|
- vendor/assets/stylesheets/simple_navigation_bootstrap_overrides.css.scss
|
116
|
-
homepage:
|
117
|
+
homepage: http://github.com/ShPakvel/simple_navigation_renderers
|
117
118
|
licenses:
|
118
119
|
- MIT
|
119
120
|
metadata: {}
|
@@ -137,9 +138,10 @@ rubygems_version: 2.1.10
|
|
137
138
|
signing_key:
|
138
139
|
specification_version: 4
|
139
140
|
summary: 'simple_navigation_renderers gem adds renderers for Bootstrap 2 and 3. With
|
140
|
-
these renderers you
|
141
|
-
dividers, headers. As well as add icons to menu elements, such as:
|
142
|
-
icons, even custom icons.
|
141
|
+
these renderers you will be able create any bootstrap navigation elements, such
|
142
|
+
as: submenus, dividers, headers. As well as add icons to menu elements, such as:
|
143
|
+
gliphicons, font-awesome icons, even custom icons. Also you have split option for
|
144
|
+
main menu containing submenu.'
|
143
145
|
test_files:
|
144
146
|
- spec/lib/simple_navigation_renderers/bootstrap_spec.rb
|
145
147
|
- spec/lib/simple_navigation_renderers/exceptions_spec.rb
|