-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathdocs.html
211 lines (204 loc) · 7.92 KB
/
docs.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
<!DOCTYPE html>
<html>
<head>
<base href="/puymodals/">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>Aditya's PUYMODALS</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="css/styles.css">
</head>
<body>
<nav class="navbar navbar-expand-lg navbar-light bg-light">
<div class="container">
<a class="navbar-brand" href="http://pateladitya.com">Aditya Patel</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarNav">
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" href="index.html">Home</a>
</li>
<li class="nav-item active">
<a class="nav-link" href="docs.html">Documentation <span class="sr-only">(current)</span></a>
</li>
</ul>
</div>
</div>
</nav>
<div class="container">
<div class="row">
<div class="col-sm-12 text-center">
<h1 class="text-primary">Documentation</h1>
<p class="puy-head"><strong>Example:</strong> puyModal({title:'Test Title',heading:'Heading',message:'<p>This is sample message.</p>'})</p>
</div>
</div>
<div class="row my-3">
<div class="col-sm-12">
<div class="card">
<div class="card-header">
<h5>General Attributes</h5>
</div>
<div class="card-body">
<table class="table">
<thead>
<tr>
<th scope="col">Parameter</th>
<th scope="col">Possible Values</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>Currently Supported: video and iframe. If not set defaults to general</td>
</tr>
<tr>
<td>title</td>
<td>Title of the Modal</td>
</tr>
<tr>
<td>heading</td>
<td>If defined, appears as a H2 tag in the modal body. This can include HTML.</td>
</tr>
<tr>
<td>message</td>
<td>Is placed in the body inside a paragraph tag. This can include HTML.</td>
</tr>
<tr>
<td>loadPage</td>
<td>Takes a document location and loads it in the body. When using this, heading and message attributes are ignored</td>
</tr>
<tr>
<td>showHeader</td>
<td>default to <span class="text-success">true</span>. Set value <span class="text-danger">false</span> to hide header</td>
</tr>
<tr>
<td>showFooter</td>
<td>default to <span class="text-danger">false</span>. Set value <span class="text-success">true</span> to show footer</td>
</tr>
<tr>
<td>icon</td>
<td>icons similar to fontawesome can be used. Possible Value: <span class="text-info">fab fa-js-square fa-3x</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="row my-3">
<div class="col-sm-12">
<div class="card">
<div class="card-header">
<h5>Sizing Parameters</h5>
</div>
<div class="card-body">
<p><strong>Any attribute not used will be ignored (unless stated as default).</strong></p>
<table class="table">
<thead>
<tr>
<th scope="col">Parameter</th>
<th scope="col">Possible Values</th>
</tr>
</thead>
<tbody>
<tr>
<td>width</td>
<td>width of the modal-dialog</td>
</tr>
<tr>
<td>maxWidth</td>
<td>max-width of modal-dialog</td>
</tr>
<tr>
<td>height</td>
<td>height of the modal-dialog</td>
</tr>
<tr>
<td>maxHeight</td>
<td>max-height of modal-dialog</td>
</tr>
<tr>
<td>overflowY</td>
<td>any type of overflow css value (e.g. 'scroll'). <span class="text-danger">Defaults to 'auto'</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="row my-3">
<div class="col-sm-12">
<div class="card">
<div class="card-header">
<h5>Video Popups</h5>
</div>
<div class="card-body">
<p class="text-danger"><strong>Both these parameters are required</strong></p>
<table class="table">
<thead>
<tr>
<th scope="col">Parameter</th>
<th scope="col">Possible Values</th>
</tr>
</thead>
<tbody>
<tr>
<td>videoSource</td>
<td>local, youtube, vimeo</td>
</tr>
<tr>
<td>embedTag</td>
<td>File path (e.g. '/video/example.mp4') or Youtube's/Vimeo's video ID (e.g. 'YE7VzlLtp-4' for Youtube or '1084537' for vimeo)</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="row my-3">
<div class="col-sm-12">
<div class="card">
<div class="card-header">
<h5>Video Popups using class .puyVideo and element attributes</h5>
</div>
<div class="card-body">
<p class="text-danger"><strong>data-videoSource and data-href/href parameters are required</strong></p>
<table class="table">
<thead>
<tr>
<th scope="col">Parameter</th>
<th scope="col">Possible Values</th>
</tr>
</thead>
<tbody>
<tr>
<td>data-videoSource</td>
<td>local, youtube, vimeo</td>
</tr>
<tr>
<td>data-href/href</td>
<td>File path (e.g. '/video/example.mp4') or Youtube's/Vimeo's video ID (e.g. 'YE7VzlLtp-4' for Youtube or '1084537' for vimeo)</td>
</tr>
<tr>
<td>title</td>
<td>Title of the popup</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<script src="http://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" 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="js/puymodals.js" charset="utf-8"></script>
</body>
</html>