Bootstrap 是最受歡迎的 HTML、CSS 與 JS 框架,用於開發響應式、行動裝置優先的 WEB 專案。
它因為支援響應式版面、元件化開發與易學易用,成為前端開發的常客;而它的響應式設計、元件拆分與 JavaScript 外掛開發方式,本身就很值得研究。
源碼取得
建議直接到 GitHub 下載最新最完整的源碼。GitHub 是 Bootstrap 的源碼託管倉庫,除了源碼還包含使用文檔的源檔,因此在無網路環境下也能編譯文檔,在本機瀏覽。
源碼目錄
bootstrap 源碼目錄包含:
•文檔部署程式碼子目錄 _gh_pages/
•文檔源碼子目錄 docs/
•bootstrap 部署程式碼子目錄 dist/
•bootstrap 腳本子目錄 js/
•bootstrap 樣式子目錄 less/
•bootstrap 字體子目錄 fonts/
•grunt 建置工具腳本子目錄 grunt/
•包管理器 nuget 子目錄 nuget/
•以及許多設定檔
切入點
直接從「作者怎麼開發這個框架」的角度去讀,門檻太高。可以先把問題簡化:暫時不管它如何建置與部署,只關注它實際運作的原理,也就是 HTML、CSS/LESS 與 JS 三個部分。
接著用分治思路,把整個框架拆成一個個元件,以元件為切入點理解其工作原理,再逐步拼回整體。
元件分析:下拉選單 dropdown
HTML 程式碼
<!-- 元件:下拉選單 --> <div class="dropdown"> <!-- 觸發按鈕 --> <button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown"> Dropdown <span class="caret"></span> </button> <!-- 下拉選單 --> <ul class="dropdown-menu"> <li><a href="#">Action</a></li> <li><a href="#">Another action</a></li> <li><a href="#">Something else here</a></li> </ul> </div>
注意:這裡移除了源碼中的 aria-* 無障礙屬性以便分析,實際應用中不可省略。
CSS 程式碼
// 下拉箭頭
.caret {
display: inline-block;
width: 0;
height: 0;
margin-left: 2px;
vertical-align: middle;
border-top: @caret-width-base dashed;
border-right: @caret-width-base solid transparent;
border-left: @caret-width-base solid transparent;
}
// 下拉選單的容器:父元素相對定位
.dropup, .dropdown { position: relative; }
.dropdown-toggle:focus { outline: 0; }
// 下拉選單本體:子元素絕對定位
.dropdown-menu {
position: absolute;
top: 100%; /* 緊貼父元素下緣 */
left: 0;
z-index: @zindex-dropdown;
display: none; /* 預設隱藏,觸發時改為 block */
float: left;
min-width: 160px;
padding: 5px 0;
margin: 2px 0 0;
list-style: none;
font-size: @font-size-base;
text-align: left;
background-color: @dropdown-bg;
border: 1px solid @dropdown-border;
border-radius: @border-radius-base;
.box-shadow(0 6px 12px rgba(0,0,0,.175));
background-clip: padding-box;
&.pull-right { right: 0; left: auto; }
.divider { .nav-divider(@dropdown-divider-bg); }
> li > a {
display: block;
padding: 3px 20px;
clear: both;
font-weight: normal;
line-height: @line-height-base;
color: @dropdown-link-color;
white-space: nowrap; /* 防止連結換行 */
}
}
// 游標移入/聚焦狀態
.dropdown-menu > li > a {
&:hover, &:focus {
text-decoration: none;
color: @dropdown-link-hover-color;
background-color: @dropdown-link-hover-bg;
}
}
// 選取狀態
.dropdown-menu > .active > a {
&, &:hover, &:focus {
color: @dropdown-link-active-color;
text-decoration: none;
outline: 0;
background-color: @dropdown-link-active-bg;
}
}
// 顯示下拉選單的關鍵
.open {
> .dropdown-menu { display: block; }
> a { outline: 0; }
}
.dropdown-menu-right { left: auto; right: 0; }
.dropdown-menu-left { left: 0; right: auto; }
.dropdown-header {
display: block;
padding: 3px 20px;
font-size: @font-size-small;
line-height: @line-height-base;
color: @dropdown-header-color;
white-space: nowrap;
}
// 覆蓋非下拉選單區域的透明層
.dropdown-backdrop {
position: fixed;
left: 0; right: 0; bottom: 0; top: 0;
z-index: (@zindex-dropdown - 10); /* 確保點擊選單本身時不會關閉 */
}
.pull-right > .dropdown-menu { right: 0; left: auto; }
// 向上彈出的版本
.dropup, .navbar-fixed-bottom .dropdown {
.caret { border-top: 0; border-bottom: @caret-width-base solid; }
.dropdown-menu { top: auto; bottom: 100%; margin-bottom: 2px; }
}
這個元件的行為是:點擊觸發按鈕時在下方展開選單,點擊非選單區域時收起。
實作原理
1.初始狀態只顯示觸發按鈕,.dropdown 未帶 .open,.dropdown-menu 的 display 為 none。
2.點擊觸發按鈕後,.dropdown 被加上 .open 類;而 .open > .dropdown-menu 的 display 為 block,於是選單出現。換句話說,增刪 .open 類就等同於顯示/隱藏。
3.點擊非選單區域時移除 .open 類。所謂「非選單區域」的實作方式是鋪滿整個視窗、固定定位、z-index 比選單低一層的透明遮罩,這樣點到選單本身時事件不會落到遮罩上。
JavaScript 程式碼
/* Bootstrap: dropdown.js v3.3.6 */
+ function ($) {
'use strict';
// DROPDOWN CLASS DEFINITION
var backdrop = '.dropdown-backdrop'
var toggle = '[data-toggle="dropdown"]'
var Dropdown = function (element) {
$(element).on('click.bs.dropdown', this.toggle)
}
Dropdown.VERSION = '3.3.6'
function getParent($this) {
var selector = $this.attr('data-target')
if (!selector) {
selector = $this.attr('href')
selector = selector && /#[A-Za-z]/.test(selector) && selector.replace(/.*(?=#[^\s]*$)/, '') // strip for ie7
}
var $parent = selector && $(selector)
return $parent && $parent.length ? $parent : $this.parent()
}
function clearMenus(e) {
if (e && e.which === 3) return
$(backdrop).remove()
$(toggle).each(function () {
var $this = $(this)
var $parent = getParent($this)
var relatedTarget = { relatedTarget: this }
if (!$parent.hasClass('open')) return
if (e && e.type == 'click' && /input|textarea/i.test(e.target.tagName) && $.contains($parent[0], e.target)) return
$parent.trigger(e = $.Event('hide.bs.dropdown', relatedTarget))
if (e.isDefaultPrevented()) return
$this.attr('aria-expanded', 'false')
$parent.removeClass('open').trigger($.Event('hidden.bs.dropdown', relatedTarget))
})
}
Dropdown.prototype.toggle = function (e) {
var $this = $(this)
if ($this.is('.disabled, :disabled')) return
var $parent = getParent($this)
var isActive = $parent.hasClass('open')
clearMenus()
if (!isActive) {
if ('ontouchstart' in document.documentElement && !$parent.closest('.navbar-nav').length) {
// 行動裝置用遮罩層,因為 click 事件無法 delegate
$(document.createElement('div'))
.addClass('dropdown-backdrop')
.insertAfter($(this))
.on('click', clearMenus)
}
var relatedTarget = { relatedTarget: this }
$parent.trigger(e = $.Event('show.bs.dropdown', relatedTarget))
if (e.isDefaultPrevented()) return
$this.trigger('focus').attr('aria-expanded', 'true')
$parent.toggleClass('open').trigger($.Event('shown.bs.dropdown', relatedTarget))
}
return false
}
Dropdown.prototype.keydown = function (e) {
if (!/(38|40|27|32)/.test(e.which) || /input|textarea/i.test(e.target.tagName)) return
var $this = $(this)
e.preventDefault()
e.stopPropagation()
if ($this.is('.disabled, :disabled')) return
var $parent = getParent($this)
var isActive = $parent.hasClass('open')
if (!isActive && e.which != 27 || isActive && e.which == 27) {
if (e.which == 27) $parent.find(toggle).trigger('focus')
return $this.trigger('click')
}
var desc = ' li:not(.disabled):visible a'
var $items = $parent.find('.dropdown-menu' + desc)
if (!$items.length) return
var index = $items.index(e.target)
if (e.which == 38 && index > 0) index-- // up
if (e.which == 40 && index < $items.length - 1) index++ // down
if (!~index) index = 0
$items.eq(index).trigger('focus')
}
// DROPDOWN PLUGIN DEFINITION
function Plugin(option) {
return this.each(function () {
var $this = $(this)
var data = $this.data('bs.dropdown')
if (!data) $this.data('bs.dropdown', (data = new Dropdown(this)))
if (typeof option == 'string') data[option].call($this)
})
}
var old = $.fn.dropdown
$.fn.dropdown = Plugin
$.fn.dropdown.Constructor = Dropdown
// NO CONFLICT
$.fn.dropdown.noConflict = function () {
$.fn.dropdown = old
return this
}
// APPLY TO STANDARD DROPDOWN ELEMENTS
$(document)
.on('click.bs.dropdown.data-api', clearMenus)
.on('click.bs.dropdown.data-api', '.dropdown form', function (e) { e.stopPropagation() })
.on('click.bs.dropdown.data-api', toggle, Dropdown.prototype.toggle)
.on('keydown.bs.dropdown.data-api', toggle, Dropdown.prototype.keydown)
.on('keydown.bs.dropdown.data-api', '.dropdown-menu', Dropdown.prototype.keydown)
}(jQuery);
整份程式碼可分為四個區塊:
1.類定義(1-125 行)
2.外掛定義(126-144 行)
3.解決衝突(148-153 行)
4.套用到標準下拉選單元素(155-166 行)
從這個小元件就能看出 Bootstrap 的幾個慣例:事件命名空間(.bs.dropdown)讓外掛可以安全共存與解除;每個元件掛在 $.fn 上並提供 noConflict 以避開命名衝突;狀態全部用 CSS 類(.open)表達,JS 只負責切換類名;最後透過 data-api 做事件 delegation,讓元件自動生效而無需手動初始化。理解了這套模式,其餘元件(modal、tooltip、tab)的源碼讀起來就快得多了。