You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-23Lines changed: 24 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,39 +1,36 @@
1
1
# Responsive Bootstrap Toolkit
2
2
3
+
Responsive Bootstrap Toolkit provides an easy way of breakpoint detection in JavaScript, detecting changes in currently active breakpoint, as well as executing any breakpoint-specific JavaScript code. Despite the name, you can use it also with Foundation, or any other framework.
3
4
4
-
Responsive Bootstrap Toolkit provides an easy way of breakpoint detection in JavaScript, detecting changes in currently active breakpoint, as well as executing any breakpoint-specific JavaScript code.
5
+
Current version: **2.5.0**
5
6
6
-
The SASS module enables quick and simple styling for elements needing different property values for each screen resolution.
7
-
8
-
Current version: **2.4.2**
9
-
10
-
### Table of Contents
7
+
### Documentation
11
8
*[Installation](#installation)
12
-
*[Live example](#live-example)
9
+
*[Demo](#demo)
10
+
*[Basic usage](#basic-usage)
11
+
*[Execute code on window resize](#execute-code-on-window-resize)
12
+
*[Get alias of current breakpoint](#get-alias-of-current-breakpoint)
13
+
*[Using with Foundation](#using-with-foundation)
14
+
*[Providing your own visibility classes](#providing-your-own-visibility-classes)
15
+
16
+
### HOW-TO
17
+
*[How do I include it in my project?](#how-do-i-include-it-in-my-project)
13
18
*[Migrating from an older version](#migrating-from-an-older-version)
14
-
* JavaScript features
15
-
*[Basic usage](#basic-usage)
16
-
*[Execute code on window resize](#execute-code-on-window-resize)
17
-
*[Get alias of current breakpoint](#get-alias-of-current-breakpoint)
18
-
*[Using with Foundation](#using-with-foundation)
19
-
*[Providing your own visibility classes](#providing-your-own-visibility-classes)
20
-
*[How do I include it in my project?](#how-do-i-include-it-in-my-project)
Refer to the [changelog](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/blob/master/CHANGELOG.md) for a list of changes in each version of the library.
35
33
36
-
### JavaScript features
37
34
#### Basic usage:
38
35
39
36
````javascript
@@ -76,7 +73,7 @@ $(window).resize(
76
73
77
74
// ...
78
75
79
-
}, 600)
76
+
}, 150)
80
77
});
81
78
````
82
79
@@ -131,7 +128,7 @@ Currently, only Foundation 5 visibility classes are supported. If you'd like to
131
128
````
132
129
133
130
**Note**:
134
-
It's up to you to create media queries that will toggle div's visibility across different screen resolutions. How? Refer to this example.
131
+
It's up to you to create media queries that will toggle div's visibility across different screen resolutions. How? [Refer to this example](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/blob/master/demos/custom/style.css).
135
132
136
133
#### How do I include it in my project?
137
134
@@ -144,6 +141,10 @@ Paste just before `</body>`
144
141
<scriptsrc="js/main.js"></script>
145
142
````
146
143
144
+
### Migrating from an older version
145
+
146
+
Refer to the [changelog](https://github.com/maciej-gurban/responsive-bootstrap-toolkit/blob/master/CHANGELOG.md) for a list of changes in each version of the library.
147
+
147
148
#### Dependencies:
148
149
* jQuery
149
150
* Bootstrap's responsive utility css classes (included in its standard stylesheet package)
0 commit comments