forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jquery.colorbox.d.ts
303 lines (293 loc) · 9.69 KB
/
jquery.colorbox.d.ts
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
// Type definitions for jQuery.Colorbox 1.4.15
// Project: http://www.jacklmoore.com/colorbox/
// Definitions by: Gidon Junge <https://github.com/gjunge>
// Definitions: https://github.com/borisyankov/DefinitelyTyped/
/// <reference path="../jquery/jquery.d.ts" />
interface ColorboxResizeSettings {
height?: number;
innerHeight?: number;
width?: number;
innerWidth?: number;
}
interface ColorboxSettings {
/**
* The transition type. Can be set to "elastic", "fade", or "none".
*/
transition?: string;
/**
* Sets the speed of the fade and elastic transitions, in milliseconds.
*/
speed?: number;
/**
* This can be used as an alternative anchor URL or to associate a URL for non-anchor elements such as images or form buttons.
*/
href?: any;
/**
* This can be used as an anchor title alternative for Colorbox.
*/
title?: any;
/**
* This can be used as an anchor rel alternative for Colorbox.
*/
rel?: any;
/**
* If true, and if maxWidth, maxHeight, innerWidth, innerHeight, width, or height have been defined, Colorbox will scale photos to fit within the those values.
*/
scalePhotos?: boolean;
/**
* If false, Colorbox will hide scrollbars for overflowing content.
*/
scrolling?: boolean;
/**
* The overlay opacity level. Range: 0 to 1.
*/
opacity?: number;
/**
* If true, Colorbox will immediately open.
*/
open?: boolean;
/**
* If true, focus will be returned when Colorbox exits to the element it was launched from.
*/
returnFocus?: boolean;
/**
* If false, the loading graphic removal and onComplete event will be delayed until iframe's content has completely loaded.
*/
fastIframe?: boolean;
/**
* Allows for preloading of 'Next' and 'Previous' content in a group, after the current content has finished loading. Set to false to disable.
*/
preloading?: boolean;
/**
* If false, disables closing Colorbox by clicking on the background overlay.
*/
overlayClose?: boolean;
/**
* If false, will disable closing colorbox on 'esc' key press.
*/
escKey?: boolean;
/**
* If false, will disable the left and right arrow keys from navigating between the items in a group.
*/
arrowKey?: boolean;
/**
* If false, will disable the ability to loop back to the beginning of the group when on the last element.
*/
loop?: boolean;
/**
* For submitting GET or POST values through an ajax request. The data property will act exactly like jQuery's .load() data argument, as Colorbox uses .load() for ajax handling.
*/
data?: any;
/**
* Adds a given class to colorbox and the overlay.
*/
className?: any;
/**
* Sets the fadeOut speed, in milliseconds, when closing Colorbox.
*/
fadeOut?: number;
/**
* Text or HTML for the group counter while viewing a group. {current} and {total} are detected and replaced with actual numbers while Colorbox runs.
*/
current?: string;
/**
* Text or HTML for the previous button while viewing a group.
*/
previous?: string;
/**
* Text or HTML for the next button while viewing a group.
*/
next?: string;
/**
* Text or HTML for the close button. The 'esc' key will also close Colorbox.
*/
close?: string;
/**
* Set to false to remove the close button.
*/
closeButton?: boolean;
/**
* Error message given when ajax content for a given URL cannot be loaded.
*/
xhrError?: string;
/**
* Error message given when a link to an image fails to load.
*/
imgError?: string;
/**
* If true, specifies that content should be displayed in an iFrame.
*/
iframe?: boolean;
/**
* If true, content from the current document can be displayed by passing the href property a jQuery selector, or jQuery object.
*/
inline?: boolean;
/**
* For displaying a string of HTML or text: $.colorbox({html:"<p>Hello</p>"});
*/
html?: any;
/**
* If true, this setting forces Colorbox to display a link as a photo. Use this when automatic photo detection fails (such as using a url like 'photo.php' instead of 'photo.jpg')
*/
photo?: boolean;
/**
* This property isn't actually used as Colorbox assumes all hrefs should be treated as either ajax or photos, unless one of the other content types were specified.
*/
ajax?: any;
/**
* Set a fixed total width. This includes borders and buttons. Example: "100%", "500px", or 500
*/
width?: any;
/**
* Set a fixed total height. This includes borders and buttons. Example: "100%", "500px", or 500
*/
height?: any;
/**
* This is an alternative to 'width' used to set a fixed inner width. This excludes borders and buttons. Example: "50%", "500px", or 500
*/
innerWidth?: any;
/**
* This is an alternative to 'height' used to set a fixed inner height. This excludes borders and buttons. Example: "50%", "500px", or 500
*/
innerHeight?: any;
/**
* Set the initial width, prior to any content being loaded.
*/
initialWidth?: number;
/**
* Set the initial height, prior to any content being loaded.
*/
initialHeight?: number;
/**
* Set a maximum width for loaded content. Example: "100%", 500, "500px"
*/
maxWidth?: any;
/**
* Set a maximum height for loaded content. Example: "100%", 500, "500px"
*/
maxHeight?: any;
/**
* If true, adds an automatic slideshow to a content group / gallery.
*/
slideshow?: boolean;
/**
* Sets the speed of the slideshow, in milliseconds.
*/
slideshowSpeed?: number;
/**
* If true, the slideshow will automatically start to play.
*/
slideshowAuto?: boolean;
/**
* Text for the slideshow start button.
*/
slideshowStart?: string;
/**
* Text for the slideshow stop button
*/
slideshowStop?: string;
/**
* If true, Colorbox will be displayed in a fixed position within the visitor's viewport. This is unlike the default absolute positioning relative to the document.
*/
fixed?: boolean;
/**
* Accepts a pixel or percent value (50, "50px", "10%"). Controls Colorbox's vertical positioning instead of using the default position of being centered in the viewport.
*/
top?: any;
/**
* Accepts a pixel or percent value (50, "50px", "10%"). Controls Colorbox's vertical positioning instead of using the default position of being centered in the viewport.
*/
bottom?: any;
/**
* Accepts a pixel or percent value (50, "50px", "10%"). Controls Colorbox's horizontal positioning instead of using the default position of being centered in the viewport.
*/
left?: any;
/**
* Accepts a pixel or percent value (50, "50px", "10%"). Controls Colorbox's horizontal positioning instead of using the default position of being centered in the viewport.
*/
right?: any;
/**
* Repositions Colorbox if the window's resize event is fired.
*/
reposition?: boolean;
/**
* If true, Colorbox will scale down the current photo to match the screen's pixel ratio
*/
retinaImage?: boolean;
/**
* If true and the device has a high resolution display, Colorbox will replace the current photo's file extention with the retinaSuffix+extension
*/
retinaUrl?: boolean;
/**
* If retinaUrl is true and the device has a high resolution display, the href value will have it's extention extended with this suffix. For example, the default value would change `my-photo.jpg` to `[email protected]`
*/
retinaSuffix?: string;
/**
* Callback that fires right before Colorbox begins to open.
*/
onOpen?: any;
/**
* Callback that fires right before attempting to load the target content.
*/
onLoad?: any;
/**
* Callback that fires right after loaded content is displayed.
*/
onComplete?: any;
/**
* Callback that fires at the start of the close process.
*/
onCleanup?: any;
/**
* Callback that fires once Colorbox is closed.
*/
onClosed?: any;
}
interface ColorboxStatic {
/**
* This method allows you to call Colorbox without having to assign it to an element.
*/
(settings: ColorboxSettings);
/**
* This method moves to the next item in a group and are the same as pressing the 'next' or 'previous' buttons.
*/
next(): void;
/**
* This method moves to the previous item in a group and are the same as pressing the 'next' or 'previous' buttons.
*/
prev(): void;
/**
* This method initiates the close sequence, which does not immediately complete. The lightbox will be completely closed only when the cbox_closed event / onClosed callback is fired.
*/
close(): void;
/**
* This method is used to fetch the current HTML element that Colorbox is associated with.
*/
element(): JQuery;
/**
* This allows Colorbox to be resized based on it's own auto-calculations, or to a specific size. This must be called manually after Colorbox's content has loaded.
*/
resize(): void;
/**
* This allows Colorbox to be resized based on it's own auto-calculations, or to a specific size. This must be called manually after Colorbox's content has loaded.
*/
resize(settings: ColorboxResizeSettings): void;
/**
* Removes all traces of Colorbox from the document.
*/
remove(): void;
/**
* Default settings used for Colorbox calls
*/
settings: ColorboxSettings;
}
interface Colorbox {
(): JQuery;
(settings: ColorboxSettings): JQuery;
}
interface JQueryStatic {
colorbox: ColorboxStatic;
}
interface JQuery {
colorbox: Colorbox;
}