-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
289 lines (275 loc) · 12.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7" lang=""> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8" lang=""> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9" lang=""> <![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>floativ.js</title>
<meta name="description" content="">
<meta name="keywords" content="HTML,CSS,XML,JavaScript">
<meta name="author" content="Hege Refsnes">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="apple-touch-icon" href="img/apple-touch-icon.png">
<!-- Normalize css -->
<link rel="stylesheet" href="css/normalize.min.css">
<!-- FontAwesome -->
<link rel="stylesheet" href="node_modules/font-awesome/css/font-awesome.min.css">
<!-- jQuery mCustomScrollbar -->
<link rel="stylesheet" href="node_modules/malihu-custom-scrollbar-plugin/jquery.mCustomScrollbar.css">
<!-- prism -->
<link rel="stylesheet" href="css/prism.css">
<!-- floativ css -->
<link rel="stylesheet" href="css/floativ.css">
<!-- website css -->
<link rel="stylesheet" href="css/styles.css">
<!-- Modernizr js -->
<script src="js/vendor/modernizr-2.8.3-respond-1.4.2.min.js"></script>
<!--[if IE]>
<script src="https://cdn.jsdelivr.net/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://cdn.jsdelivr.net/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<!-- Header -->
<div class="header-container">
<header class="wrapper clearfix">
<h1 class="title">floativ.js<br><span>The awesome responsive floating scroll-box.</span></h1>
<h2>
Contribute on GitHub<br>
<a href="https://github.com/GBratsos/floativ"><i class="fa fa-github fa-2x"></i></a>
</h2>
</header>
</div>
<!-- Main -->
<main role="main">
<div class="main-container">
<div class="main wrapper clearfix">
<section>
<article>
<p>floativ is a responsive floating scroll-box at the bottom of the screen of your site that contains text, among other things, which can be displayed while browsing a web page. This floating scroll-box disappears when the user reaches an element with a specific id.</p>
</article>
<article>
<header>
<h2>Installation</h2>
<hr>
</header>
<ol>
<li>Download and install <a href="https://nodejs.org/" target="_blank">NodeJS</a>.
</li>
<li>Clone or Download project straight from <a href="https://github.com/GBratsos/floativ">GitHub</a>.</li>
<li>Extract the zip file and start working.</li>
</ol>
</article>
<article>
<header>
<h2>Directions</h2>
<hr>
</header>
<ul>
<li>
cd into the directory and run <span>npm install</span> in order to install all the project dependencies.
</li>
<li>Open index.html to see and start working with this project.</li>
</ul>
</article>
<article>
<header>
<h2>NPM Package</h2>
<hr>
</header>
<p>You can find and install floativ from npm <a href="https://www.npmjs.com/package/floativ" target="_blank">here</a>.</p>
</article>
<article>
<header>
<h2>Usage</h2>
<hr>
</header>
<p>Put this <span>$("#floativ").floativ();</span> inside <span>script tags</span> at the bottom of your HTML file.</p>
<p>You can also specify parameters, such as:</p>
<ul>
<li><span>breakPoint</span>: the class where we hide the floating box</li>
<li><span>height</span>: the starting height of the box</li>
<li><span>width</span>: the starting width of the box</li>
<li><span>offsetPercentage</span>: specifies extra offset to where we hide the floating box</li>
<li><span>heightExpand</span>: the expand height</li>
<li><span>widthExpand</span>: the expand width</li>
<li><span>animate</span>: the expand-collapse animation</li>
<li><span>customClass</span>: add extra classes to parent element</li>
<li><span>scrollbar</span>: see <a href="https://github.com/malihu/malihu-custom-scrollbar-plugin" target="_blank">mCustomScrollbar</a> for more information</li>
</ul>
<p>The floating box requires the following html markup in order to work</p>
<pre>
<code class="language-markup">
<div class="floativ" id="floativ">
<div class="floativ-container">
<div class="floativ-head">
<span>
<i class="fa fa-plus-circle floativ-expand" aria-hidden="true" aria-label="Expand"></i>
</span>
<span>
<i class="fa fa-minus-circle floativ-collapse" aria-hidden="true" aria-label="Collapse"></i>
</span>
</div>
<div class="floativ-wrapper">
<div class="floativ-body">
... YOUR CONTENT HERE ...
</div>
</div>
</div>
</div>
</code>
</pre>
</article>
<article>
<header>
<h2>Dependencies</h2>
<hr>
</header>
<ul>
<li><a href="https://github.com/jquery/jquery" target="_blank">jQuery</a></li>
<li><a href="https://github.com/malihu/malihu-custom-scrollbar-plugin" target="_blank">mCustomScrollbar</a></li>
<li><a href="https://github.com/FortAwesome/Font-Awesome" target="_blank">FontAwesome</a></li>
</ul>
</article>
<article id="floativ-break">
<header>
<h2>Library compatibility</h2>
<hr>
</header>
<p>This library works for IE8+, Mozilla Firefox 4+, Google Chrome 11+, Opera 10+, Safari 4+.</p>
</article>
</section>
</div>
</div>
</main>
<!-- Footer -->
<footer>
<div class="footer-container">
<div class="wrapper">
<aside>
<article>
<h1>Collaborators</h1>
<ul>
<li><a href="https://github.com/gbratsos">George Bratsos</a>
</li>
<li><a href="https://github.com/hennett">Panagiotis Papadatis</a>
</li>
<li><a href="https://gr.linkedin.com/pub/paraskevi-zygoura/b4/434/a22">Paraskevi Zygoura</a>
</li>
</ul>
</article>
</aside>
<aside>
<article>
<h1>Contributors</h1>
<p>
<a href="https://github.com/georapbox">George Raptis</a>
</p>
</article>
</aside>
<aside>
<article>
<header>
<h1>License</h1>
</header>
<p><a href="https://github.com/GBratsos/floativ/blob/master/LICENSE">GPL-3.0</a>
</p>
</article>
</aside>
</div>
</div>
</footer>
<!-- Floativ Section -->
<div class="floativ" id="floativ">
<div class="floativ-container">
<div class="floativ-head">
<span>
<i class="fa fa-plus-circle floativ-expand" aria-hidden="true" aria-label="Expand"></i>
</span>
<span>
<i class="fa fa-minus-circle floativ-collapse" aria-hidden="true" aria-label="Collapse"></i>
</span>
</div>
<div class="floativ-wrapper">
<div class="floativ-body">
<footer>
<div class="footer-container">
<div class="wrapper">
<aside>
<article>
<h1>Collaborators</h1>
<ul>
<li><a href="https://github.com/gbratsos">George Bratsos</a>
</li>
<li><a href="https://github.com/hennett">Panagiotis Papadatis</a>
</li>
<li><a href="https://gr.linkedin.com/pub/paraskevi-zygoura/b4/434/a22">Paraskevi Zygoura</a>
</li>
</ul>
</article>
</aside>
<aside>
<article>
<h1>Contributors</h1>
<p>
<a href="https://github.com/georapbox">George Raptis</a>
</p>
</article>
</aside>
<aside>
<article>
<header>
<h1>License</h1>
</header>
<p><a href="https://github.com/GBratsos/floativ/blob/master/LICENSE">GPL-3.0</a>
</p>
</article>
</aside>
</div>
</div>
</footer>
</div>
</div>
</div>
</div>
<!-- jQuery -->
<script src="node_modules/jquery/dist/jquery.min.js"></script>
<!-- jQuery mCustomScrollbar -->
<script src="node_modules/malihu-custom-scrollbar-plugin/jquery.mCustomScrollbar.js"></script>
<!-- prism.js -->
<script src="js/vendor/prism.js"></script>
<!-- floativ.js -->
<script src="js/floativ.js"></script>
<script>
$("#floativ").floativ({
heightExpand: "93px",
customClass: "shadow center-floativ",
scrollbar: {
theme: "dark-3",
alwaysShowScrollbar: 1
}
});
</script>
<!-- Google Analytics: change UA-XXXXX-X to be your site's ID. -->
<script>
(function(b, o, i, l, e, r) {
b.GoogleAnalyticsObject = l;
b[l] || (b[l] =
function() {
(b[l].q = b[l].q || []).push(arguments)
});
b[l].l = +new Date;
e = o.createElement(i);
r = o.getElementsByTagName(i)[0];
e.src = '//www.google-analytics.com/analytics.js';
r.parentNode.insertBefore(e, r)
}(window, document, 'script', 'ga'));
ga('create', 'UA-XXXXX-X', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>