-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
index.html
185 lines (139 loc) · 5.67 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
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css"
integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
<title>dyScrollUpJS - Yusuf Shakeel</title>
<style>
body {
padding-top: 20px;
padding-bottom: 50px;
}
pre {
background: #eee;
border: 1px solid #ccc;
border-radius: 3px;
padding: 10px;
}
</style>
</head>
<body>
<div class="container">
<div class="row">
<div class="col-xs-12 col-sm-6 offset-sm-3 col-md-6 offset-md-3">
<div class="text-center">
<h1>dyScrollUpJS</h1>
<p>dyScrollUpJS is a small JavaScript plugin that you can use in your website and blog to create
"Scroll-to-top" button.</p>
</div>
<div class="text-center">
<a class="btn btn-outline-primary btn-lg"
href='https://github.com/yusufshakeel/dyScrollUpJS/releases'>Download</a>
<a class="btn btn-outline-primary btn-lg"
href='https://github.com/yusufshakeel/dyScrollUpJS'>GitHub</a>
</div>
<hr>
<div class="text-center">
<p>Created by: <a href='https://github.com/yusufshakeel'>Yusuf Shakeel</a></p>
<p><a href='https://www.youtube.com/watch?v=P7CvToMSfZA'>Click here</a> to watch the tutorial video.
</p>
<p><a href='https://www.dyclassroom.com/dyscrollupjs/documentation'>Click here</a> for the
documentation.</p>
</div>
<div class="text-center">
<h4>License</h4>
<p>It's free and released under <a
href="https://github.com/yusufshakeel/dyScrollUpJS/blob/master/LICENSE">MIT License</a>
Copyright (c) 2016 <a href="https://github.com/yusufshakeel">Yusuf Shakeel</a></p>
</div>
<hr>
</div>
</div><!--/ .row -->
<div class="row">
<div class="col-xs-12 col-sm-6 offset-sm-3 col-md-6 offset-md-3">
<h3 class="text-center">Getting Started</h3>
<p>Include the JavaScript file in your page.</p>
<p>Call the <code>init()</code> method of dyScrollUpJS to create the scroll-to-top button.</p>
<pre>dyscrollup.init();</pre>
<hr>
<h3 class="text-center">Configure</h3>
<p>Pass the following to configure.</p>
<pre>dyscrollup.init({
showafter: 600,
scrolldelay: 500,
position: 'right',
image: 'path/to/image/32.png',
shape: 'other',
width: 30,
height: 30
});</pre>
<p>Where,</p>
<p><code>showafter: integer</code></p>
<p>(optional) default: 300, show button after scolling X pixels down</p>
<p><code>scrolldelay: integer</code></p>
<p>(optional) default: 500, delay the scrolling up action in milliseconds</p>
<p><code>position: "string"</code></p>
<p>(optional) values: "left|right" default: "right"</p>
<p><code>image: "string"</code></p>
<p>(optional) values: "path of the image" default: ""</p>
<p><code>shape: "string"</code></p>
<p>(optional) values: "other|circle" default: "circle"</p>
<p><code>width: integer</code></p>
<p>(optional) default: 32</p>
<p><code>height: integer</code></p>
<p>(optional) default: 32</p>
</div>
</div><!--/ .row -->
<div class="row">
<div class="col-xs-12 col-sm-6 offset-sm-3 col-md-6 offset-md-3">
<hr>
<h4>Note!</h4>
<p>Version 2.x no jQuery required.</p>
<p>Version 1.x requires jQuery v1.12+</p>
</div>
</div><!--/ .row -->
<div class="row">
<div class="col-xs-12 col-sm-6 offset-sm-3 col-md-6 offset-md-3">
<hr>
<div class="text-center">
<h4>Donate</h4>
<p>Feeling generous ♥
<br>Buy me a cup of tea</p>
<p><a href="https://www.paypal.me/yusufshakeel">Donate via PayPal</a></p>
</div>
<hr>
<div class="text-center">
<p>Copyright © Yusuf Shakeel</p>
<p>MIT License</p>
</div>
</div>
</div>
</div>
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js"
integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN"
crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js"
integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q"
crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js"
integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl"
crossorigin="anonymous"></script>
<script src="dist/js/dyscrollup.min.js"></script>
<script>
dyscrollup.init({
showafter: 300,
scrolldelay: 300,
position: 'right',
image: 'dist/image/32.png',
shape: 'other',
width: 30,
height: 30
});
</script>
</body>
</html>