-
Notifications
You must be signed in to change notification settings - Fork 23
/
positionable.js
397 lines (367 loc) · 12.3 KB
/
positionable.js
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
steal('can/control', 'can/construct/proxy', 'can/construct/super', 'jquery', 'jquery/event/move').then('./position.js').then(function($){
/**
* @class can.ui.layout.Positionable
* @parent canui
*
* @description Allows you to position an element relative to another element.
*
* The positionable plugin allows you to position an element relative to
* another. It abstracts all of the calculating you might have to do when
* implementing UI widgets, such as tooltips and autocompletes.
*
* # Basic Example
*
* Given the following markup:
*
* <a id="target" href="http://jupiterjs.com/">Bitovi!</a>
* <div id="tooltip">Bitovi</div>
*
* To position the tooltip element above the anchor link, you would use the
* following code:
*
* // Initialize the positionable plugin
* new can.ui.layout.Positionable($("#tooltip"), {
* my: "bottom",
* at: "top",
* of: $("#target")
* });
*
* // Trigger the move event on the tooltip to move it's position
* $("#tooltip").trigger("move");
*
* In the options passed to the positionable plugin, we're telling the plugin
* to align the bottom of the `#tooltip` element to the top of the
* `#target` element.
*
* # Autocomplete Example
*
* Given the following markup:
*
* <form>
* <label>
* Search
* <input type="text" name="search" />
* </label>
* </form>
* <ul id="autocomplete">
* </ul>
*
* You could easily implement an autocompleting search input using the
* following code:
*
* // Position the autocomplete list below the search input
* new can.ui.layout.Positionable($("#autocomplete"), {
* my: "top left",
* at: "bottom left",
* of: $("#search")
* });
*
* // Autocomplete controller
* var Autocomplete = can.Control({
* "keyup" : function( el, ev ) {
* this.options.list.show();
* $.ajax({
* url : "/search.php",
* data : el.val(),
* success : this.callback("updateResults")
* });
* },
* "blur" : function() {
* this.options.list.hide();
* },
* "updateResults" : function( json ) {
* this.options.list.html( "views/autocomplete-list.ejs", json );
* },
* "{list} li click" : function( el, ev ) {
* this.blur();
* this.element.val( el.text() );
* }
* });
*
* // Initialize the autocomplete controller on the search element
* new Autocomplete($("#search"), {
* list: $("#autocomplete")
* });
*
*
* ## Demo
* @demo canui/layout/positionable/positionable.html
*
* @param {Object} options Object literal describing how to position the
* current element against another.
*
* - `my` {String} - String containing the edge of the positionable element to be
* used in positioning. Possbile values are:
* - `at` {String} - String containing the edge of the target element to be
* used in positioning.
* - Possible values for both the `my` and `at` options include:
* - `"top"`
* - `"center"`
* - `"bottom"`
* - `"left"`
* - `"right"`
* - Horizontal and vertical values can be used in conjunction with
* eachother, separated by a space. For example, `"bottom left"`.
* - `of` {jQuery} - The target DOM element.
* - `collision` {String} - Collision strategy to be used in case the positionable
* element does not fit in the window. Possible values include
* - `fit` - Attempts to position the element as close as possible to
* the target without clipping the positionable.
* - `flip` - Flips the element to the opposite side of the target.
* - `none` - Don't use any collision strategey.
* - `using` {Function} - function that recieves the calculated position
* in the format of `{ top: x, left: y }` to handle the positioning. If a
* `using` parameter is passed, the element won't be positioned
* automatically, but must be positioned by hand in the `using` callback.
*
*
* This plugin is built on top of the [jQuery UI Position Plugin](http://docs.jquery.com/UI/Position),
* so you may refer to their documentation for more advanced usage.
*/
can.Control("can.ui.Positionable",
{
rhorizontal : /left|center|right/,
rvertical : /top|center|bottom/,
hdefault : "center",
vdefault : "center",
defaults : {
iframe: false,
of: window,
keep : false, //keeps it where it belongs,
hideWhenOfInvisible : false
},
scrollbarWidth: function() {
var w1, w2,
div = $( "<div style='display:block;width:50px;height:50px;overflow:hidden;'><div style='height:100px;width:auto;'></div></div>" ),
innerDiv = div.children()[0];
$( "body" ).append( div );
w1 = innerDiv.offsetWidth;
div.css( "overflow", "scroll" );
w2 = innerDiv.offsetWidth;
if ( w1 === w2 ) {
w2 = div[0].clientWidth;
}
div.remove();
return w1 - w2;
},
getScrollInfo: function(within) {
var notWindow = within[0] !== window,
overflowX = notWindow ? within.css( "overflow-x" ) : "",
overflowY = notWindow ? within.css( "overflow-y" ) : "",
scrollbarWidth = overflowX === "auto" || overflowX === "scroll" ? $.position.scrollbarWidth() : 0,
scrollbarHeight = overflowY === "auto" || overflowY === "scroll" ? $.position.scrollbarWidth() : 0;
return {
height: within.height() < within[0].scrollHeight ? scrollbarHeight : 0,
width: within.width() < within[0].scrollWidth ? scrollbarWidth : 0
};
}
},
/**
* @prototype
*/
{
setup : function(element, options){
var controls = $(element).data('controls'),
pluginName = this.constructor._shortName;
if(controls && controls.length > 0){
for(var i = 0; i < controls.length; i++){
if(controls[i].constructor._shortName === pluginName){
controls[i].destroy();
}
}
}
this._super(element, options);
},
init : function(element, options) {
//if(this.element.length === 0) return;
this.element.css("position","absolute");
if(!this.options.keep){
// Remove element from it's parent only if this element _has_ parent.
// This allows us to call positionable like `new can.ui.layout.Positionable($('<div/>'))
if(this.element[0].parentNode){
this.element[0].parentNode.removeChild(this.element[0])
}
document.body.appendChild(this.element[0]);
}
},
show : function(el, ev, position){
this.move.apply(this, arguments)
//clicks elsewhere should hide
},
move : function( el, ev, positionFrom ) {
var position = this.position.apply(this, arguments),
elem = this.element,
options = this.options;
// if elem is hidden, show it before setting offset
var visible = elem.is(":visible")
if ( ! visible ) {
elem.css("opacity", 0).show()
}
elem.offset( $.extend( position, { using: options.using } ) );
if ( ! visible ) {
elem.css("opacity", 1).hide();
}
if(this.options.hideWhenOfInvisible){
this.element.toggle(this.isOfVisible());
}
},
isOfVisible : function(){
if(this.options.of.position().top < 0){
return false;
}
if(this.options.of.position().top > this.options.of.offsetParent().height()){
return false;
}
return true;
},
update : function(options){
can.extend(this.options, options);
this.on();
},
/**
* Calculate the position of the element.
*/
position : function(el, ev, positionFrom){
var options = $.extend({},this.options);
options.of= positionFrom || options.of;
if(!options.of) return;
var target = $( options.of ),
collision = ( options.collision || "flip" ).split( " " ),
offset = options.offset ? options.offset.split( " " ) : [ 0, 0 ],
targetWidth,
targetHeight,
basePosition;
if ( options.of.nodeType === 9 ) {
targetWidth = target.width();
targetHeight = target.height();
basePosition = { top: 0, left: 0 };
} else if ( options.of.scrollTo && options.of.document ) {
targetWidth = target.width();
targetHeight = target.height();
basePosition = { top: target.scrollTop(), left: target.scrollLeft() };
} else if ( options.of.preventDefault ) {
// force left top to allow flipping
options.at = "left top";
targetWidth = targetHeight = 0;
basePosition = { top: options.of.pageY, left: options.of.pageX };
} else if (options.of.top){
options.at = "left top";
targetWidth = targetHeight = 0;
basePosition = { top: options.of.top, left: options.of.left };
} else {
targetWidth = target.outerWidth();
targetHeight = target.outerHeight();
if(false){
var to = target.offset();
var eo =this.element.parent().children(":first").offset();
basePosition = {
left: to.left - eo.left,
top: to.top -eo.top
}
}else{
basePosition = target.offset();
}
}
// force my and at to have valid horizontal and veritcal positions
// if a value is missing or invalid, it will be converted to center
$.each( [ "my", "at" ], this.proxy( function( i, val ) {
var pos = ( options[val] || "" ).split( " " );
if ( pos.length === 1) {
pos = this.constructor.rhorizontal.test( pos[0] ) ?
pos.concat( [this.constructor.vdefault] ) :
this.constructor.rvertical.test( pos[0] ) ?
[ this.constructor.hdefault ].concat( pos ) :
[ this.constructor.hdefault, this.constructor.vdefault ];
}
pos[ 0 ] = this.constructor.rhorizontal.test( pos[0] ) ? pos[ 0 ] : this.constructor.hdefault;
pos[ 1 ] = this.constructor.rvertical.test( pos[1] ) ? pos[ 1 ] : this.constructor.vdefault;
options[ val ] = pos;
}));
// normalize collision option
if ( collision.length === 1 ) {
collision[ 1 ] = collision[ 0 ];
}
// normalize offset option
offset[ 0 ] = parseInt( offset[0], 10 ) || 0;
if ( offset.length === 1 ) {
offset[ 1 ] = offset[ 0 ];
}
offset[ 1 ] = parseInt( offset[1], 10 ) || 0;
if ( options.at[0] === "right" ) {
basePosition.left += targetWidth;
} else if (options.at[0] === this.constructor.hdefault ) {
basePosition.left += targetWidth / 2;
}
if ( options.at[1] === "bottom" ) {
basePosition.top += targetHeight;
} else if ( options.at[1] === this.constructor.vdefault ) {
basePosition.top += targetHeight / 2;
}
basePosition.left += offset[ 0 ];
basePosition.top += offset[ 1 ];
var elem = this.element,
elemWidth = elem.outerWidth(),
elemHeight = elem.outerHeight(),
position = $.extend( {}, basePosition ),
getScrollInfo = this.constructor.getScrollInfo,
over,
myOffset,
atOffset;
if ( options.my[0] === "right" ) {
position.left -= elemWidth;
} else if ( options.my[0] === this.constructor.hdefault ) {
position.left -= elemWidth / 2;
}
if ( options.my[1] === "bottom" ) {
position.top -= elemHeight;
} else if ( options.my[1] === this.constructor.vdefault ) {
position.top -= elemHeight / 2;
}
$.each( [ "left", "top" ], function( i, dir ) {
if ( $.ui.position[ collision[i] ] ) {
var isEvent = ((options.of && options.of.preventDefault) != null),
within = $(isEvent || !options.of ? window : options.of),
marginLeft = parseInt( $.curCSS( elem[0], "marginLeft", true ) ) || 0,
marginTop = parseInt( $.curCSS( elem[0], "marginTop", true ) ) || 0;
var scrollInfo = getScrollInfo(within);
$.ui.position[ collision[i] ][ dir ]( position, {
targetWidth: targetWidth,
targetHeight: targetHeight,
elem: elem,
within : within,
collisionPosition : {
marginLeft: parseInt( $.curCSS( elem[0], "marginLeft", true ) ) || 0,
marginTop: parseInt( $.curCSS( elem[0], "marginTop", true ) ) || 0
},
collisionWidth: elemWidth + marginLeft +
( parseInt( $.curCSS( elem[0], "marginRight", true ) ) || 0 ) + scrollInfo.width,
collisionHeight: elemHeight + marginTop +
( parseInt( $.curCSS( elem[0], "marginBottom", true ) ) || 0 ) + scrollInfo.height,
elemWidth: elemWidth,
elemHeight: elemHeight,
offset: offset,
my: options.my,
at: options.at
});
}
});
return position
},
/**
* Move element when the `of` element is moving
*/
"{of} move" : function(el, ev){
clearTimeout(this._finalMove)
this.move(this.element, ev, el);
this._finalMove = setTimeout(this.proxy(function(){
this.move(this.element, ev, el);
}), 1)
},
/**
* Reposition element when `move` event is triggered
*/
" move" : function(){
this.move.apply(this, arguments)
}
})
});