bootstrap-tab-history-rails 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +202 -0
- data/README.md +106 -0
- data/lib/bootstrap-tab-history-rails.rb +2 -0
- data/lib/bootstrap-tab-history-rails/rails/engine.rb +6 -0
- data/lib/bootstrap-tab-history-rails/version.rb +3 -0
- data/vendor/assets/javascripts/bootstrap-tab-history.js +294 -0
- metadata +91 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: d689559e8136f12f0111e015f02dbbebe47af23d
|
|
4
|
+
data.tar.gz: 55de4342df38c7ac88e6baeebc22f6f9777b5635
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 246da556b1fa17f27286ea240f3b3be2da53ef1d9182fb8b5545c2982f3c82dd420c6ccd7a762286dc345a11688afc86a9c57de94b7b431f809c42e340d99f99
|
|
7
|
+
data.tar.gz: ada867eec4d31b9c4d5ac733beeb746867806eea3974240bbfdb3a194f1c2c012d15e88126f3293aa9e9eee9347948d2fc94846e4ebd1721f861936c3059d186
|
data/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
data/README.md
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
Bootstrap Tab History
|
|
2
|
+
=====================
|
|
3
|
+
|
|
4
|
+
Integrates [HTML5 history state tracking](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history)
|
|
5
|
+
with [`bootstrap/tab.js`](http://getbootstrap.com/javascript/#tabs). This enables users to use `history.forward`,
|
|
6
|
+
`history.back` and `location.reload` when navigating between tabs, as well as bookmarking specific tabs.
|
|
7
|
+
|
|
8
|
+
To enable tracking on a tab element, simply set the `data-tab-history` attribute to `true` (or a string denoting a tab
|
|
9
|
+
grouping).
|
|
10
|
+
|
|
11
|
+
Installation
|
|
12
|
+
------------
|
|
13
|
+
|
|
14
|
+
### With Rails >= 3.1
|
|
15
|
+
|
|
16
|
+
Add `bootstrap-tab-history-rails` to the Gemfile:
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
gem 'bootstrap-tab-history-rails'
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
and then add the following line to `app/assets/javascripts/application.js`:
|
|
23
|
+
|
|
24
|
+
```javascript
|
|
25
|
+
//= require bootstrap-tab-history
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Without Rails
|
|
29
|
+
|
|
30
|
+
Add [`bootstrap-tab-history.js`](vendor/assets/javascripts/bootstrap-tab-history.js) to your JavaScripts.
|
|
31
|
+
|
|
32
|
+
Configuration
|
|
33
|
+
-------------
|
|
34
|
+
|
|
35
|
+
### Element options
|
|
36
|
+
|
|
37
|
+
Individual elements are configured by setting the following data attributes:
|
|
38
|
+
|
|
39
|
+
* `data-tab-history` - Required. Set to `true` to enable tracking on a tab. Can also be set to an arbitrary string
|
|
40
|
+
value to support pages with multiple tab groups.
|
|
41
|
+
* `data-tab-history-changer`
|
|
42
|
+
* 'push' - Use [`history.pushState`](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history#The_pushState%28%29.C2.A0method)
|
|
43
|
+
to update `history.state`. This will allow the use of `history.forward` and `history.back` as users switch
|
|
44
|
+
tabs.
|
|
45
|
+
* 'replace' - Use [`history.replaceState`](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history#The_replaceState%28%29.C2.A0method)
|
|
46
|
+
to update `history.state`. This will leave users on the same page w.r.t. `history.forward` and `history.back` as
|
|
47
|
+
they switch tabs.
|
|
48
|
+
* `data-tab-history-update-url` - If `true`, update the URL in the calls to `history.pushState` and
|
|
49
|
+
`history.replaceState`. When `false`, `null` is passed as the third parameter to these calls.
|
|
50
|
+
|
|
51
|
+
### Global options
|
|
52
|
+
|
|
53
|
+
```javascript
|
|
54
|
+
BootstrapTabHistory.options = {
|
|
55
|
+
// Default value corresponding to the `data-tab-history-changer` attribute.
|
|
56
|
+
defaultChanger: 'replace',
|
|
57
|
+
|
|
58
|
+
// Default value corresponding to the `data-tab-history-update-url` attribute.
|
|
59
|
+
defaultUpdateURL: false,
|
|
60
|
+
|
|
61
|
+
// Should the anchor portion of the loaded URI be used to activate a single tab if no history was
|
|
62
|
+
// present on page load.
|
|
63
|
+
showTabsBasedOnAnchor: true,
|
|
64
|
+
|
|
65
|
+
// When the anchor portion of the URI is used to activate a tab, prevent the browser from
|
|
66
|
+
// scrolling down to the element with the given `id` attribute. Only relevant if
|
|
67
|
+
// showTabsBasedOnAnchor is true.
|
|
68
|
+
showTabsBasedOnAnchorPreventScroll: true
|
|
69
|
+
};
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
An extremely simple example can be found at [`data/example.html`](data/example.html), with the relevant portion
|
|
75
|
+
duplicated below.
|
|
76
|
+
|
|
77
|
+
```html
|
|
78
|
+
<ul class="nav nav-tabs">
|
|
79
|
+
<li class="active">
|
|
80
|
+
<a href="#1-1"
|
|
81
|
+
data-toggle="tab"
|
|
82
|
+
data-tab-history="true"
|
|
83
|
+
data-tab-history-changer="push"
|
|
84
|
+
data-tab-history-update-url="true">
|
|
85
|
+
Tab 1:1
|
|
86
|
+
</a>
|
|
87
|
+
</li>
|
|
88
|
+
<li>
|
|
89
|
+
<a href="#1-2"
|
|
90
|
+
data-toggle="tab"
|
|
91
|
+
data-tab-history="true"
|
|
92
|
+
data-tab-history-changer="push"
|
|
93
|
+
data-tab-history-update-url="true">
|
|
94
|
+
Tab 1:2
|
|
95
|
+
</a>
|
|
96
|
+
</li>
|
|
97
|
+
</ul>
|
|
98
|
+
<div class="tab-content">
|
|
99
|
+
<div class="tab-pane active" id="1-1">
|
|
100
|
+
Sample content for Tab 1:1.
|
|
101
|
+
</div>
|
|
102
|
+
<div class="tab-pane" id="1-2">
|
|
103
|
+
Sample content for Tab 1:2.
|
|
104
|
+
</div>
|
|
105
|
+
</div>
|
|
106
|
+
```
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
/* ==========================================================================
|
|
2
|
+
* bootstrap-tab-history.js
|
|
3
|
+
* Author: Michael Narayan <mnarayan01@gmail.com>
|
|
4
|
+
* Repository: https://github.com/mnarayan01/bootstrap-tab-history/
|
|
5
|
+
* ==========================================================================
|
|
6
|
+
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
7
|
+
* not use this file except in compliance with the License. You may obtain a
|
|
8
|
+
* copy of the License at
|
|
9
|
+
*
|
|
10
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
*
|
|
12
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
14
|
+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
15
|
+
* License for the specific language governing permissions and limitations
|
|
16
|
+
* under the License.
|
|
17
|
+
* ========================================================================== */
|
|
18
|
+
|
|
19
|
+
/* ========================================================================== */
|
|
20
|
+
/* JSHint directives */
|
|
21
|
+
/* */
|
|
22
|
+
/* global BootstrapTabHistory: true */
|
|
23
|
+
/* */
|
|
24
|
+
/* global document */
|
|
25
|
+
/* global jQuery */
|
|
26
|
+
/* global history */
|
|
27
|
+
/* global window */
|
|
28
|
+
/* ========================================================================== */
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Integrate [HTML5 history state tracking](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Manipulating_the_browser_history)
|
|
32
|
+
* with [`bootstrap/tab.js`](http://getbootstrap.com/javascript/#tabs). To enable tracking on a tab element, simply set
|
|
33
|
+
* the `data-tab-history` attribute to true (or a string denoting a tab grouping).
|
|
34
|
+
*
|
|
35
|
+
* See the README for additional information.
|
|
36
|
+
*
|
|
37
|
+
* Functionality based upon bootstrap/tab.js v3.1.0; reference it when making any changes.
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
BootstrapTabHistory = {
|
|
41
|
+
options: {
|
|
42
|
+
/**
|
|
43
|
+
* Either 'push' or 'replace', for whether to use `history.pushState` or `history.replaceState`, resp.
|
|
44
|
+
*
|
|
45
|
+
* May be overriden on a per-element basis by the attribute `data-tab-history-changer`.
|
|
46
|
+
*
|
|
47
|
+
* @public
|
|
48
|
+
* @type {string}
|
|
49
|
+
*/
|
|
50
|
+
defaultChanger: 'replace',
|
|
51
|
+
/**
|
|
52
|
+
* If true, update the URL in onShownTab in the calls to `history.pushState` and `history.replaceState`. Otherwise,
|
|
53
|
+
* `null` is passed as the third parameter to these calls.
|
|
54
|
+
*
|
|
55
|
+
* May be overriden on a per-element basis by the attribute `data-tab-history-update-url`.
|
|
56
|
+
*
|
|
57
|
+
* @public
|
|
58
|
+
* @type {boolean}
|
|
59
|
+
*/
|
|
60
|
+
defaultUpdateURL: false,
|
|
61
|
+
/**
|
|
62
|
+
* Should the anchor portion of the loaded URI be used to activate a single tab if no history was present on page
|
|
63
|
+
* load.
|
|
64
|
+
*
|
|
65
|
+
* @public
|
|
66
|
+
* @type {boolean}
|
|
67
|
+
*/
|
|
68
|
+
showTabsBasedOnAnchor: true,
|
|
69
|
+
/**
|
|
70
|
+
* When the anchor portion of the URI is used to activate a tab, prevent the browser from scrolling down to the
|
|
71
|
+
* element with the given `id` attribute. Only relevant if showTabsBasedOnAnchor is true.
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
* @type {boolean}
|
|
75
|
+
*/
|
|
76
|
+
showTabsBasedOnAnchorPreventScroll: true
|
|
77
|
+
}
|
|
78
|
+
};
|
|
79
|
+
|
|
80
|
+
(function () {
|
|
81
|
+
'use strict';
|
|
82
|
+
|
|
83
|
+
jQuery(function () {
|
|
84
|
+
if(history && history.pushState && history.replaceState) {
|
|
85
|
+
var bootstrapTabHistory = history.state && history.state.bootstrapTabHistory;
|
|
86
|
+
|
|
87
|
+
if(bootstrapTabHistory) {
|
|
88
|
+
showTabsBasedOnState(bootstrapTabHistory);
|
|
89
|
+
} else {
|
|
90
|
+
showTabsBasedOnAnchor();
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
backfillHistoryState();
|
|
94
|
+
|
|
95
|
+
jQuery('[data-tab-history]').on('shown.bs.tab', onShownTab);
|
|
96
|
+
jQuery(window).on('popstate', onPopState);
|
|
97
|
+
} else {
|
|
98
|
+
showTabsBasedOnAnchor();
|
|
99
|
+
}
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Used to prevent onShownTab from registering shown events that we triggered via showTabsBasedOnState.
|
|
104
|
+
*
|
|
105
|
+
* @type {boolean}
|
|
106
|
+
*/
|
|
107
|
+
var showingTabsBasedOnState = false;
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Used to update `history.state` to reflect the default active tabs on initial page load. This supports proper
|
|
111
|
+
* `history.back` handling when `data-tab-history-update-url` is true.
|
|
112
|
+
*/
|
|
113
|
+
function backfillHistoryState() {
|
|
114
|
+
var newState = null;
|
|
115
|
+
|
|
116
|
+
jQuery('li.active > [data-tab-history]').each(function () {
|
|
117
|
+
var $activeTabElement = jQuery(this);
|
|
118
|
+
var selector = getTabSelector($activeTabElement);
|
|
119
|
+
|
|
120
|
+
if(selector) {
|
|
121
|
+
var tabGroup = getTabGroup($activeTabElement);
|
|
122
|
+
|
|
123
|
+
if(tabGroup) {
|
|
124
|
+
newState = createNewHistoryState(newState || history.state, tabGroup, selector);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
if(newState) {
|
|
130
|
+
history.replaceState(newState, '', null);
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/**
|
|
135
|
+
* Clone the existing state, ensure its bootstrapTabHistory attribute is an Object, and add the provided tabGroup to
|
|
136
|
+
* said bootstrapTabHistory attribute.
|
|
137
|
+
*
|
|
138
|
+
* @param {?object} existingState
|
|
139
|
+
* @param {!string} tabGroup
|
|
140
|
+
* @param {!string} selector
|
|
141
|
+
* @returns {!object}
|
|
142
|
+
*/
|
|
143
|
+
function createNewHistoryState(existingState, tabGroup, selector) {
|
|
144
|
+
// Clone history.state and ensure it has a bootstrapTabHistory entry.
|
|
145
|
+
var newState = jQuery.extend(true, {}, existingState, {
|
|
146
|
+
bootstrapTabHistory: {}
|
|
147
|
+
});
|
|
148
|
+
|
|
149
|
+
newState.bootstrapTabHistory[tabGroup] = selector;
|
|
150
|
+
|
|
151
|
+
return newState;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* @param {jQuery} $tab
|
|
156
|
+
* @returns {?string}
|
|
157
|
+
*/
|
|
158
|
+
function getTabGroup($tab) {
|
|
159
|
+
var rawTabGroup = $tab.data('tab-history');
|
|
160
|
+
|
|
161
|
+
if(rawTabGroup === true || rawTabGroup === '') {
|
|
162
|
+
return 'true';
|
|
163
|
+
} else {
|
|
164
|
+
return rawTabGroup || null;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* @param {jQuery} $tab
|
|
170
|
+
* @returns {?string}
|
|
171
|
+
*/
|
|
172
|
+
function getTabSelector($tab) {
|
|
173
|
+
return $tab.data('target') || $tab.attr('href');
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* Receives the `shown.bs.tab` event. Updates `history.state` as appropriate.
|
|
178
|
+
*
|
|
179
|
+
* @param {jQuery.Event} shownEvt
|
|
180
|
+
*/
|
|
181
|
+
function onShownTab(shownEvt) {
|
|
182
|
+
if(!showingTabsBasedOnState) {
|
|
183
|
+
var $activatedTab = jQuery(shownEvt.currentTarget);
|
|
184
|
+
var selector = getTabSelector($activatedTab);
|
|
185
|
+
|
|
186
|
+
if(selector) {
|
|
187
|
+
var tabGroup = getTabGroup($activatedTab);
|
|
188
|
+
|
|
189
|
+
if(tabGroup) {
|
|
190
|
+
var historyChanger = $activatedTab.data('tab-history-changer') || BootstrapTabHistory.options.defaultChanger;
|
|
191
|
+
var newState = createNewHistoryState(history.state, tabGroup, selector);
|
|
192
|
+
var updateURL = (function ($activatedTab) {
|
|
193
|
+
if(selector[0] === '#') {
|
|
194
|
+
var elementUpdateURLOption = $activatedTab.data('tab-history-update-url');
|
|
195
|
+
|
|
196
|
+
if(elementUpdateURLOption === undefined) {
|
|
197
|
+
return BootstrapTabHistory.options.defaultUpdateURL;
|
|
198
|
+
} else {
|
|
199
|
+
return elementUpdateURLOption;
|
|
200
|
+
}
|
|
201
|
+
} else {
|
|
202
|
+
return false;
|
|
203
|
+
}
|
|
204
|
+
})($activatedTab);
|
|
205
|
+
|
|
206
|
+
switch(historyChanger) {
|
|
207
|
+
case 'push':
|
|
208
|
+
history.pushState(newState, '', updateURL ? selector : null);
|
|
209
|
+
break;
|
|
210
|
+
case 'replace':
|
|
211
|
+
history.replaceState(newState, '', updateURL ? selector : null);
|
|
212
|
+
break;
|
|
213
|
+
default:
|
|
214
|
+
throw new Error('Unknown tab-history-changer: ' + historyChanger);
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Receives the `popstate` event. Shows tabs based on the value of `history.state` as appropriate.
|
|
223
|
+
*/
|
|
224
|
+
function onPopState() {
|
|
225
|
+
var bootstrapTabHistory = history.state && history.state.bootstrapTabHistory;
|
|
226
|
+
|
|
227
|
+
if(bootstrapTabHistory) {
|
|
228
|
+
showTabsBasedOnState(bootstrapTabHistory);
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* Show tabs based upon the anchor component of `window.location`.
|
|
234
|
+
*/
|
|
235
|
+
function showTabsBasedOnAnchor() {
|
|
236
|
+
if(BootstrapTabHistory.options.showTabsBasedOnAnchor) {
|
|
237
|
+
var anchor = window.location && window.location.hash;
|
|
238
|
+
|
|
239
|
+
if(anchor) {
|
|
240
|
+
var tabShownForAnchor = showTabForSelector(anchor);
|
|
241
|
+
|
|
242
|
+
// HACK: This prevents scrolling to the tab on page load. This relies on the fact that we should never get here
|
|
243
|
+
// on `history.forward`, `history.back`, or `location.reload`, since in all those situations the
|
|
244
|
+
// `history.state` object should have been used (unless the browser did not support the modern History API).
|
|
245
|
+
if(tabShownForAnchor && BootstrapTabHistory.options.showTabsBasedOnAnchorPreventScroll && window.addEventListener && window.removeEventListener) {
|
|
246
|
+
var scrollListener = function resetAnchorScroll () {
|
|
247
|
+
window.removeEventListener('scroll', scrollListener);
|
|
248
|
+
window.scrollTo(0, 0);
|
|
249
|
+
};
|
|
250
|
+
|
|
251
|
+
window.addEventListener('scroll', scrollListener);
|
|
252
|
+
window.setTimeout(function () { window.removeEventListener('scroll', scrollListener); }, 1000);
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Show a tab which corresponds to the provided selector.
|
|
260
|
+
*
|
|
261
|
+
* @param {string} selector - A CSS selector.
|
|
262
|
+
* @returns {boolean} - true iff a tab was found to show (even if said tab was already active).
|
|
263
|
+
*/
|
|
264
|
+
function showTabForSelector(selector) {
|
|
265
|
+
var tabElement = document.querySelector('[data-target="' + selector + '"]') || document.querySelector('[href="' + selector + '"]');
|
|
266
|
+
|
|
267
|
+
if(tabElement) {
|
|
268
|
+
jQuery(tabElement).tab('show');
|
|
269
|
+
|
|
270
|
+
return true;
|
|
271
|
+
} else {
|
|
272
|
+
return false;
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* Iterate through the provided set of tab tab groups, showing the tabs based on the stored selectors.
|
|
278
|
+
*
|
|
279
|
+
* @param {object} bootstrapTabHistory - Each of the values is passed to showTabForSelector; the keys are actually irrelevant.
|
|
280
|
+
*/
|
|
281
|
+
function showTabsBasedOnState(bootstrapTabHistory) {
|
|
282
|
+
showingTabsBasedOnState = true;
|
|
283
|
+
|
|
284
|
+
try {
|
|
285
|
+
for(var k in bootstrapTabHistory) {
|
|
286
|
+
if(bootstrapTabHistory.hasOwnProperty(k)) {
|
|
287
|
+
showTabForSelector(bootstrapTabHistory[k]);
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
} finally {
|
|
291
|
+
showingTabsBasedOnState = false;
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
})();
|
metadata
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: bootstrap-tab-history-rails
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Michael Narayan
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2014-02-10 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: railties
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - '>='
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '3.1'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - '>='
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '3.1'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: bundler
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - '>='
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '0'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - '>='
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '0'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: rake
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - '>='
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '0'
|
|
48
|
+
type: :development
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - '>='
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '0'
|
|
55
|
+
description: Use the HTML5 History API with bootstrap/tab.
|
|
56
|
+
email:
|
|
57
|
+
- mnarayan01@gmail.com
|
|
58
|
+
executables: []
|
|
59
|
+
extensions: []
|
|
60
|
+
extra_rdoc_files: []
|
|
61
|
+
files:
|
|
62
|
+
- lib/bootstrap-tab-history-rails/rails/engine.rb
|
|
63
|
+
- lib/bootstrap-tab-history-rails/version.rb
|
|
64
|
+
- lib/bootstrap-tab-history-rails.rb
|
|
65
|
+
- vendor/assets/javascripts/bootstrap-tab-history.js
|
|
66
|
+
- LICENSE
|
|
67
|
+
- README.md
|
|
68
|
+
homepage: https://github.com/mnarayan01/bootstrap-tab-history
|
|
69
|
+
licenses: []
|
|
70
|
+
metadata: {}
|
|
71
|
+
post_install_message:
|
|
72
|
+
rdoc_options: []
|
|
73
|
+
require_paths:
|
|
74
|
+
- lib
|
|
75
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
76
|
+
requirements:
|
|
77
|
+
- - '>='
|
|
78
|
+
- !ruby/object:Gem::Version
|
|
79
|
+
version: '0'
|
|
80
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
|
+
requirements:
|
|
82
|
+
- - '>='
|
|
83
|
+
- !ruby/object:Gem::Version
|
|
84
|
+
version: '0'
|
|
85
|
+
requirements: []
|
|
86
|
+
rubyforge_project:
|
|
87
|
+
rubygems_version: 2.0.3
|
|
88
|
+
signing_key:
|
|
89
|
+
specification_version: 4
|
|
90
|
+
summary: Use the HTML5 History API with bootstrap/tab.
|
|
91
|
+
test_files: []
|