せっかくなので実際にどのような動作をしているのかbootstrap.jsのソースを初めから追ってみました。
※調査バージョンは2.3.1のuncompressed版です。
前書き
Bootstrapは各機能毎のplugin版も用意されてますが今回はcompiledを追っています。対象機能は下記となっています。
・CSS TRANSITIONのチェック
・Alert
・BUTTON
・CAROUSEL
・COLLAPSE
・DROPDOWN
・TOOLTIP
・POPOVER
・SCROLLSPY
・TAB
・TYPEAHEAD
・AFFIX
各機能は全て「!function ($) { ～ }(window.jQuery)」と即時関数の形式で記述されています。
またJSHint（JSのコードチェックツール）を採用しており「"use strict"; // jshint ;_;」も全てに記述されています。
CSS TRANSITIONのチェックを除く各機能の構成としては以下となります。
１．機能のクラス宣言およびメソッドの手続き
２．JQueryのPlugin登録およびクラスのインスタンス化
３．noConflictの対応
４．イベント登録
各Pluginでは引数にoptionを用意しており、この値を元に呼び出すクラスメソッドを識別しています。
またイベント登録では"メソッド名.data-api"といった名前空間を指定しておりBootstrapのイベントのみ一括でoffにする事が可能となっています。
ヘッダーコメント
BootstrapはApache License 2.0となっているため配布、修正もOKとなっています。（またsource内にはqunitのコードやphantom.jsも入っているため、修正ファイルを自前のCI環境に組み込むことも容易そうです）
CSS TRANSITIONのチェック
!function ($) {
"use strict"; // jshint ;_;
/* CSS TRANSITION SUPPORT (http://www.modernizr.com/)
* ======================================================= */
$(function () {
$.support.transition = (function () {
var transitionEnd = (function () {
var el = document.createElement('bootstrap')
, transEndEventNames = {
'WebkitTransition' : 'webkitTransitionEnd'
, 'MozTransition' : 'transitionend'
, 'OTransition' : 'oTransitionEnd otransitionend'
, 'transition' : 'transitionend'
}
, name
for (name in transEndEventNames){
if (el.style[name] !== undefined) {
return transEndEventNames[name]
}
}
}())
return transitionEnd && {
end: transitionEnd
}
})()
})
}(window.jQuery)
CSS TRANSITIONのチェックとしては、bootstrapタグをダミー生成して利用中のブラウザのTransition終了イベント名を識別します。識別したイベント名は、$.supportにtransitionというプロパティを追加して、ここに保持します。
Chromeであれば"webkitTransitionEnd"が格納されますが、IE9ではCSS TRANSITIONは利用できないので"undefined"となります。
Alert
/* ALERT CLASS DEFINITION
* ====================== */
var dismiss = '[data-dismiss="alert"]'
, Alert = function (el) {
$(el).on('click', dismiss, this.close)
}
Alert.prototype.close = function (e) {
var $this = $(this)
, selector = $this.attr('data-target')
, $parent
if (!selector) {
selector = $this.attr('href')
selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') //strip for ie7
}
$parent = $(selector)
e && e.preventDefault()
$parent.length || ($parent = $this.hasClass('alert') ? $this : $this.parent())
$parent.trigger(e = $.Event('close'))
if (e.isDefaultPrevented()) return
$parent.removeClass('in')
function removeElement() {
$parent
.trigger('closed')
.remove()
}
$.support.transition && $parent.hasClass('fade') ?
$parent.on($.support.transition.end, removeElement) :
removeElement()
}
/* ALERT PLUGIN DEFINITION
* ======================= */
var old = $.fn.alert
$.fn.alert = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('alert')
if (!data) $this.data('alert', (data = new Alert(this)))
if (typeof option == 'string') data[option].call($this)
})
}
$.fn.alert.Constructor = Alert
/* ALERT NO CONFLICT
* ================= */
$.fn.alert.noConflict = function () {
$.fn.alert = old
return this
}
/* ALERT DATA-API
* ============== */
$(document).on('click.alert.data-api', dismiss, Alert.prototype.close)
Alertクラスを用意しコンストラクタで「×」ボタンクリック時のイベント登録を行っています。登録対象は'[data-dismiss="alert"]'属性を持つ要素が対象となります。 closeメソッドでは「×」ボタン要素に記述されている属性により削除対象を識別します。
処理対象の優先順位としては
・「data-target」に記載されているセレクタ名
・「href」に記載されているセレクタ名
・自分のClass名にAlertがあれば自分
・自分の親element
となっており、もしdiv.Alert内の「×」ボタンをdivタグやpタグで括ってしまうと
Alertメッセージは表示されず「×」ボタンのみ消えることになってしまいます。
その後、イベントの制御（重複実行の防止）などを行い、Alertを消す際の挙動を$.support.transitionと$parent.hasClass('fade')をチェックして消し方を識別しています。
JqueryPluginの作成では$(selector).alert("close")で、アラートが消せるように登録手続きを行っています。
"open"メソッド等はないので自分でprototypeに手続きを記述する必要があります。
BUTTON
/* BUTTON PUBLIC CLASS DEFINITION
* ============================== */
var Button = function (element, options) {
this.$element = $(element)
this.options = $.extend({}, $.fn.button.defaults, options)
}
Button.prototype.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)
}
Button.prototype.toggle = function () {
var $parent = this.$element.closest('[data-toggle="buttons-radio"]')
$parent && $parent
.find('.active')
.removeClass('active')
this.$element.toggleClass('active')
}
/* BUTTON PLUGIN DEFINITION
* ======================== */
var old = $.fn.button
$.fn.button = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('button')
, options = typeof option == 'object' && option
if (!data) $this.data('button', (data = new Button(this, options)))
if (option == 'toggle') data.toggle()
else if (option) data.setState(option)
})
}
$.fn.button.defaults = {
loadingText: 'loading...'
}
$.fn.button.Constructor = Button
/* BUTTON NO CONFLICT
* ================== */
$.fn.button.noConflict = function () {
$.fn.button = old
return this
}
/* BUTTON DATA-API
* =============== */
$(document).on('click.button.data-api', '[data-toggle^=button]', function (e) {
var $btn = $(e.target)
if (!$btn.hasClass('btn')) $btn = $btn.closest('.btn')
$btn.button('toggle')
})
.button()メソッドでは引数が'toggle'の場合は、toggleメソッド、それ以外はsetStateメソッドが呼び出されます。'toggle'以外の指定方法（setStateメソッド）は'loading'、'reset'、またはボタンに表示する文字列オブジェクトです。
オブジェクトを渡した場合は、$.fn.button.defaultsプロパティが引数のオブジェクトで継承（マージ）されます。
例えば以下のように呼び出した場合、プロパティは引数のオブジェクトに置換されます。
$(selector).button({loadingText:"処理中",refreshText:"処理完了"})
ボタンの制御として呼び出す場合、処理内で引数に"Text"を語尾に付加しているので下記の形で呼び出します。
$(selector).button("loading")
$(selector).button("refresh")
この後、$(selector).button("loading")を呼び出すとボタンに"処理中"と表示されdisabel状態となります。$(selector).button("refresh")を呼び出すとdisabelは解除され指定した文言に変更されます。
.buttonメソッドのオブジェクト指定を行わず.("reset")を呼び出せば元の文言に戻ります。
また一度オブジェクトを登録してしまうと次回からは使い回すので動的に変更したい場合は注意が必要です。
'toggle'を指定した場合（toggleメソッド）はselectorに指定したbuttonをActiveにします。
一度初期化してからActiveにしているため、複数指定した場合は最後のButtonがActiveとなります。
CAROUSEL
/* CAROUSEL CLASS DEFINITION
* ========================= */
var Carousel = function (element, options) {
this.$element = $(element)
this.$indicators = this.$element.find('.carousel-indicators')
this.options = options
this.options.pause == 'hover' && this.$element
.on('mouseenter', $.proxy(this.pause, this))
.on('mouseleave', $.proxy(this.cycle, this))
}
Carousel.prototype = {
cycle: function (e) {
if (!e) this.paused = false
if (this.interval) clearInterval(this.interval);
this.options.interval
&& !this.paused
&& (this.interval = setInterval($.proxy(this.next, this), this.options.interval))
return this
}
, getActiveIndex: function () {
this.$active = this.$element.find('.item.active')
this.$items = this.$active.parent().children()
return this.$items.index(this.$active)
}
, to: function (pos) {
var activeIndex = this.getActiveIndex()
, that = this
if (pos > (this.$items.length - 1) || pos < 0) return
if (this.sliding) {
return this.$element.one('slid', function () {
that.to(pos)
})
}
if (activeIndex == pos) {
return this.pause().cycle()
}
return this.slide(pos > activeIndex ? 'next' : 'prev', $(this.$items[pos]))
}
, pause: function (e) {
if (!e) this.paused = true
if (this.$element.find('.next, .prev').length && $.support.transition.end) {
this.$element.trigger($.support.transition.end)
this.cycle(true)
}
clearInterval(this.interval)
this.interval = null
return this
}
, next: function () {
if (this.sliding) return
return this.slide('next')
}
, prev: function () {
if (this.sliding) return
return this.slide('prev')
}
, slide: function (type, next) {
var $active = this.$element.find('.item.active')
, $next = next || $active[type]()
, isCycling = this.interval
, direction = type == 'next' ? 'left' : 'right'
, fallback = type == 'next' ? 'first' : 'last'
, that = this
, e
this.sliding = true
isCycling && this.pause()
$next = $next.length ? $next : this.$element.find('.item')[fallback]()
e = $.Event('slide', {
relatedTarget: $next[0]
, direction: direction
})
if ($next.hasClass('active')) return
if (this.$indicators.length) {
this.$indicators.find('.active').removeClass('active')
this.$element.one('slid', function () {
var $nextIndicator = $(that.$indicators.children()[that.getActiveIndex()])
$nextIndicator && $nextIndicator.addClass('active')
})
}
if ($.support.transition && this.$element.hasClass('slide')) {
this.$element.trigger(e)
if (e.isDefaultPrevented()) return
$next.addClass(type)
$next[0].offsetWidth // force reflow
$active.addClass(direction)
$next.addClass(direction)
this.$element.one($.support.transition.end, function () {
$next.removeClass([type, direction].join(' ')).addClass('active')
$active.removeClass(['active', direction].join(' '))
that.sliding = false
setTimeout(function () { that.$element.trigger('slid') }, 0)
})
} else {
this.$element.trigger(e)
if (e.isDefaultPrevented()) return
$active.removeClass('active')
$next.addClass('active')
this.sliding = false
this.$element.trigger('slid')
}
isCycling && this.cycle()
return this
}
}
/* CAROUSEL PLUGIN DEFINITION
* ========================== */
var old = $.fn.carousel
$.fn.carousel = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('carousel')
, options = $.extend({}, $.fn.carousel.defaults, typeof option == 'object' && option)
, action = typeof option == 'string' ? option : options.slide
if (!data) $this.data('carousel', (data = new Carousel(this, options)))
if (typeof option == 'number') data.to(option)
else if (action) data[action]()
else if (options.interval) data.pause().cycle()
})
}
$.fn.carousel.defaults = {
interval: 5000
, pause: 'hover'
}
$.fn.carousel.Constructor = Carousel
/* CAROUSEL NO CONFLICT
* ==================== */
$.fn.carousel.noConflict = function () {
$.fn.carousel = old
return this
}
/* CAROUSEL DATA-API
* ================= */
$(document).on('click.carousel.data-api', '[data-slide], [data-slide-to]', function (e) {
var $this = $(this), href
, $target = $($this.attr('data-target') || (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '')) //strip for ie7
, options = $.extend({}, $target.data(), $this.data())
, slideIndex
$target.carousel(options)
if (slideIndex = $this.attr('data-slide-to')) {
$target.data('carousel').pause().to(slideIndex).cycle()
}
e.preventDefault()
})
CAROUSELを利用する際は、タグを貼り付けただけではCycleイベントは発生せず、以下のような初期化処理が必要となります。$('.carousel').carousel()
デフォルトでは5秒毎に切り替わりマウスオーバー時はCycleが止まります。Buttonと同様にオブジェクトを引数で渡すことでデフォルトの変更は可能です。
引数に数値を渡すと対象画像を表示します。（画像のIndexを超える値を渡した際は何も起こりません）
'cycle'、'pause'、'prev'、'next'のいずれかを渡せばそれぞれの処理を行い、以外は初期化処理扱いとなります。
Carouselクラス内メソッドは前述の4つ以外に、'getActiveIndex'、'to'、'slide'があります。
基本的に画像切り替えの処理は'slide'で行っており、他は前準備といった処理を行っています。
'cycle'は切り替え処理を開始します。（初期化処理でもこれを呼び出しています）現在の切り替え処理を一度クリアしてintervalに設定している秒数後に'next'処理を呼び出します。
'getActiveIndex'は現在表示中のindex番号を戻します。ただしこちらを外部から利用する際は直接インスタンスクラスから呼び出す必要があるので以下のような形となります。
$('.carousel').data('carousel').getActiveIndex()
'to'は引数のposのIndex画像に切り替えます（初期化処理で数値をパラメータとした際にこれを呼び出しています）表示対象のアイテムを超える数値の場合はそのまま何もせず、表示中のIndexと引数のIndexを判定しスライドの方向を識別します。
またslideから呼び出された場合、再帰処理を行っています。
'pause'はIntervalを初期化して一度ブラウザに制御を戻します。これはマウスポインタが画像内に入った場合にも呼び出されています。
'prev'、'next'は次に移動する画像の方向を引数に'slide'を呼び出しています。
'slide'は'prev'、'next'、'to'のいずれかから呼び出されます。引数のnextは'to'の場合のみ値が入ります。
一度'pause'でIntervalを止め、次に表示する表示画像の判定（最後なら最初に戻す）、Slideイベントの登録、重複呼び出し制御を行います。
その後、画面に表示しているインジケータのActiveを切り替えを行います。実際にここでは切り替えず画像が切り替わった後にActiveを切り替えています。
で、実際の画像切り替えです。CSStransitionが利用できる環境でSlide指定がある場合はアニメーションして切り替えます。
アニメーションはCSStransitionを利用しクラス操作で行っています。（next、leftやrightクラスの追加）
ここでクラスを追加した後、一度ブラウザに処理を戻しクラス削除処理を呼び出して制御を行っています。
COLLAPSE
/* COLLAPSE PUBLIC CLASS DEFINITION
* ================================ */
var Collapse = function (element, options) {
this.$element = $(element)
this.options = $.extend({}, $.fn.collapse.defaults, options)
if (this.options.parent) {
this.$parent = $(this.options.parent)
}
this.options.toggle && this.toggle()
}
Collapse.prototype = {
constructor: Collapse
, dimension: function () {
var hasWidth = this.$element.hasClass('width')
return hasWidth ? 'width' : 'height'
}
, show: function () {
var dimension
, scroll
, actives
, hasData
if (this.transitioning || this.$element.hasClass('in')) return
dimension = this.dimension()
scroll = $.camelCase(['scroll', dimension].join('-'))
actives = this.$parent && this.$parent.find('> .accordion-group > .in')
if (actives && actives.length) {
hasData = actives.data('collapse')
if (hasData && hasData.transitioning) return
actives.collapse('hide')
hasData || actives.data('collapse', null)
}
this.$element[dimension](0)
this.transition('addClass', $.Event('show'), 'shown')
$.support.transition && this.$element[dimension](this.$element[0][scroll])
}
, hide: function () {
var dimension
if (this.transitioning || !this.$element.hasClass('in')) return
dimension = this.dimension()
this.reset(this.$element[dimension]())
this.transition('removeClass', $.Event('hide'), 'hidden')
this.$element[dimension](0)
}
, reset: function (size) {
var dimension = this.dimension()
this.$element
.removeClass('collapse')
[dimension](size || 'auto')
[0].offsetWidth
this.$element[size !== null ? 'addClass' : 'removeClass']('collapse')
return this
}
, transition: function (method, startEvent, completeEvent) {
var that = this
, complete = function () {
if (startEvent.type == 'show') that.reset()
that.transitioning = 0
that.$element.trigger(completeEvent)
}
this.$element.trigger(startEvent)
if (startEvent.isDefaultPrevented()) return
this.transitioning = 1
this.$element[method]('in')
$.support.transition && this.$element.hasClass('collapse') ?
this.$element.one($.support.transition.end, complete) :
complete()
}
, toggle: function () {
this[this.$element.hasClass('in') ? 'hide' : 'show']()
}
}
/* COLLAPSE PLUGIN DEFINITION
* ========================== */
var old = $.fn.collapse
$.fn.collapse = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('collapse')
, options = $.extend({}, $.fn.collapse.defaults, $this.data(), typeof option == 'object' && option)
if (!data) $this.data('collapse', (data = new Collapse(this, options)))
if (typeof option == 'string') data[option]()
})
}
$.fn.collapse.defaults = {
toggle: true
}
$.fn.collapse.Constructor = Collapse
/* COLLAPSE NO CONFLICT
* ==================== */
$.fn.collapse.noConflict = function () {
$.fn.collapse = old
return this
}
/* COLLAPSE DATA-API
* ================= */
$(document).on('click.collapse.data-api', '[data-toggle=collapse]', function (e) {
var $this = $(this), href
, target = $this.attr('data-target')
|| e.preventDefault()
|| (href = $this.attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '') //strip for ie7
, option = $(target).data('collapse') ? 'toggle' : $this.data()
$this[$(target).hasClass('in') ? 'addClass' : 'removeClass']('collapsed')
$(target).collapse(option)
})
対象elementのclassの"in"有無で表示/非表示を切り替えます。流れとしては、toggleを呼び出した際は対象elementの"in"をチェックしてshowメソッド、hideメソッドを呼び出し、show／hideメソッド内ではtransitionメソッドを呼び出して表示/非表示を切り替えます。
showメソッドでは既に"in"が存在する場合または表示切替中の場合は処理を終了します。
（表示切替中についてtransitionメソッドではブラウザのtransitionEndイベントを利用して表示/非表示を切り替える為、瞬間的なタイムラグが発生します）
表示サイズの抽出後、同一階層内の現在表示しているelementのhide処理を行います。
（表示サイズではclass内に"width"の指定がある場合、横幅を抽出するのですが利用用途がよく分かりませんでした。レスポンシブ対応でしょうか。。）
表示時はtransitionメソッド側で"in"を付加して、CSStransitionの判定で表示方法を識別しています。
"shown"イベントを作っておけば最後にTriggerでコールされるので表示時のイベントも対応可能となっています。
またイベント登録側の処理で、heading側のElementに"collapsed"といったクラスを追加しており現在Activeとなっているelementも扱いやすくなっています。
DROPDOWN
/* DROPDOWN CLASS DEFINITION
* ========================= */
var toggle = '[data-toggle=dropdown]'
, Dropdown = function (element) {
var $el = $(element).on('click.dropdown.data-api', this.toggle)
$('html').on('click.dropdown.data-api', function () {
$el.parent().removeClass('open')
})
}
Dropdown.prototype = {
constructor: Dropdown
, toggle: function (e) {
var $this = $(this)
, $parent
, isActive
if ($this.is('.disabled, :disabled')) return
$parent = getParent($this)
isActive = $parent.hasClass('open')
clearMenus()
if (!isActive) {
$parent.toggleClass('open')
}
$this.focus()
return false
}
, keydown: function (e) {
var $this
, $items
, $active
, $parent
, isActive
, index
if (!/(38|40|27)/.test(e.keyCode)) return
$this = $(this)
e.preventDefault()
e.stopPropagation()
if ($this.is('.disabled, :disabled')) return
$parent = getParent($this)
isActive = $parent.hasClass('open')
if (!isActive || (isActive && e.keyCode == 27)) {
if (e.which == 27) $parent.find(toggle).focus()
return $this.click()
}
$items = $('[role=menu] li:not(.divider):visible a', $parent)
if (!$items.length) return
index = $items.index($items.filter(':focus'))
if (e.keyCode == 38 && index > 0) index-- // up
if (e.keyCode == 40 && index < $items.length - 1) index++ // down
if (!~index) index = 0
$items
.eq(index)
.focus()
}
}
function clearMenus() {
$(toggle).each(function () {
getParent($(this)).removeClass('open')
})
}
function getParent($this) {
var selector = $this.attr('data-target')
, $parent
if (!selector) {
selector = $this.attr('href')
selector = selector && /#/.test(selector) && selector.replace(/.*(?=#[^\s]*$)/, '') //strip for ie7
}
$parent = selector && $(selector)
if (!$parent || !$parent.length) $parent = $this.parent()
return $parent
}
/* DROPDOWN PLUGIN DEFINITION
* ========================== */
var old = $.fn.dropdown
$.fn.dropdown = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('dropdown')
if (!data) $this.data('dropdown', (data = new Dropdown(this)))
if (typeof option == 'string') data[option].call($this)
})
}
$.fn.dropdown.Constructor = Dropdown
/* DROPDOWN NO CONFLICT
* ==================== */
$.fn.dropdown.noConflict = function () {
$.fn.dropdown = old
return this
}
/* APPLY TO STANDARD DROPDOWN ELEMENTS
* =================================== */
$(document)
.on('click.dropdown.data-api', clearMenus)
.on('click.dropdown.data-api', '.dropdown form', function (e) { e.stopPropagation() })
.on('click.dropdown-menu', function (e) { e.stopPropagation() })
.on('click.dropdown.data-api' , toggle, Dropdown.prototype.toggle)
.on('keydown.dropdown.data-api', toggle + ', [role=menu]' , Dropdown.prototype.keydown)
クラスメソッドは"toggle"と"keydown"の2つとシンプルです。要素に"open"クラス属性を追加することでメニューの表示を行います。クラス生成時にページのクリックイベントに"open"クラス属性を持つ要素の削除処理を行っており表示中のメニューを消しています。
"toggle"メソッドではドロップダウン全ての"open"クラス属性を持つ要素の削除（開いているメニューを全て消す）を行った後、クリックしたドロップダウンのメニューを開きます。
既に開いている場合は"open"クラスの削除で閉じた後、"open"クラスの追加処理は行われません。
ドロップダウンを開いた際は、focus処理を行う事でキーボード操作を可能にしています。
keydownでは38:上カーソル、40:下カーソル、27:ESCボタンのみ制御しています。
ESCボタン押下時はメニューを消す処理が行われ、上下カーソルではdividerを除いたindexを計算して毎回focus処理を行う事でハイライトを実現しています。
MODAL
/* MODAL CLASS DEFINITION
* ====================== */
var Modal = function (element, options) {
this.options = options
this.$element = $(element)
.delegate('[data-dismiss="modal"]', 'click.dismiss.modal', $.proxy(this.hide, this))
this.options.remote && this.$element.find('.modal-body').load(this.options.remote)
}
Modal.prototype = {
constructor: Modal
, toggle: function () {
return this[!this.isShown ? 'show' : 'hide']()
}
, show: function () {
var that = this
, e = $.Event('show')
this.$element.trigger(e)
if (this.isShown || e.isDefaultPrevented()) return
this.isShown = true
this.escape()
this.backdrop(function () {
var transition = $.support.transition && that.$element.hasClass('fade')
if (!that.$element.parent().length) {
that.$element.appendTo(document.body)
}
that.$element.show()
if (transition) {
that.$element[0].offsetWidth // force reflow
}
that.$element
.addClass('in').attr('aria-hidden', false)
that.enforceFocus()
transition ?
that.$element.one($.support.transition.end, function () { that.$element.focus().trigger('shown') }) :
that.$element.focus().trigger('shown')
})
}
, hide: function (e) {
e && e.preventDefault()
var that = this
e = $.Event('hide')
this.$element.trigger(e)
if (!this.isShown || e.isDefaultPrevented()) return
this.isShown = false
this.escape()
$(document).off('focusin.modal')
this.$element
.removeClass('in')
.attr('aria-hidden', true)
$.support.transition && this.$element.hasClass('fade') ?
this.hideWithTransition() :
this.hideModal()
}
, enforceFocus: function () {
var that = this
$(document).on('focusin.modal', function (e) {
if (that.$element[0] !== e.target && !that.$element.has(e.target).length) {
that.$element.focus()
}
})
}
, escape: function () {
var that = this
if (this.isShown && this.options.keyboard) {
this.$element.on('keyup.dismiss.modal', function ( e ) {
e.which == 27 && that.hide()
})
} else if (!this.isShown) {
this.$element.off('keyup.dismiss.modal')
}
}
, hideWithTransition: function () {
var that = this
, timeout = setTimeout(function () {
that.$element.off($.support.transition.end)
that.hideModal()
}, 500)
this.$element.one($.support.transition.end, function () {
clearTimeout(timeout)
that.hideModal()
})
}
, hideModal: function () {
var that = this
this.$element.hide()
this.backdrop(function () {
that.removeBackdrop()
that.$element.trigger('hidden')
})
}
, removeBackdrop: function () {
this.$backdrop && this.$backdrop.remove()
this.$backdrop = null
}
, backdrop: function (callback) {
var that = this
, animate = this.$element.hasClass('fade') ? 'fade' : ''
if (this.isShown && this.options.backdrop) {
var doAnimate = $.support.transition && animate
this.$backdrop = $('<div class="modal-backdrop ' + animate + '" />')
.appendTo(document.body)
this.$backdrop.click(
this.options.backdrop == 'static' ?
$.proxy(this.$element[0].focus, this.$element[0])
: $.proxy(this.hide, this)
)
if (doAnimate) this.$backdrop[0].offsetWidth // force reflow
this.$backdrop.addClass('in')
if (!callback) return
doAnimate ?
this.$backdrop.one($.support.transition.end, callback) :
callback()
} else if (!this.isShown && this.$backdrop) {
this.$backdrop.removeClass('in')
$.support.transition && this.$element.hasClass('fade')?
this.$backdrop.one($.support.transition.end, callback) :
callback()
} else if (callback) {
callback()
}
}
}
/* MODAL PLUGIN DEFINITION
* ======================= */
var old = $.fn.modal
$.fn.modal = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('modal')
, options = $.extend({}, $.fn.modal.defaults, $this.data(), typeof option == 'object' && option)
if (!data) $this.data('modal', (data = new Modal(this, options)))
if (typeof option == 'string') data[option]()
else if (options.show) data.show()
})
}
$.fn.modal.defaults = {
backdrop: true
, keyboard: true
, show: true
}
$.fn.modal.Constructor = Modal
/* MODAL NO CONFLICT
* ================= */
$.fn.modal.noConflict = function () {
$.fn.modal = old
return this
}
/* MODAL DATA-API
* ============== */
$(document).on('click.modal.data-api', '[data-toggle="modal"]', function (e) {
var $this = $(this)
, href = $this.attr('href')
, $target = $($this.attr('data-target') || (href && href.replace(/.*(?=#[^\s]+$)/, ''))) //strip for ie7
, option = $target.data('modal') ? 'toggle' : $.extend({ remote:!/#/.test(href) && href }, $target.data(), $this.data())
e.preventDefault()
$target
.modal(option)
.one('hide', function () {
$this.focus()
})
})
ModalはCOLLAPSEと近い作りとなっています。.modalメソッドの使い方としては、show、hide、toggleメソッドが用意されておりtoggleではisShownプロパティの値を見てshow/hideを呼び出しています。インスタンスプロパティのbackdropには"static"を設定するとモーダル外をクリックしてもモーダルが消えない制御となっています。
keyboardプロパティのfalseはESCキーによる画面消去を制御しており、remoteプロパティにURLをセットした場合、modal表示時にJQueryのload処理を利用してページをmodal-bodyクラス内に作成します。
modalメソッド呼び出し時、上記プロパティを設定した場合でもModal表示処理が動作するため、表示したくない場合はshowプロパティにfalseを設定してパラメータに含めます。
showメソッドでは表示制御を行った後、backdropメソッドを呼び出しModalのオーバーレイ用のdivタグを生成してModal外のクリック制御、offsetWidthの再計算やtransitionの使用有無をチェックして表示方法を識別しています。
backdropメソッド呼び出し時には実際の表示処理をcallbackとして渡しており、hideメソッドから呼び出された場合も利用できるようになっています。
（backdropの処理として集約するためこの形となっているが、処理がほぼ異なっているため個人的には分けてしまってもよいように思えました）
またenforceFocusメソッドを呼び出し、Modal外にfocusが移った場合、Modalにfocusを戻すイベントが登録されています。
hideメソッドでは、showメソッドで作成したオーバーレイの削除、enforceFocusメソッドで登録したイベント解除を行い、transitionの使用有無をチェックしてModal画面を消去しています。
またshown、hiddenイベントの呼び出しも可能です。
TOOLTIP
/* TOOLTIP PUBLIC CLASS DEFINITION
* =============================== */
var Tooltip = function (element, options) {
this.init('tooltip', element, options)
}
Tooltip.prototype = {
constructor: Tooltip
, init: function (type, element, options) {
var eventIn
, eventOut
, triggers
, trigger
, i
this.type = type
this.$element = $(element)
this.options = this.getOptions(options)
this.enabled = true
triggers = this.options.trigger.split(' ')
for (i = triggers.length; i--;) {
trigger = triggers[i]
if (trigger == 'click') {
this.$element.on('click.' + this.type, this.options.selector, $.proxy(this.toggle, this))
} else if (trigger != 'manual') {
eventIn = trigger == 'hover' ? 'mouseenter' : 'focus'
eventOut = trigger == 'hover' ? 'mouseleave' : 'blur'
this.$element.on(eventIn + '.' + this.type, this.options.selector, $.proxy(this.enter, this))
this.$element.on(eventOut + '.' + this.type, this.options.selector, $.proxy(this.leave, this))
}
}
this.options.selector ?
(this._options = $.extend({}, this.options, { trigger: 'manual', selector: '' })) :
this.fixTitle()
}
, getOptions: function (options) {
options = $.extend({}, $.fn[this.type].defaults, this.$element.data(), options)
if (options.delay && typeof options.delay == 'number') {
options.delay = {
show: options.delay
, hide: options.delay
}
}
return options
}
, enter: function (e) {
var defaults = $.fn[this.type].defaults
, options = {}
, self
this._options && $.each(this._options, function (key, value) {
if (defaults[key] != value) options[key] = value
}, this)
self = $(e.currentTarget)[this.type](options).data(this.type)
if (!self.options.delay || !self.options.delay.show) return self.show()
clearTimeout(this.timeout)
self.hoverState = 'in'
this.timeout = setTimeout(function() {
if (self.hoverState == 'in') self.show()
}, self.options.delay.show)
}
, leave: function (e) {
var self = $(e.currentTarget)[this.type](this._options).data(this.type)
if (this.timeout) clearTimeout(this.timeout)
if (!self.options.delay || !self.options.delay.hide) return self.hide()
self.hoverState = 'out'
this.timeout = setTimeout(function() {
if (self.hoverState == 'out') self.hide()
}, self.options.delay.hide)
}
, show: function () {
var $tip
, pos
, actualWidth
, actualHeight
, placement
, tp
, e = $.Event('show')
if (this.hasContent() && this.enabled) {
this.$element.trigger(e)
if (e.isDefaultPrevented()) return
$tip = this.tip()
this.setContent()
if (this.options.animation) {
$tip.addClass('fade')
}
placement = typeof this.options.placement == 'function' ?
this.options.placement.call(this, $tip[0], this.$element[0]) :
this.options.placement
$tip
.detach()
.css({ top: 0, left: 0, display: 'block' })
this.options.container ? $tip.appendTo(this.options.container) : $tip.insertAfter(this.$element)
pos = this.getPosition()
actualWidth = $tip[0].offsetWidth
actualHeight = $tip[0].offsetHeight
switch (placement) {
case 'bottom':
tp = {top: pos.top + pos.height, left: pos.left + pos.width / 2 - actualWidth / 2}
break
case 'top':
tp = {top: pos.top - actualHeight, left: pos.left + pos.width / 2 - actualWidth / 2}
break
case 'left':
tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth}
break
case 'right':
tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width}
break
}
this.applyPlacement(tp, placement)
this.$element.trigger('shown')
}
}
, applyPlacement: function(offset, placement){
var $tip = this.tip()
, width = $tip[0].offsetWidth
, height = $tip[0].offsetHeight
, actualWidth
, actualHeight
, delta
, replace
$tip
.offset(offset)
.addClass(placement)
.addClass('in')
actualWidth = $tip[0].offsetWidth
actualHeight = $tip[0].offsetHeight
if (placement == 'top' && actualHeight != height) {
offset.top = offset.top + height - actualHeight
replace = true
}
if (placement == 'bottom' || placement == 'top') {
delta = 0
if (offset.left < 0){
delta = offset.left * -2
offset.left = 0
$tip.offset(offset)
actualWidth = $tip[0].offsetWidth
actualHeight = $tip[0].offsetHeight
}
this.replaceArrow(delta - width + actualWidth, actualWidth, 'left')
} else {
this.replaceArrow(actualHeight - height, actualHeight, 'top')
}
if (replace) $tip.offset(offset)
}
, replaceArrow: function(delta, dimension, position){
this
.arrow()
.css(position, delta ? (50 * (1 - delta / dimension) + "%") : '')
}
, setContent: function () {
var $tip = this.tip()
, title = this.getTitle()
$tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
$tip.removeClass('fade in top bottom left right')
}
, hide: function () {
var that = this
, $tip = this.tip()
, e = $.Event('hide')
this.$element.trigger(e)
if (e.isDefaultPrevented()) return
$tip.removeClass('in')
function removeWithAnimation() {
var timeout = setTimeout(function () {
$tip.off($.support.transition.end).detach()
}, 500)
$tip.one($.support.transition.end, function () {
clearTimeout(timeout)
$tip.detach()
})
}
$.support.transition && this.$tip.hasClass('fade') ?
removeWithAnimation() :
$tip.detach()
this.$element.trigger('hidden')
return this
}
, fixTitle: function () {
var $e = this.$element
if ($e.attr('title') || typeof($e.attr('data-original-title')) != 'string') {
$e.attr('data-original-title', $e.attr('title') || '').attr('title', '')
}
}
, hasContent: function () {
return this.getTitle()
}
, getPosition: function () {
var el = this.$element[0]
return $.extend({}, (typeof el.getBoundingClientRect == 'function') ? el.getBoundingClientRect() : {
width: el.offsetWidth
, height: el.offsetHeight
}, this.$element.offset())
}
, getTitle: function () {
var title
, $e = this.$element
, o = this.options
title = $e.attr('data-original-title')
|| (typeof o.title == 'function' ? o.title.call($e[0]) : o.title)
return title
}
, tip: function () {
return this.$tip = this.$tip || $(this.options.template)
}
, arrow: function(){
return this.$arrow = this.$arrow || this.tip().find(".tooltip-arrow")
}
, 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
}
, toggle: function (e) {
var self = e ? $(e.currentTarget)[this.type](this._options).data(this.type) : this
self.tip().hasClass('in') ? self.hide() : self.show()
}
, destroy: function () {
this.hide().$element.off('.' + this.type).removeData(this.type)
}
}
/* TOOLTIP PLUGIN DEFINITION
* ========================= */
var old = $.fn.tooltip
$.fn.tooltip = function ( option ) {
return this.each(function () {
var $this = $(this)
, data = $this.data('tooltip')
, options = typeof option == 'object' && option
if (!data) $this.data('tooltip', (data = new Tooltip(this, options)))
if (typeof option == 'string') data[option]()
})
}
$.fn.tooltip.Constructor = Tooltip
$.fn.tooltip.defaults = {
animation: true
, placement: 'top'
, selector: false
, template: ''
, trigger: 'hover focus'
, title: ''
, delay: 0
, html: false
, container: false
}
/* TOOLTIP NO CONFLICT
* =================== */
$.fn.tooltip.noConflict = function () {
$.fn.tooltip = old
return this
}
まずTOOLTIPを利用する際にはTOOLTIP対象のマークアップを記述した後、下記のように初期処理が必要となります。
$(selector).tooltip({selector: "a[data-toggle=tooltip]"})
TOOLTIPさせたいグループをselectorでセットし、さらに対象とするelementをメソッドの引数として渡す必要があります。実際の処理では、引数で指定したセレクタ（ここでは'a[data-toggle=tooltip]'を指す）に対してoption.triggerに設定している値（"hover focus"）を識別し、"mouseenter"や"mouseleave"イベントに"enter"、"leave"メソッドを登録します。
この処理の最後ではoption.triggerに"manual"を設定しています。
hover（またはfocus）時のenterメソッドではコンテキストのelementに対してTooltipクラスのインスタンス化を行います。
コンストラクタの最後でoption.triggerに"manual"を設定したため、イベント登録処理はスキップされます。
enterメソッドでは対象elementのTooltipクラスのインスタンス化後、showメソッドをコールしています。
this.enabledの状態とtitleの設定がある場合は表示処理を行います。
（titleの設定方法としては、各DOMに対して"data-original-title"を指定、全体で同じ文言を指定する場合はtooltipメソッドの引数に{title:"タイトル"}を設定、動的に変更する場合は{title:"function名"}で関数を割り当てることも可能です）
tipメソッド、setContentメソッドを呼び出し、表示するDOMの作成を行いページ内に追加します。
getPositionメソッドを呼び出して対象elementのサイズ、位置を取得し（getBoundingClientRectが利用できないノードの場合はJQueryのoffsetWidth、offsetHeightを使用します）表示位置の計算を行い、applyPlacementメソッドを呼び出し噴出しの位置調整を行い表示を行っています。
leaveメソッドでも対象elementのTooltipクラスのインスタンスを取得して、CSSTransitionの使用有無と表示アニメーションの指定状況を識別し表示中のDOMを消しています。また消し方としてはdetachメソッドを使用しているためTooltipの内容ををHTMLで記述してイベントを登録した場合、このイベントは残るので注意が必要です。
ClickイベントでTooltipを表示する場合はtoggleメソッドを使用しており、表示状況に合わせてshowメソッド、hideメソッドを呼び出しています。
TOOLTIPもshown、hiddenイベントの呼び出しも可能です。
POPOVER
/* POPOVER PUBLIC CLASS DEFINITION
* =============================== */
var Popover = function (element, options) {
this.init('popover', element, options)
}
/* NOTE: POPOVER EXTENDS BOOTSTRAP-TOOLTIP.js
========================================== */
Popover.prototype = $.extend({}, $.fn.tooltip.Constructor.prototype, {
constructor: Popover
, setContent: function () {
var $tip = this.tip()
, title = this.getTitle()
, content = this.getContent()
$tip.find('.popover-title')[this.options.html ? 'html' : 'text'](title)
$tip.find('.popover-content')[this.options.html ? 'html' : 'text'](content)
$tip.removeClass('fade top bottom left right in')
}
, hasContent: function () {
return this.getTitle() || this.getContent()
}
, getContent: function () {
var content
, $e = this.$element
, o = this.options
content = (typeof o.content == 'function' ? o.content.call($e[0]) : o.content)
|| $e.attr('data-content')
return content
}
, tip: function () {
if (!this.$tip) {
this.$tip = $(this.options.template)
}
return this.$tip
}
, destroy: function () {
this.hide().$element.off('.' + this.type).removeData(this.type)
}
})
/* POPOVER PLUGIN DEFINITION
* ======================= */
var old = $.fn.popover
$.fn.popover = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('popover')
, options = typeof option == 'object' && option
if (!data) $this.data('popover', (data = new Popover(this, options)))
if (typeof option == 'string') data[option]()
})
}
$.fn.popover.Constructor = Popover
$.fn.popover.defaults = $.extend({} , $.fn.tooltip.defaults, {
placement: 'right'
, trigger: 'click'
, content: ''
, template: ''
})
/* POPOVER NO CONFLICT
* =================== */
$.fn.popover.noConflict = function () {
$.fn.popover = old
return this
}
TOOLTIPのクリック版です。POPOVERクラスはTOOLTIPクラスを継承した作りになっており、tooltipメソッドを利用するよりも簡単にリッチなポップアップを作成することができます。TOOLTIPとの違いとしてはsetContentメソッドをオーバーライドしており、表示するポップアップにタイトルとコンテンツに分けて表示することができます。（"data-content"属性の内容をコンテンツとして表示）
SCROLLSPY
/* SCROLLSPY CLASS DEFINITION
* ========================== */
function ScrollSpy(element, options) {
var process = $.proxy(this.process, this)
, $element = $(element).is('body') ? $(window) : $(element)
, href
this.options = $.extend({}, $.fn.scrollspy.defaults, options)
this.$scrollElement = $element.on('scroll.scroll-spy.data-api', process)
this.selector = (this.options.target
|| ((href = $(element).attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '')) //strip for ie7
|| '') + ' .nav li > a'
this.$body = $('body')
this.refresh()
this.process()
}
ScrollSpy.prototype = {
constructor: ScrollSpy
, refresh: function () {
var self = this
, $targets
this.offsets = $([])
this.targets = $([])
$targets = this.$body
.find(this.selector)
.map(function () {
var $el = $(this)
, href = $el.data('target') || $el.attr('href')
, $href = /^#\w/.test(href) && $(href)
return ( $href
&& $href.length
&& [[ $href.position().top + (!$.isWindow(self.$scrollElement.get(0)) && self.$scrollElement.scrollTop()), href ]] ) || null
})
.sort(function (a, b) { return a[0] - b[0] })
.each(function () {
self.offsets.push(this[0])
self.targets.push(this[1])
})
}
, process: function () {
var scrollTop = this.$scrollElement.scrollTop() + this.options.offset
, scrollHeight = this.$scrollElement[0].scrollHeight || this.$body[0].scrollHeight
, maxScroll = scrollHeight - this.$scrollElement.height()
, offsets = this.offsets
, targets = this.targets
, activeTarget = this.activeTarget
, i
if (scrollTop >= maxScroll) {
return activeTarget != (i = targets.last()[0])
&& this.activate ( i )
}
for (i = offsets.length; i--;) {
activeTarget != targets[i]
&& scrollTop >= offsets[i]
&& (!offsets[i + 1] || scrollTop <= offsets[i + 1])
&& this.activate( targets[i] )
}
}
, activate: function (target) {
var active
, selector
this.activeTarget = target
$(this.selector)
.parent('.active')
.removeClass('active')
selector = this.selector
+ '[data-target="' + target + '"],'
+ this.selector + '[href="' + target + '"]'
active = $(selector)
.parent('li')
.addClass('active')
if (active.parent('.dropdown-menu').length) {
active = active.closest('li.dropdown').addClass('active')
}
active.trigger('activate')
}
}
/* SCROLLSPY PLUGIN DEFINITION
* =========================== */
var old = $.fn.scrollspy
$.fn.scrollspy = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('scrollspy')
, options = typeof option == 'object' && option
if (!data) $this.data('scrollspy', (data = new ScrollSpy(this, options)))
if (typeof option == 'string') data[option]()
})
}
$.fn.scrollspy.Constructor = ScrollSpy
$.fn.scrollspy.defaults = {
offset: 10
}
/* SCROLLSPY NO CONFLICT
* ===================== */
$.fn.scrollspy.noConflict = function () {
$.fn.scrollspy = old
return this
}
/* SCROLLSPY DATA-API
* ================== */
$(window).on('load', function () {
$('[data-spy="scroll"]').each(function () {
var $spy = $(this)
$spy.scrollspy($spy.data())
})
})
SCROLLSPYは基本的にBootstrapのNavにのみ適用可能です。使用方法としてはSpy対象の属性にdata-spy="scroll"、data-target="対象のNav"をセットして、$('対象のNav').scrollspy()で使用します。
コンストラクタでSpy対象のScrollイベントにprocessメソッドを登録し、Nav内のSpy対象となるaタグセレクタを識別しています。（Navが複数ある場合はoptions.targetに親セレクタを指定する事で対象Navを指定できます）
またRefreshメソッドも呼び出し、各Spyを行うElementのポジション（先頭位置）を算出し、紐付くIDとの配列をoffsets、targetsに格納しています。（配列の順序で整合性を保っています）
processメソッドでは現在のスクロール位置とoffsetsを識別しactivateメソッドを呼び出してNavのActiveを変更しています。
またActive対象がドロップダウンメニューの場合（dropdown-menuクラス）は中のリストもActiveを変更しています。
TAB
/* TAB CLASS DEFINITION
* ==================== */
var Tab = function (element) {
this.element = $(element)
}
Tab.prototype = {
constructor: Tab
, show: function () {
var $this = this.element
, $ul = $this.closest('ul:not(.dropdown-menu)')
, selector = $this.attr('data-target')
, previous
, $target
, e
if (!selector) {
selector = $this.attr('href')
selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') //strip for ie7
}
if ( $this.parent('li').hasClass('active') ) return
previous = $ul.find('.active:last a')[0]
e = $.Event('show', {
relatedTarget: previous
})
$this.trigger(e)
if (e.isDefaultPrevented()) return
$target = $(selector)
this.activate($this.parent('li'), $ul)
this.activate($target, $target.parent(), function () {
$this.trigger({
type: 'shown'
, relatedTarget: previous
})
})
}
, activate: function ( element, container, callback) {
var $active = container.find('> .active')
, transition = callback
&& $.support.transition
&& $active.hasClass('fade')
function next() {
$active
.removeClass('active')
.find('> .dropdown-menu > .active')
.removeClass('active')
element.addClass('active')
if (transition) {
element[0].offsetWidth // reflow for transition
element.addClass('in')
} else {
element.removeClass('fade')
}
if ( element.parent('.dropdown-menu') ) {
element.closest('li.dropdown').addClass('active')
}
callback && callback()
}
transition ?
$active.one($.support.transition.end, next) :
next()
$active.removeClass('in')
}
}
/* TAB PLUGIN DEFINITION
* ===================== */
var old = $.fn.tab
$.fn.tab = function ( option ) {
return this.each(function () {
var $this = $(this)
, data = $this.data('tab')
if (!data) $this.data('tab', (data = new Tab(this)))
if (typeof option == 'string') data[option]()
})
}
$.fn.tab.Constructor = Tab
/* TAB NO CONFLICT
* =============== */
$.fn.tab.noConflict = function () {
$.fn.tab = old
return this
}
/* TAB DATA-API
* ============ */
$(document).on('click.tab.data-api', '[data-toggle="tab"], [data-toggle="pill"]', function (e) {
e.preventDefault()
$(this).tab('show')
})
TABクラスはシンプルな作りとなっており、showメソッドと中から呼び出されるactivateメソッドの2つで構成されています。タブメニューには[data-toggle="tab"]または[data-toggle="pill"]を付加することでshowイベントの対象となっていますが、リファレンスに記載のように他の要素にもセレクタを指定しイベント登録する事で動作します。（内部メソッドでこのdata-toggle属性を使用していないため）
$('#myTab a').click(function (e) {
e.preventDefault();
$(this).tab('show');
})
sampleではタブメニューのli要素の中はa要素となっており、showメソッドではhref属性の値を使用していますが、'data-target'属性に値があればこちらを優先します。これによりタブメニューはa要素だけでなくbutton等でも利用することが可能です。
ドロップダウンを選択した場合、タブメニューをActiveとした後、メニューリスト内をActiveに刷る流れとなっています。
showメソッド内ではactivateメソッドが2回呼び出されており1回目ではタブメニューの切り替えを行い、2回目ではコンテンツの切り替えを行っています。
タブメニューは即時切り替えを行い、コンテンツの方はアニメーション表示をするためこの形となっています。
TYPEAHEAD
/* TYPEAHEAD PUBLIC CLASS DEFINITION
* ================================= */
var Typeahead = function (element, options) {
this.$element = $(element)
this.options = $.extend({}, $.fn.typeahead.defaults, options)
this.matcher = this.options.matcher || this.matcher
this.sorter = this.options.sorter || this.sorter
this.highlighter = this.options.highlighter || this.highlighter
this.updater = this.options.updater || this.updater
this.source = this.options.source
this.$menu = $(this.options.menu)
this.shown = false
this.listen()
}
Typeahead.prototype = {
constructor: Typeahead
, select: function () {
var val = this.$menu.find('.active').attr('data-value')
this.$element
.val(this.updater(val))
.change()
return this.hide()
}
, updater: function (item) {
return item
}
, show: function () {
var pos = $.extend({}, this.$element.position(), {
height: this.$element[0].offsetHeight
})
this.$menu
.insertAfter(this.$element)
.css({
top: pos.top + pos.height
, left: pos.left
})
.show()
this.shown = true
return this
}
, hide: function () {
this.$menu.hide()
this.shown = false
return this
}
, lookup: function (event) {
var items
this.query = this.$element.val()
if (!this.query || this.query.length < this.options.minLength) {
return this.shown ? this.hide() : this
}
items = $.isFunction(this.source) ? this.source(this.query, $.proxy(this.process, this)) : this.source
return items ? this.process(items) : this
}
, process: function (items) {
var that = this
items = $.grep(items, function (item) {
return that.matcher(item)
})
items = this.sorter(items)
if (!items.length) {
return this.shown ? this.hide() : this
}
return this.render(items.slice(0, this.options.items)).show()
}
, matcher: function (item) {
return ~item.toLowerCase().indexOf(this.query.toLowerCase())
}
, sorter: function (items) {
var beginswith = []
, caseSensitive = []
, caseInsensitive = []
, item
while (item = items.shift()) {
if (!item.toLowerCase().indexOf(this.query.toLowerCase())) beginswith.push(item)
else if (~item.indexOf(this.query)) caseSensitive.push(item)
else caseInsensitive.push(item)
}
return beginswith.concat(caseSensitive, caseInsensitive)
}
, highlighter: function (item) {
var query = this.query.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g, '\\$&')
return item.replace(new RegExp('(' + query + ')', 'ig'), function ($1, match) {
return '' + match + ''
})
}
, render: function (items) {
var that = this
items = $(items).map(function (i, item) {
i = $(that.options.item).attr('data-value', item)
i.find('a').html(that.highlighter(item))
return i[0]
})
items.first().addClass('active')
this.$menu.html(items)
return this
}
, next: function (event) {
var active = this.$menu.find('.active').removeClass('active')
, next = active.next()
if (!next.length) {
next = $(this.$menu.find('li')[0])
}
next.addClass('active')
}
, prev: function (event) {
var active = this.$menu.find('.active').removeClass('active')
, prev = active.prev()
if (!prev.length) {
prev = this.$menu.find('li').last()
}
prev.addClass('active')
}
, listen: function () {
this.$element
.on('focus', $.proxy(this.focus, this))
.on('blur', $.proxy(this.blur, this))
.on('keypress', $.proxy(this.keypress, this))
.on('keyup', $.proxy(this.keyup, this))
if (this.eventSupported('keydown')) {
this.$element.on('keydown', $.proxy(this.keydown, this))
}
this.$menu
.on('click', $.proxy(this.click, this))
.on('mouseenter', 'li', $.proxy(this.mouseenter, this))
.on('mouseleave', 'li', $.proxy(this.mouseleave, this))
}
, eventSupported: function(eventName) {
var isSupported = eventName in this.$element
if (!isSupported) {
this.$element.setAttribute(eventName, 'return;')
isSupported = typeof this.$element[eventName] === 'function'
}
return isSupported
}
, move: function (e) {
if (!this.shown) return
switch(e.keyCode) {
case 9: // tab
case 13: // enter
case 27: // escape
e.preventDefault()
break
case 38: // up arrow
e.preventDefault()
this.prev()
break
case 40: // down arrow
e.preventDefault()
this.next()
break
}
e.stopPropagation()
}
, keydown: function (e) {
this.suppressKeyPressRepeat = ~$.inArray(e.keyCode, [40,38,9,13,27])
this.move(e)
}
, keypress: function (e) {
if (this.suppressKeyPressRepeat) return
this.move(e)
}
, keyup: function (e) {
switch(e.keyCode) {
case 40: // down arrow
case 38: // up arrow
case 16: // shift
case 17: // ctrl
case 18: // alt
break
case 9: // tab
case 13: // enter
if (!this.shown) return
this.select()
break
case 27: // escape
if (!this.shown) return
this.hide()
break
default:
this.lookup()
}
e.stopPropagation()
e.preventDefault()
}
, focus: function (e) {
this.focused = true
}
, blur: function (e) {
this.focused = false
if (!this.mousedover && this.shown) this.hide()
}
, click: function (e) {
e.stopPropagation()
e.preventDefault()
this.select()
this.$element.focus()
}
, mouseenter: function (e) {
this.mousedover = true
this.$menu.find('.active').removeClass('active')
$(e.currentTarget).addClass('active')
}
, mouseleave: function (e) {
this.mousedover = false
if (!this.focused && this.shown) this.hide()
}
}
/* TYPEAHEAD PLUGIN DEFINITION
* =========================== */
var old = $.fn.typeahead
$.fn.typeahead = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('typeahead')
, options = typeof option == 'object' && option
if (!data) $this.data('typeahead', (data = new Typeahead(this, options)))
if (typeof option == 'string') data[option]()
})
}
$.fn.typeahead.defaults = {
source: []
, items: 8
, menu: ''
, item: 'TYPEAHEADクラスはメソッドが多いので簡単に流れを以下に記述します。
・初期化処理
listen → eventSupported・フォーカス
focus・キー入力（候補一覧の表示）
keydown → move → keypress → move →keyup → lookup → process → matcher →
sorter → render → highlighter → show
・マウスによる候補指定（候補一覧から選択）
mouseenter → blur → click → select →updater → hide → focus → mouseleave
・キー操作による候補指定（候補一覧から下キー押下後、Enter押下）
keydown → move → next → keyup →keydown → move → keyup → select → updater → hide
listenメソッドでは各キー操作やマウス操作のイベント登録を行います。
メソッド内でeventSupportedメソッドを呼び出し'keydown'イベントが使用可能ならばイベント登録を行います。
focusメソッドでは現在focus中を意味するfocusedフラグをtrueとします。
keydown、keypressメソッドではmoveメソッドを呼び出しtab、enter、esc、上下キーのブラウザデフォルト動作を制御します。また上下キーではそれぞれprevメソッド、nextメソッドを呼び出しています。
keyupメソッドでは通常はlookupメソッドを呼び出し、tab、enterキーは候補の選択（一覧表示中のみ）、escで一覧の非表示、shift、alt、ctrl、上下キーは処理なしとなります。
lookupメソッドではminLengthに指定した文字数以上であれば一覧表示処理を行います。sourceに指定したデータを取り出しprocessメソッドに渡します。またsourceは関数指定も可能となっており第1引数に入力値、第2引数にcallbackとしてprocessメソッドが渡されます。（サーバデータを使用するサジェスト機能を作成する場合はこちらを利用する事で実現可能です）
表示項目（source）がない場合はここで処理終了となります。
processメソッドではmatcherメソッドを呼び出し一覧に表示する項目を識別しsorterメソッドで頭文字が一致する項目を先に表示するよう順序を入れ替えます。この際一度小文字にしてから判定するため大小文字の区別なく表示対象となります。
その後、renderメソッドが呼び出され実際の一覧部品を作成します。一覧項目にはdata-value属性に値をセットした後、highlighterメソッドを呼び出して入力した文字列部分をstrongタグで括って強調しています。また先頭項目をActiveにしています。
最後にshowメソッドを呼び出して、入力部品の位置にあわせて一覧の表示を行っています。
mouseenterメソッドではカーソル上の項目をActiveとして、mouseleaveメソッドでは一覧の非表示を行います。
clickメソッドはブラウザデフォルト動作を制御した後、selectメソッドを呼び出し、activeとなっている一覧項目のdata-value属性をupdaterメソッド経由で入力項目にセットします。
AFFIX
/* AFFIX CLASS DEFINITION
* ====================== */
var Affix = function (element, options) {
this.options = $.extend({}, $.fn.affix.defaults, options)
this.$window = $(window)
.on('scroll.affix.data-api', $.proxy(this.checkPosition, this))
.on('click.affix.data-api', $.proxy(function () { setTimeout($.proxy(this.checkPosition, this), 1) }, this))
this.$element = $(element)
this.checkPosition()
}
Affix.prototype.checkPosition = function () {
if (!this.$element.is(':visible')) return
var scrollHeight = $(document).height()
, scrollTop = this.$window.scrollTop()
, position = this.$element.offset()
, offset = this.options.offset
, offsetBottom = offset.bottom
, offsetTop = offset.top
, reset = 'affix affix-top affix-bottom'
, affix
if (typeof offset != 'object') offsetBottom = offsetTop = offset
if (typeof offsetTop == 'function') offsetTop = offset.top()
if (typeof offsetBottom == 'function') offsetBottom = offset.bottom()
affix = this.unpin != null && (scrollTop + this.unpin <= position.top) ?
false : offsetBottom != null && (position.top + this.$element.height() >= scrollHeight - offsetBottom) ?
'bottom' : offsetTop != null && scrollTop <= offsetTop ?
'top' : false
if (this.affixed === affix) return
this.affixed = affix
this.unpin = affix == 'bottom' ? position.top - scrollTop : null
this.$element.removeClass(reset).addClass('affix' + (affix ? '-' + affix : ''))
}
/* AFFIX PLUGIN DEFINITION
* ======================= */
var old = $.fn.affix
$.fn.affix = function (option) {
return this.each(function () {
var $this = $(this)
, data = $this.data('affix')
, options = typeof option == 'object' && option
if (!data) $this.data('affix', (data = new Affix(this, options)))
if (typeof option == 'string') data[option]()
})
}
$.fn.affix.Constructor = Affix
$.fn.affix.defaults = {
offset: 0
}
/* AFFIX NO CONFLICT
* ================= */
$.fn.affix.noConflict = function () {
$.fn.affix = old
return this
}
/* AFFIX DATA-API
* ============== */
$(window).on('load', function () {
$('[data-spy="affix"]').each(function () {
var $spy = $(this)
, data = $spy.data()
data.offset = data.offset || {}
data.offsetBottom && (data.offset.bottom = data.offsetBottom)
data.offsetTop && (data.offset.top = data.offsetTop)
$spy.affix(data)
})
})
AFFIXは画面のスクロールに追従して、固定位置に要素を表示することが簡単に作成できます。対象要素に対して、画面スクロール時およびクリック時にcheckPositionメソッドを呼び出して位置操作を行います。
パラメータとしてoffsetが用意されており、数値を指定すると上下同じ位置内のスクロールが適用対象となります。(高さが1000pxのページで200を指定した場合、200～800までのスクロールをを追従)
またoffset.top、offset.bottomと別々に値をセットすることも可能となっており、関数を指定し動的に変更することも可能です。
対象要素にはaffix、affix-top、affix-bottomのクラス属性操作で追従を実現しておりaffixクラスがposition:fixedとなっています。スクロール中、追従している対象要素が一番上まできた場合はaffix-topクラスに書き換え、一番下ならばaffix-bottomクラスとなり追従をやめます。
また画面ロード時に'[data-spy="affix"]'属性を持つ要素に対して自動的にAFFIX対象のとしています。
一通りBootstrap.jsを読み終えて、多機能ながら各種ケースも考慮されており今後も重宝しそうです。
ただソースコード自体は、クラスメソッドが機能毎に細分化され過ぎに感じ、自分としてはもう少しまとまってる方が好みです。
Bootstrapのページからsourceをダウンロードするとlessファイル、qunitコードやphantom.jsも同梱されているので、その内CSS側、テストロジックも眺めてみたいと思います。
0 件のコメント:
コメントを投稿