diff --git a/grails-app/conf/EnhancedScaffoldingResources.groovy b/grails-app/conf/EnhancedScaffoldingResources.groovy index 6e1995b..172c0a3 100644 --- a/grails-app/conf/EnhancedScaffoldingResources.groovy +++ b/grails-app/conf/EnhancedScaffoldingResources.groovy @@ -39,6 +39,8 @@ modules = { "grails.errors" { defaultBundle "scaffolding" dependsOn "modernizr", "jquery" + resource url: [plugin: "enhanced-scaffolding", dir: "js", file: "jquery.tipsy.js"] + resource url: [plugin: "enhanced-scaffolding", dir: "css", file: "tipsy.css"] resource url: [plugin: "enhanced-scaffolding", dir: "js", file: "grails.errors.js"] resource url: [plugin: "enhanced-scaffolding", dir: "js", file: "grails.errors.loader.js"] resource url: [plugin: "enhanced-scaffolding", dir: "css", file: "grails.errors.css"] diff --git a/readme.md b/readme.md index e0f3d59..c3ef5de 100644 --- a/readme.md +++ b/readme.md @@ -40,6 +40,12 @@ AJAX-enhances scaffolding list pages so that pagination and sorting are done via Replaces `select` elements used to represent domain class properties that have a [_range_][4] constraint with native HTML _range_ inputs in browsers that support them. +## Included libraries + +The enhanced scaffolding plugin depends on the following software: + +* The [jQuery.tipsy][http://onehackoranother.com/projects/jquery/tipsy] plugin. + ## To-do ### General diff --git a/web-app/css/grails.errors.css b/web-app/css/grails.errors.css index 828bed6..b950023 100644 --- a/web-app/css/grails.errors.css +++ b/web-app/css/grails.errors.css @@ -1,26 +1,3 @@ -.error-tooltip { - background: #ff6666; - border: 1px solid #ff6666; - color: #ffffff; - font-size: 0.8em; - margin: 0; - max-width: 20em; - padding: 0.5em; - position: absolute; - text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.8); - -moz-border-radius: 0.5em; - -webkit-border-radius: 0.5em; - border-radius: 0.5em; - -moz-box-shadow: 0 0 0.25em #ff6666; - -webkit-box-shadow: 0 0 0.25em #ff6666; - box-shadow: 0 0 0.25em #ff6666; -} - -.tooltip-pointer { - width: 0; - height: 0; - border: 0.75em solid transparent; - border-right-color: #ff6666; - position: absolute; - left: -1.5em; -} +body .tipsy { + font-size: 14px; +} \ No newline at end of file diff --git a/web-app/css/tipsy.css b/web-app/css/tipsy.css new file mode 100644 index 0000000..f42fb70 --- /dev/null +++ b/web-app/css/tipsy.css @@ -0,0 +1,25 @@ +.tipsy { font-size: 10px; position: absolute; padding: 5px; z-index: 100000; } + .tipsy-inner { background-color: #000; color: #FFF; max-width: 200px; padding: 5px 8px 4px 8px; text-align: center; } + + /* Rounded corners */ + .tipsy-inner { border-radius: 3px; -moz-border-radius: 3px; -webkit-border-radius: 3px; } + + /* Uncomment for shadow */ + .tipsy-inner { box-shadow: 0 0 5px #000000; -webkit-box-shadow: 0 0 5px #000000; -moz-box-shadow: 0 0 5px #000000; } + + .tipsy-arrow { position: absolute; width: 0; height: 0; line-height: 0; border: 5px dashed #000; } + + /* Rules to colour arrows */ + .tipsy-arrow-n { border-bottom-color: #000; } + .tipsy-arrow-s { border-top-color: #000; } + .tipsy-arrow-e { border-left-color: #000; } + .tipsy-arrow-w { border-right-color: #000; } + + .tipsy-n .tipsy-arrow { top: 0px; left: 50%; margin-left: -5px; border-bottom-style: solid; border-top: none; border-left-color: transparent; border-right-color: transparent; } + .tipsy-nw .tipsy-arrow { top: 0; left: 10px; border-bottom-style: solid; border-top: none; border-left-color: transparent; border-right-color: transparent;} + .tipsy-ne .tipsy-arrow { top: 0; right: 10px; border-bottom-style: solid; border-top: none; border-left-color: transparent; border-right-color: transparent;} + .tipsy-s .tipsy-arrow { bottom: 0; left: 50%; margin-left: -5px; border-top-style: solid; border-bottom: none; border-left-color: transparent; border-right-color: transparent; } + .tipsy-sw .tipsy-arrow { bottom: 0; left: 10px; border-top-style: solid; border-bottom: none; border-left-color: transparent; border-right-color: transparent; } + .tipsy-se .tipsy-arrow { bottom: 0; right: 10px; border-top-style: solid; border-bottom: none; border-left-color: transparent; border-right-color: transparent; } + .tipsy-e .tipsy-arrow { right: 0; top: 50%; margin-top: -5px; border-left-style: solid; border-right: none; border-top-color: transparent; border-bottom-color: transparent; } + .tipsy-w .tipsy-arrow { left: 0; top: 50%; margin-top: -5px; border-right-style: solid; border-left: none; border-top-color: transparent; border-bottom-color: transparent; } \ No newline at end of file diff --git a/web-app/js/grails.errors.js b/web-app/js/grails.errors.js index f7842b9..6b05692 100644 --- a/web-app/js/grails.errors.js +++ b/web-app/js/grails.errors.js @@ -24,37 +24,12 @@ $(this).remove(); // create a tooltip adjacent to the input - var errorBox = $('
').text(errorMessage).addClass('error-tooltip').attr('role', 'tooltip'); - input.attr('aria-invalid', 'true').after(errorBox); - - // insert a pointer between the input and the tooltip - var pointer = $('
'); - errorBox.prepend(pointer); - - // position the error box to the right of the input and vertically aligned with it - var inputOffset = input.offset(); - var inputMidpoint = input.outerHeight() / 2; - var errorBoxMidpoint = errorBox.outerHeight() / 2; - - errorBox.offset({ - left: inputOffset.left + input.outerWidth() + pointer.outerWidth(), - top: inputOffset.top - (errorBoxMidpoint - inputMidpoint) + input.tipsy({ + fade: true, + gravity: 'w', + title: function() { return errorMessage }, + trigger: 'focus' }); - - // position the pointer vertically in the middle of the error box - pointer.offset({ - top: errorBox.offset().top - ((pointer.outerHeight() / 2) - errorBoxMidpoint) - }); - - // hide the error box until its input is focused - if (settings.hide) { - errorBox.hide().attr('aria-hidden', true); - input.focus(function() { - errorBox.show().removeAttr('aria-hidden'); - }).blur(function() { - errorBox.hide().attr('aria-hidden', 'true'); - }); - } } }); diff --git a/web-app/js/jquery.tipsy.js b/web-app/js/jquery.tipsy.js new file mode 100644 index 0000000..16e6ca1 --- /dev/null +++ b/web-app/js/jquery.tipsy.js @@ -0,0 +1,241 @@ +// tipsy, facebook style tooltips for jquery +// version 1.0.0a +// (c) 2008-2010 jason frame [jason@onehackoranother.com] +// released under the MIT license + +(function($) { + + function maybeCall(thing, ctx) { + return (typeof thing == 'function') ? (thing.call(ctx)) : thing; + }; + + function Tipsy(element, options) { + this.$element = $(element); + this.options = options; + this.enabled = true; + this.fixTitle(); + }; + + Tipsy.prototype = { + show: function() { + var title = this.getTitle(); + if (title && this.enabled) { + var $tip = this.tip(); + + $tip.find('.tipsy-inner')[this.options.html ? 'html' : 'text'](title); + $tip[0].className = 'tipsy'; // reset classname in case of dynamic gravity + $tip.remove().css({top: 0, left: 0, visibility: 'hidden', display: 'block'}).prependTo(document.body); + + var pos = $.extend({}, this.$element.offset(), { + width: this.$element[0].offsetWidth, + height: this.$element[0].offsetHeight + }); + + var actualWidth = $tip[0].offsetWidth, + actualHeight = $tip[0].offsetHeight, + gravity = maybeCall(this.options.gravity, this.$element[0]); + + var tp; + switch (gravity.charAt(0)) { + case 'n': + tp = {top: pos.top + pos.height + this.options.offset, left: pos.left + pos.width / 2 - actualWidth / 2}; + break; + case 's': + tp = {top: pos.top - actualHeight - this.options.offset, left: pos.left + pos.width / 2 - actualWidth / 2}; + break; + case 'e': + tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth - this.options.offset}; + break; + case 'w': + tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width + this.options.offset}; + break; + } + + if (gravity.length == 2) { + if (gravity.charAt(1) == 'w') { + tp.left = pos.left + pos.width / 2 - 15; + } else { + tp.left = pos.left + pos.width / 2 - actualWidth + 15; + } + } + + $tip.css(tp).addClass('tipsy-' + gravity); + $tip.find('.tipsy-arrow')[0].className = 'tipsy-arrow tipsy-arrow-' + gravity.charAt(0); + if (this.options.className) { + $tip.addClass(maybeCall(this.options.className, this.$element[0])); + } + + if (this.options.fade) { + $tip.stop().css({opacity: 0, display: 'block', visibility: 'visible'}).animate({opacity: this.options.opacity}); + } else { + $tip.css({visibility: 'visible', opacity: this.options.opacity}); + } + } + }, + + hide: function() { + if (this.options.fade) { + this.tip().stop().fadeOut(function() { $(this).remove(); }); + } else { + this.tip().remove(); + } + }, + + fixTitle: function() { + var $e = this.$element; + if ($e.attr('title') || typeof($e.attr('original-title')) != 'string') { + $e.attr('original-title', $e.attr('title') || '').removeAttr('title'); + } + }, + + getTitle: function() { + var title, $e = this.$element, o = this.options; + this.fixTitle(); + var title, o = this.options; + if (typeof o.title == 'string') { + title = $e.attr(o.title == 'title' ? 'original-title' : o.title); + } else if (typeof o.title == 'function') { + title = o.title.call($e[0]); + } + title = ('' + title).replace(/(^\s*|\s*$)/, ""); + return title || o.fallback; + }, + + tip: function() { + if (!this.$tip) { + this.$tip = $('
').html('
'); + } + return this.$tip; + }, + + validate: function() { + if (!this.$element[0].parentNode) { + this.hide(); + this.$element = null; + this.options = null; + } + }, + + enable: function() { this.enabled = true; }, + disable: function() { this.enabled = false; }, + toggleEnabled: function() { this.enabled = !this.enabled; } + }; + + $.fn.tipsy = function(options) { + + if (options === true) { + return this.data('tipsy'); + } else if (typeof options == 'string') { + var tipsy = this.data('tipsy'); + if (tipsy) tipsy[options](); + return this; + } + + options = $.extend({}, $.fn.tipsy.defaults, options); + + function get(ele) { + var tipsy = $.data(ele, 'tipsy'); + if (!tipsy) { + tipsy = new Tipsy(ele, $.fn.tipsy.elementOptions(ele, options)); + $.data(ele, 'tipsy', tipsy); + } + return tipsy; + } + + function enter() { + var tipsy = get(this); + tipsy.hoverState = 'in'; + if (options.delayIn == 0) { + tipsy.show(); + } else { + tipsy.fixTitle(); + setTimeout(function() { if (tipsy.hoverState == 'in') tipsy.show(); }, options.delayIn); + } + }; + + function leave() { + var tipsy = get(this); + tipsy.hoverState = 'out'; + if (options.delayOut == 0) { + tipsy.hide(); + } else { + setTimeout(function() { if (tipsy.hoverState == 'out') tipsy.hide(); }, options.delayOut); + } + }; + + if (!options.live) this.each(function() { get(this); }); + + if (options.trigger != 'manual') { + var binder = options.live ? 'live' : 'bind', + eventIn = options.trigger == 'hover' ? 'mouseenter' : 'focus', + eventOut = options.trigger == 'hover' ? 'mouseleave' : 'blur'; + this[binder](eventIn, enter)[binder](eventOut, leave); + } + + return this; + + }; + + $.fn.tipsy.defaults = { + className: null, + delayIn: 0, + delayOut: 0, + fade: false, + fallback: '', + gravity: 'n', + html: false, + live: false, + offset: 0, + opacity: 0.8, + title: 'title', + trigger: 'hover' + }; + + // Overwrite this method to provide options on a per-element basis. + // For example, you could store the gravity in a 'tipsy-gravity' attribute: + // return $.extend({}, options, {gravity: $(ele).attr('tipsy-gravity') || 'n' }); + // (remember - do not modify 'options' in place!) + $.fn.tipsy.elementOptions = function(ele, options) { + return $.metadata ? $.extend({}, options, $(ele).metadata()) : options; + }; + + $.fn.tipsy.autoNS = function() { + return $(this).offset().top > ($(document).scrollTop() + $(window).height() / 2) ? 's' : 'n'; + }; + + $.fn.tipsy.autoWE = function() { + return $(this).offset().left > ($(document).scrollLeft() + $(window).width() / 2) ? 'e' : 'w'; + }; + + /** + * yields a closure of the supplied parameters, producing a function that takes + * no arguments and is suitable for use as an autogravity function like so: + * + * @param margin (int) - distance from the viewable region edge that an + * element should be before setting its tooltip's gravity to be away + * from that edge. + * @param prefer (string, e.g. 'n', 'sw', 'w') - the direction to prefer + * if there are no viewable region edges effecting the tooltip's + * gravity. It will try to vary from this minimally, for example, + * if 'sw' is preferred and an element is near the right viewable + * region edge, but not the top edge, it will set the gravity for + * that element's tooltip to be 'se', preserving the southern + * component. + */ + $.fn.tipsy.autoBounds = function(margin, prefer) { + return function() { + var dir = {ns: prefer[0], ew: (prefer.length > 1 ? prefer[1] : false)}, + boundTop = $(document).scrollTop() + margin, + boundLeft = $(document).scrollLeft() + margin, + $this = $(this); + + if ($this.offset().top < boundTop) dir.ns = 'n'; + if ($this.offset().left < boundLeft) dir.ew = 'w'; + if ($(window).width() + $(document).scrollLeft() - $this.offset().left < margin) dir.ew = 'e'; + if ($(window).height() + $(document).scrollTop() - $this.offset().top < margin) dir.ns = 's'; + + return dir.ns + (dir.ew ? dir.ew : ''); + } + }; + +})(jQuery); \ No newline at end of file