updated doc

master
Chakib Benziane 12 years ago
parent 609baee55e
commit bd2ed08c56

@ -1,43 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link href="css/bootstrap-magic-button.css" rel="stylesheet">
</head>
<body>
<!-- <div id="display2" style="width: 200px; height:200px; border: 1px solid blue;">
<button class="magicBtn" data-image="magicBtn-pin-off.png" data-toggle-image="magicBtn-pin-on.png" data-toggle="magicBtn" />
<button class="magicBtn" data-image="magicBtn-pin-off.png" data-toggle-image="magicBtn-pin-on.png" data-toggle="magicBtn" />
</div>
-->
<div id="display1" style="width: 200px; height:200px; border: 1px solid red;">
<p>test adsgdsgds</p>
<br />
<button class="magicBtn" data-image="img/magicBtn-pin-off.png" data-toggle-image="img/magicBtn-pin-on.png" data-toggle="magicBtn" />
</div>
<!-- <button class="magicBtn" data-toggle="magicBtn" data-image="magicBtn-pin-off.png" data-toggle-image="magicBtn-pin-on.png"/> -->
<script type="text/javascript" src="https://www.google.com/jsapi"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
<script>
google.load("jqueryui", "1.8.17");
</script>
<script src="js/jquery.hoverIntent.js"></script>
<script src="js/bootstrap-magic-button.js"></script>
<script>
$(function () {
$('.magicBtn').magicBtn({betweenSpace: 4, hover: true});
$('.magicBtn').magicBtn('show')
});
</script>
</body>
</html>

@ -0,0 +1,21 @@
button[class^=magicBtn] {
display: none;
position: absolute;
border-style: none;
background: none;
background-repeat: no-repeat;
width: 47px;
height: 32px;
opacity: 0.7;
}
button[class*="magicBtn-active"] {
position: absolute;
border-style: none;
background: none;
background-repeat: no-repeat;
width: 47px;
height: 32px;
opacity: 1;
}

@ -2,8 +2,8 @@ button[class^="magicBtn hero"] {
margin-top: 80px;
}
footer .footer {
style="margin-top: 45;
.footer {
margin-top: 45px;
padding:35px 0 36px;
border-top: 1px solid #E5E5E5;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 812 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 887 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 760 B

@ -9,7 +9,7 @@
<!-- Le styles -->
<link href="bootstrap/css/bootstrap.css" rel="stylesheet">
<link href="../css/bootstrap-magic-button.css" rel="stylesheet">
<link href="css/bootstrap-magic-button.css" rel="stylesheet">
<link href="prettify/prettify.css" type="text/css" rel="stylesheet" />
<link href="example.css" type="text/css" rel="stylesheet" />
@ -42,6 +42,8 @@
<ul class="nav">
<li class="active"><a href="#setup">Setup</a></li>
<li><a href="#example">Examples</a></li>
<li><a href="#methods">Methods</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
@ -88,7 +90,7 @@
<p>This is the most basic magic button, the default behavior is to stick on the right side
of div which is containing magic buttons
</p>
<button class="magicBtn" data-image="../img/msg.png"/>
<button class="magicBtn" data-image="img/msg.png"></button>
</div>
</div>
@ -98,7 +100,7 @@
<br />
<br />
<br />
<pre class="prettyprint linenums">&lt;div&nbsp;class=&quot;well&nbsp;span3&quot;&gt;<br/>&nbsp;&nbsp;&lt;p&gt;This&nbsp;is&nbsp;the&nbsp;most&nbsp;basic&nbsp;magic&nbsp;button,&nbsp;...&lt;/p&gt;<br/><br/>&nbsp;&nbsp;&lt;button&nbsp;class=&quot;magicBtn&quot;&nbsp;data-image=&quot;../img/msg.png&quot;/&gt;<br/>&lt;/div&gt;</pre>
<pre class="prettyprint linenums">&lt;div&nbsp;class=&quot;well&nbsp;span3&quot;&gt;<br/>&nbsp;&nbsp;&lt;p&gt;This&nbsp;is&nbsp;the&nbsp;most&nbsp;basic&nbsp;magic&nbsp;button,&nbsp;...&lt;/p&gt;<br/><br/>&nbsp;&nbsp;&lt;button&nbsp;class=&quot;magicBtn&quot;&nbsp;data-image=&quot;img/msg.png&quot;/&gt;<br/>&lt;/div&gt;</pre>
</div>
</div>
@ -112,7 +114,7 @@
<br />
<div class="well span3">
<p>Add a toggle effect using the <code>data-toggle="magicBtn"</code></p>
<button class="magicBtn" data-image="../img/msg.png" data-toggle="magicBtn"/>
<button class="magicBtn" data-image="img/msg.png" data-toggle="magicBtn"/>
</div>
</div>
@ -120,7 +122,7 @@
<br />
<br />
<br />
<pre class="prettyprint linenums">&lt;button class=&quot;magicBtn&quot; data-image=&quot;../img/msg.png&quot; data-toggle=&quot;magicBtn&quot;/&gt;<br/></pre>
<pre class="prettyprint linenums">&lt;button class=&quot;magicBtn&quot; data-image=&quot;img/msg.png&quot; data-toggle=&quot;magicBtn&quot;/&gt;<br/></pre>
</div>
</div>
@ -132,7 +134,7 @@
<br />
<div class="well span3">
<p>Use<code>data-toggle-image</code> to customize toggle image</p>
<button class="magicBtn" data-image="../img/pin-off.png" data-toggle="magicBtn" data-toggle-image="../img/pin-on.png"/>
<button class="magicBtn" data-image="img/pin-off.png" data-toggle="magicBtn" data-toggle-image="img/pin-on.png"></button>
</div>
</div>
@ -140,7 +142,7 @@
<br />
<br />
<br />
<pre class="prettyprint linenums">&lt;button class=&quot;magicBtn&quot; data-image=&quot;../img/pin-off.png&quot; data-toggle=&quot;magicBtn&quot; data-toggle-image=&quot;../img/pin-on.png&quot;/&gt;</pre>
<pre class="prettyprint linenums">&lt;button class=&quot;magicBtn&quot; data-image=&quot;img/pin-off.png&quot; data-toggle=&quot;magicBtn&quot; data-toggle-image=&quot;img/pin-on.png&quot;/&gt;</pre>
</div>
</div>
@ -154,7 +156,7 @@
<div class="well span3">
<p>You can enable a hover effect over your buttons</p>
<p>jquery.hoverIntent is used in replacement of jQuery builtin hover</p>
<button class="magicBtn hover" data-image="../img/pin-off.png" data-toggle="magicBtn" data-toggle-image="../img/pin-on.png"/>
<button class="magicBtn hover" data-image="img/pin-off.png" data-toggle="magicBtn" data-toggle-image="img/pin-on.png"></button>
</div>
</div>
@ -162,12 +164,89 @@
<br />
<br />
<br />
<pre class="prettyprint linenums">&lt;button class=&quot;magicBtn hover&quot; data-image=&quot;../img/pin-off.png&quot; data-toggle=&quot;magicBtn&quot; data-toggle-image=&quot;../img/pin-on.png&quot;/&gt;</pre>
<pre class="prettyprint linenums">&lt;button class=&quot;magicBtn hover&quot; data-image=&quot;img/pin-off.png&quot; data-toggle=&quot;magicBtn&quot; data-toggle-image=&quot;img/pin-on.png&quot;/&gt;</pre>
<pre class="prettyprint linenums">$('.hover').magicBtn({hover: true});<br/>$('.hover').magicBtn('show');</pre>
</div>
</div>
<div class="row">
<div class="span5">
<h3>How about bootstrap icons ? </h3>
<br />
<br />
<div class="well span3">
<p>Just put the icons inside the button</p>
<button class="magicBtn icon"><i class="icon-search"></i></button>
<button class="magicBtn icon"><i class="icon-user"></i></button>
</div>
</div>
<div class="span7">
<br />
<br />
<pre class="prettyprint linenums">&lt;button class=&quot;magicBtn icon&quot;&gt;&lt;i class=&quot;icon-search&quot;&gt;&lt;/i&gt;&lt;/button&gt;<br/>&lt;button class=&quot;magicBtn icon&quot;&gt;&lt;i class=&quot;icon-user&quot;&gt;&lt;/i&gt;&lt;/button&gt;<br/></pre>
<pre class="prettyprint linenums">$('.icon').magicBtn({hover: true, alignement: 'top'});<br/>$('.icon').magicBtn('show');</pre>
</div>
</div>
<div class="row">
<br />
<div class="span10">
<h3 id="methods">Methods</h3>
<h4>$().magicBtn('show')</h4>
<p>Shows the buttons found by selector</p>
<br />
<br />
<h4>$().magicBtn('hide')</h4>
<p>Hides the buttons found by selector</p>
<br />
<br />
<h4>$().magicBtn('toggle')</h4>
<p>Activates toggle state</p>
<div class="alert alert-info">
<p>You can enable auto toggling of a button by using <code>data-toggle</code> attribute</p>
</div>
<br />
<br />
<h3>Options</h3>
<br />
<table class="table table-bordered table-striped">
<thead>
<tr>
<th style="width: 100px;">Name</th>
<th style="width: 100px;">type</th>
<th style="width: 50px;">default</th>
<th>description</th>
</tr>
</thead>
<tr>
<td>alignement</td>
<td>string</td>
<td>center</td>
<td>start showing buttons from center, 1 in middle, even on ones top and odd ones on bottom </td>
</tr>
<tr>
<td>betweenSpace</td>
<td>integer</td>
<td>2</td>
<td>space between buttons</td>
</tr>
<tr>
<td>hover</td>
<td>boolean</td>
<td>false</td>
<td>Enables hover effect</td>
</tr>
<tbody>
</tbody>
</table>
</div>
</div>
<footer class="footer">
@ -189,13 +268,16 @@
<script>
google.load("jqueryui", "1.8.17");
</script>
<script src="../js/jquery.hoverIntent.js"></script>
<script src="../js/bootstrap-magic-button.js"></script>
<script src="js/jquery.hoverIntent.js"></script>
<script src="js/bootstrap-magic-button.js"></script>
<script>
$(function () {
$('.hover').magicBtn({hover: true});
$('.hover').magicBtn('show');
$('.icon').magicBtn({hover: true, alignement: 'top'});
$('.icon').magicBtn('show');
$('.well .magicBtn').magicBtn('show');

@ -0,0 +1,208 @@
/* ============================================================
* bootstrap-magic-button.js v1.0
* https://github.com/sp4ke/bootstrap-magic-button
* ============================================================
* Copyright 2012 Chakib Benziane
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Modified work : bootstrap-button.js v2.0.2
* Copyright 2012 Twitter, Inc.
* ============================================================ */!
function ($) {
"use strict"
/* BUTTON PUBLIC CLASS DEFINITION
* ============================== */
var MagicBtn = function (element, options) {
this.$element = $(element)
// The parent Div
this.$parentDiv = $(element).closest('div')
this.$parentHeight = this.$parentDiv.outerHeight()
this.$parentWidth = this.$parentDiv.outerWidth()
this.$parentPosition = this.$parentDiv.position();
this.$parentMarginLeft = this.$parentDiv.css('margin-left')
this.options = $.extend({}, $.fn.magicBtn.defaults, options)
// Store number of buttons on parent div
if (!this.$parentDiv.data('nbMagicBtns')) this.$parentDiv.data('nbMagicBtns', 1)
else this.$parentDiv.data().nbMagicBtns++;
// Store the current button number
this.$currentBtnNb = this.$parentDiv.data('nbMagicBtns')
// store the currunt button size
this.$height = this.$element.outerHeight() + this.options.betweenSpace / 2
this.$width = this.$element.outerWidth()
// current button image and toggle image if there is
this.$imgUrl = 'url("' + this.$element.data('image') + '")'
var toggleimg
if (toggleimg = this.$element.data('toggle-image')) this.$toggleImgUrl = 'url("' + toggleimg + '")'
else this.$toggleImgUrl = this.$imgUrl
this.$isToggled = false
if (this.options.hover) this.addHover()
}
MagicBtn.prototype = {
constructor: MagicBtn
// state is the option recieved from jQuery plugin
,
setState: function (state) {
var d = 'disabled',
$el = this.$element,
data = $el.data(),
val = $el.is('input') ? 'val' : 'html'
state = state + 'Text'
data.resetText || $el.data('resetText', $el[val]())
$el[val](data[state] || this.options[state])
// push to event loop to allow forms to submit
setTimeout(function () {
state == 'loadingText' ? $el.addClass(d).attr(d, d) : $el.removeClass(d).removeAttr(d)
}, 0)
}
,
calculatePosition: function (direction) {
var space = (this.$currentBtnNb === 1) ? 0 : this.options.betweenSpace
var left = this.$parentPosition.left + this.$parentWidth
switch (this.options.alignement) {
case 'top':
this.$top = (
(this.$currentBtnNb * this.$height) - this.$height + this.$parentPosition.top + (space * (this.$currentBtnNb - 1)))
break;
case 'center':
if (this.$currentBtnNb === 1) {
this.$top = (
(this.$parentHeight / 2) - (this.$height / 2) + this.$parentPosition.top)
this.$parentDiv.data('top-space', (this.$parentHeight / 2 - (this.$height / 2)))
this.$parentDiv.data('bottom-space', (this.$parentHeight / 2 - (this.$height / 2)))
} else if (this.$currentBtnNb % 2 === 0) {
this.$top = (
this.$parentDiv.data('top-space') - this.$height + this.$parentPosition.top)
this.$parentDiv.data('top-space', this.$parentDiv.data('top-space') - this.$height)
} else {
this.$top = (
this.$parentHeight - this.$parentDiv.data('bottom-space') + this.$parentPosition.top)
this.$parentDiv.data('bottom-space', this.$parentDiv.data('bottom-space') - this.$height)
}
break;
}
this.$left = this.$parentPosition.left + this.$parentWidth + parseInt(this.$parentMarginLeft)
}
,
show: function () {
var $o = this.options
this.$element.css({
top: this.$top,
left: this.$left,
'background-image': (this.$isToggled) ? this.$toggleImgUrl : this.$imgUrl
}).show()
}
,
hide: function () {
this.$element.hide()
}
,
toggle: function () {
var $el = this.$element
if (!this.$isToggled) {
$el.css('background-image', this.$toggleImgUrl)
this.$isToggled = true
$el.addClass('magicBtn-active')
} else {
$el.css('background-image', this.$imgUrl)
this.$isToggled = false
$el.removeClass('magicBtn-active')
}
}
,
addHover: function () {
var $el = this.$element
var obj = this
var config = {
over: function () {
if (!obj.$isToggled) $(this).toggleClass('magicBtn-active')
},
timeout: 1,
out: function () {
if ((!obj.$isToggled) && (!$el.is(':hover')) && ($el.hasClass('magicBtn-active'))) $(this).toggleClass('magicBtn-active', 100)
}
}
$el.hoverIntent(config)
}
}
/* BUTTON PLUGIN DEFINITION
* ======================== */
$.fn.magicBtn = function (option) {
return this.each(function () {
var $this = $(this),
data = $this.data('magicBtn'),
options = typeof option == 'object' && option
if (!data) $this.data('magicBtn', (data = new MagicBtn(this, options)))
data.calculatePosition('right')
if (option == 'toggle') data.toggle()
if (option == 'show') data.show()
if (option == 'hide') data.hide()
else if (option) data.setState(option)
})
}
$.fn.magicBtn.defaults = {
direction: 'right',
betweenSpace: 2,
alignement: 'center',
hover: false
}
$.fn.magicBtn.Constructor = MagicBtn
/* BUTTON DATA-API
* =============== */
$(function () {
$('body').on('click.magicBtn.data-api', '[data-toggle^=magicBtn]', function (e) {
var $btn = $(e.target)
if (!$btn.hasClass('magicBtn')) $btn = $btn.closest('.magicBtn')
$btn.magicBtn('toggle')
})
})
}(window.jQuery);

@ -0,0 +1,106 @@
/**
* hoverIntent is similar to jQuery's built-in "hover" function except that
* instead of firing the onMouseOver event immediately, hoverIntent checks
* to see if the user's mouse has slowed down (beneath the sensitivity
* threshold) before firing the onMouseOver event.
*
* hoverIntent r6 // 2011.02.26 // jQuery 1.5.1+
* <http://cherne.net/brian/resources/jquery.hoverIntent.html>
*
* hoverIntent is currently available for use in all personal or commercial
* projects under both MIT and GPL licenses. This means that you can choose
* the license that best suits your project, and use it accordingly.
*
* // basic usage (just like .hover) receives onMouseOver and onMouseOut functions
* $("ul li").hoverIntent( showNav , hideNav );
*
* // advanced usage receives configuration object only
* $("ul li").hoverIntent({
* sensitivity: 7, // number = sensitivity threshold (must be 1 or higher)
* interval: 100, // number = milliseconds of polling interval
* over: showNav, // function = onMouseOver callback (required)
* timeout: 0, // number = milliseconds delay before onMouseOut function call
* out: hideNav // function = onMouseOut callback (required)
* });
*
* @param f onMouseOver function || An object with configuration options
* @param g onMouseOut function || Nothing (use configuration options object)
* @author Brian Cherne brian(at)cherne(dot)net
*/
(function($) {
$.fn.hoverIntent = function(f,g) {
// default configuration options
var cfg = {
sensitivity: 7,
interval: 100,
timeout: 0
};
// override configuration options with user supplied object
cfg = $.extend(cfg, g ? { over: f, out: g } : f );
// instantiate variables
// cX, cY = current X and Y position of mouse, updated by mousemove event
// pX, pY = previous X and Y position of mouse, set by mouseover and polling interval
var cX, cY, pX, pY;
// A private function for getting mouse position
var track = function(ev) {
cX = ev.pageX;
cY = ev.pageY;
};
// A private function for comparing current and previous mouse position
var compare = function(ev,ob) {
ob.hoverIntent_t = clearTimeout(ob.hoverIntent_t);
// compare mouse positions to see if they've crossed the threshold
if ( ( Math.abs(pX-cX) + Math.abs(pY-cY) ) < cfg.sensitivity ) {
$(ob).unbind("mousemove",track);
// set hoverIntent state to true (so mouseOut can be called)
ob.hoverIntent_s = 1;
return cfg.over.apply(ob,[ev]);
} else {
// set previous coordinates for next time
pX = cX; pY = cY;
// use self-calling timeout, guarantees intervals are spaced out properly (avoids JavaScript timer bugs)
ob.hoverIntent_t = setTimeout( function(){compare(ev, ob);} , cfg.interval );
}
};
// A private function for delaying the mouseOut function
var delay = function(ev,ob) {
ob.hoverIntent_t = clearTimeout(ob.hoverIntent_t);
ob.hoverIntent_s = 0;
return cfg.out.apply(ob,[ev]);
};
// A private function for handling mouse 'hovering'
var handleHover = function(e) {
// copy objects to be passed into t (required for event object to be passed in IE)
var ev = jQuery.extend({},e);
var ob = this;
// cancel hoverIntent timer if it exists
if (ob.hoverIntent_t) { ob.hoverIntent_t = clearTimeout(ob.hoverIntent_t); }
// if e.type == "mouseenter"
if (e.type == "mouseenter") {
// set "previous" X and Y position based on initial entry point
pX = ev.pageX; pY = ev.pageY;
// update "current" X and Y position based on mousemove
$(ob).bind("mousemove",track);
// start polling interval (self-calling timeout) to compare mouse coordinates over time
if (ob.hoverIntent_s != 1) { ob.hoverIntent_t = setTimeout( function(){compare(ev,ob);} , cfg.interval );}
// else e.type == "mouseleave"
} else {
// unbind expensive mousemove event
$(ob).unbind("mousemove",track);
// if hoverIntent state is true, then call the mouseOut function after the specified delay
if (ob.hoverIntent_s == 1) { ob.hoverIntent_t = setTimeout( function(){delay(ev,ob);} , cfg.timeout );}
}
};
// bind the function to the two event listeners
return this.bind('mouseenter',handleHover).bind('mouseleave',handleHover);
};
})(jQuery);
Loading…
Cancel
Save