Skip to content

B
bootstrap
Commit edb221a2 authored by Ben Ogle's avatar Ben Ogle
Browse files
Options

Add tooltip `viewport` option, respect bounds of the viewport

parent 8fb75ee9
Show whitespace changes
Inline Side-by-side
Showing with 203 additions and 30 deletions
docs/javascript.html
View file @ edb221a2
...@@ -1027,6 +1027,22 @@ $('#example').tooltip(options) ...@@ -1027,6 +1027,22 @@ $('#example').tooltip(options)
<p>Appends the tooltip to a specific element. Example: <code>container: 'body'</code></p> <p>Appends the tooltip to a specific element. Example: <code>container: 'body'</code></p>
</td> </td>
</tr> </tr>
<tr>
<td>viewport</td>
<td>string</td>
<td>'body'</td>
<td>
<p>Keeps the tooltip within the bounds of this element. Example: <code>viewport: '#viewport'</code></p>
</td>
</tr>
<tr>
<td>viewportPadding</td>
<td>number</td>
<td>0</td>
<td>
<p>Pixel distance to keep the tooltip from the edges of the viewport element. Example: <code>viewportPadding: 10</code></p>
</td>
</tr>
</tbody> </tbody>
</table> </table>
</div><!-- /.table-responsive --> </div><!-- /.table-responsive -->
......
examples/tooltips/viewport.html 0 → 100644
View file @ edb221a2
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<link rel="shortcut icon" href="../../docs-assets/ico/favicon.png">
<title>Tooltip Viewport Example for Bootstrap</title>
<!-- Bootstrap core CSS -->
<link href="../../dist/css/bootstrap.css" rel="stylesheet">
<!-- Just for debugging purposes. Don't actually copy this line! -->
<!--[if lt IE 9]><script src="../../docs-assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<style>
.tooltip {
min-width: 250px;
max-width: 500px;
}
.tooltip .tooltip-inner {
min-height: 200px;
min-width: 250px;
max-width: 500px;
}
.placeholder {
height: 900px;
}
</style>
</head>
<body>
<button class="btn pull-right tooltip-bottom", title="This should be shifted to the left">Shift Left</button>
<button class="btn tooltip-bottom", title="This should be shifted to the right">Shift Right</button>
<button class="btn tooltip-right", title="This should be shifted down">Shift Down</button>
<div class="placeholder">There is a button down there ↓</div>
<button class="btn tooltip-right", title="This should be shifted up">Shift Up</button>
<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="../../js/tooltip.js"></script>
<script>
$(function(){
$('.tooltip-right').tooltip({
placement: 'right',
viewportPadding: 2
});
$('.tooltip-bottom').tooltip({
placement: 'bottom',
viewportPadding: 2
});
});
</script>
</body>
</html>
js/tests/unit/tooltip.js
View file @ edb221a2
...@@ -338,10 +338,10 @@ $(function () { ...@@ -338,10 +338,10 @@ $(function () {
}) })
test('should add position class before positioning so that position-specific styles are taken into account', function () { test('should add position class before positioning so that position-specific styles are taken into account', function () {
$('head').append('<style> .tooltip.right { white-space: nowrap; } .tooltip.right .tooltip-inner { max-width: none; } </style>') $('head').append('<style id="test"> .tooltip.right { white-space: nowrap; } .tooltip.right .tooltip-inner { max-width: none; } </style>')
var container = $('<div />').appendTo('body'), var container = $('<div />').appendTo('body'),
target = $('<a href="#" rel="tooltip" title="very very very very very very very very long tooltip in one line"></a>') target = $('<a href="#" rel="tooltip" title="very very very very very very very very long tooltip in one line" style="position: fixed; top: 10px; left: 0px;"></a>')
.appendTo(container) .appendTo(container)
.tooltip({placement: 'right'}) .tooltip({placement: 'right'})
.tooltip('show'), .tooltip('show'),
...@@ -349,6 +349,67 @@ $(function () { ...@@ -349,6 +349,67 @@ $(function () {
ok( Math.round(target.offset().top + (target[0].offsetHeight / 2) - (tooltip[0].offsetHeight / 2)) === Math.round(tooltip.offset().top) ) ok( Math.round(target.offset().top + (target[0].offsetHeight / 2) - (tooltip[0].offsetHeight / 2)) === Math.round(tooltip.offset().top) )
target.tooltip('hide') target.tooltip('hide')
$('head #test').remove()
})
test('should adjust the tip\'s top when up against the top of the viewport', function () {
$('head').append('<style id="test"> .tooltip .tooltip-inner { width: 200px; height: 200px; max-width: none; } </style>')
var container = $('<div />').appendTo('body'),
target = $('<a href="#" rel="tooltip" title="tip" style="position: fixed; top: 0px; left: 0px;"></a>')
.appendTo(container)
.tooltip({placement: 'right', viewportPadding: 12})
.tooltip('show'),
tooltip = container.find('.tooltip')
ok( Math.round(tooltip.offset().top) === 12 )
target.tooltip('hide')
$('head #test').remove()
})
test('should adjust the tip\'s top when up against the bottom of the viewport', function () {
$('head').append('<style id="test"> .tooltip .tooltip-inner { width: 200px; height: 200px; max-width: none; } </style>')
var container = $('<div />').appendTo('body'),
target = $('<a href="#" rel="tooltip" title="tip" style="position: fixed; bottom: 0px; left: 0px;"></a>')
.appendTo(container)
.tooltip({placement: 'right', viewportPadding: 12})
.tooltip('show'),
tooltip = container.find('.tooltip')
ok( Math.round(tooltip.offset().top) === Math.round($(window).height() - 12 - tooltip[0].offsetHeight) )
target.tooltip('hide')
$('head #test').remove()
})
test('should adjust the tip\'s left when up against the left of the viewport', function () {
$('head').append('<style id="test"> .tooltip .tooltip-inner { width: 200px; height: 200px; max-width: none; } </style>')
var container = $('<div />').appendTo('body'),
target = $('<a href="#" rel="tooltip" title="tip" style="position: fixed; top: 0px; left: 0px;"></a>')
.appendTo(container)
.tooltip({placement: 'bottom', viewportPadding: 12})
.tooltip('show'),
tooltip = container.find('.tooltip')
ok( Math.round(tooltip.offset().left) === 12 )
target.tooltip('hide')
$('head #test').remove()
})
test('should adjust the tip\'s left when up against the right of the viewport', function () {
$('head').append('<style id="test"> .tooltip .tooltip-inner { width: 200px; height: 200px; max-width: none; } </style>')
var container = $('<div />').appendTo('body'),
target = $('<a href="#" rel="tooltip" title="tip" style="position: fixed; top: 0px; right: 0px;"></a>')
.appendTo(container)
.tooltip({placement: 'bottom', viewportPadding: 12})
.tooltip('show'),
tooltip = container.find('.tooltip')
ok( Math.round(tooltip.offset().left) === Math.round($(window).width() - 12 - tooltip[0].offsetWidth) )
target.tooltip('hide')
$('head #test').remove()
}) })
test('tooltip title test #1', function () { test('tooltip title test #1', function () {
......
js/tooltip.js
View file @ edb221a2
...@@ -34,7 +34,9 @@ ...@@ -34,7 +34,9 @@
title: '', title: '',
delay: 0, delay: 0,
html: false, html: false,
container: false container: false,
viewport: 'body',
viewportPadding: 0
} }
Tooltip.prototype.init = function (type, element, options) { Tooltip.prototype.init = function (type, element, options) {
...@@ -42,6 +44,7 @@ ...@@ -42,6 +44,7 @@
this.type = type this.type = type
this.$element = $(element) this.$element = $(element)
this.options = this.getOptions(options) this.options = this.getOptions(options)
this.$viewport = $(this.options.viewport)
var triggers = this.options.trigger.split(' ') var triggers = this.options.trigger.split(' ')
...@@ -157,18 +160,14 @@ ...@@ -157,18 +160,14 @@
var actualHeight = $tip[0].offsetHeight var actualHeight = $tip[0].offsetHeight
if (autoPlace) { if (autoPlace) {
var orgPlacement = placement
var $parent = this.$element.parent() var $parent = this.$element.parent()
var parentDim = this.getElementDimensions($parent)
var orgPlacement = placement placement = placement == 'bottom' && pos.top + pos.height + actualHeight - parentDim.scroll > parentDim.height ? 'top' :
var docScroll = document.documentElement.scrollTop || document.body.scrollTop placement == 'top' && pos.top - parentDim.scroll - actualHeight < 0 ? 'bottom' :
var parentWidth = this.options.container == 'body' ? window.innerWidth : $parent.outerWidth() placement == 'right' && pos.right + actualWidth > parentDim.width ? 'left' :
var parentHeight = this.options.container == 'body' ? window.innerHeight : $parent.outerHeight() placement == 'left' && pos.left - actualWidth < parentDim.left ? 'right' :
var parentLeft = this.options.container == 'body' ? 0 : $parent.offset().left
placement = placement == 'bottom' && pos.top + pos.height + actualHeight - docScroll > parentHeight ? 'top' :
placement == 'top' && pos.top - docScroll - actualHeight < 0 ? 'bottom' :
placement == 'right' && pos.right + actualWidth > parentWidth ? 'left' :
placement == 'left' && pos.left - actualWidth < parentLeft ? 'right' :
placement placement
$tip $tip
...@@ -228,29 +227,22 @@ ...@@ -228,29 +227,22 @@
var actualHeight = $tip[0].offsetHeight var actualHeight = $tip[0].offsetHeight
if (placement == 'top' && actualHeight != height) { if (placement == 'top' && actualHeight != height) {
replace = true
offset.top = offset.top + height - actualHeight offset.top = offset.top + height - actualHeight
} }
if (/bottom|top/.test(placement)) { var delta = this.getViewportAdjustedDelta(placement, offset, actualWidth, actualHeight)
var delta = 0
if (offset.left < 0) {
delta = offset.left * -2
offset.left = 0
$tip.offset(offset) if (delta.left)
offset.left = offset.left + delta.left
else
offset.top = offset.top + delta.top
actualWidth = $tip[0].offsetWidth var arrowDelta = delta.left * 2 - (delta.left ? width + actualWidth : height + actualHeight)
actualHeight = $tip[0].offsetHeight var arrowPosition = delta.left ? 'left' : 'top'
} var arrowOffsetPosition = delta.left ? 'offsetWidth' : 'offsetHeight'
this.replaceArrow(delta - width + actualWidth, actualWidth, 'left') $tip.offset(offset)
} else { this.replaceArrow(arrowDelta, $tip[0][arrowOffsetPosition], arrowPosition)
this.replaceArrow(actualHeight - height, actualHeight, 'top')
}
if (replace) $tip.offset(offset)
} }
Tooltip.prototype.replaceArrow = function (delta, dimension, position) { Tooltip.prototype.replaceArrow = function (delta, dimension, position) {
...@@ -316,6 +308,39 @@ ...@@ -316,6 +308,39 @@
placement == 'top' ? { top: pos.top - actualHeight, left: pos.left + pos.width / 2 - actualWidth / 2 } : placement == 'top' ? { top: pos.top - actualHeight, left: pos.left + pos.width / 2 - actualWidth / 2 } :
placement == 'left' ? { top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth } : placement == 'left' ? { top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth } :
/* placement == 'right' */ { top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width } /* placement == 'right' */ { top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width }
}
Tooltip.prototype.getViewportAdjustedDelta = function (placement, pos, actualWidth, actualHeight) {
var delta = {}
var viewportPadding = this.options.viewportPadding
var viewportDimensions = this.getElementDimensions(this.$viewport)
if (/right|left/.test(placement)) {
if (pos.top + actualHeight - viewportDimensions.scroll + viewportPadding > viewportDimensions.height) { // bottom overflow
delta.top = viewportDimensions.height + viewportDimensions.scroll - actualHeight - viewportPadding - pos.top
} else if (pos.top - viewportDimensions.scroll - viewportPadding < 0) { // top overflow
delta.top = viewportDimensions.scroll + viewportPadding - pos.top
}
} else {
if (pos.left + actualWidth + viewportPadding > viewportDimensions.width) { // right overflow
delta.left = viewportDimensions.width - actualWidth - viewportPadding - pos.left
} else if (pos.left - viewportPadding < viewportDimensions.left) { // left overflow
delta.left = viewportDimensions.left + viewportPadding - pos.left
}
}
return delta
}
Tooltip.prototype.getElementDimensions = function ($element) {
var isBody = $element[0].tagName == 'BODY'
return {
scroll: isBody ? document.documentElement.scrollTop || document.body.scrollTop : $element.scrollTop(),
width: isBody ? window.innerWidth : $element.outerWidth(),
height: isBody ? window.innerHeight : $element.outerHeight(),
left: isBody ? 0 : $element.offset().left
}
} }
Tooltip.prototype.getTitle = function () { Tooltip.prototype.getTitle = function () {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment