单独或编译

插件可以单独包含（尽管有些具有必需的依赖项），也可以一次全部包含。bootstrap.js和bootstrap.min.js都在一个文件中包含所有插件。

数据属性

您可以完全通过标记 API 使用所有 Bootstrap 插件，而无需编写任何 JavaScript 代码。这是 Bootstrap 的第一类 API，在使用插件时应该是您的首要考虑因素。

也就是说，在某些情况下，可能需要关闭此功能。因此，我们还提供了禁用数据属性 API 的能力，方法是取消绑定以“data-api”命名的 body 上的所有事件。这看起来像这样：

$ （“身体” ）。关闭（'.data-api' ）

或者，要针对特定​​插件，只需将插件的名称作为命名空间与 data-api 命名空间一起包含，如下所示：

$ （“身体” ）。关闭（'.alert.data-api' ）

程序化 API

我们也相信您应该能够纯粹通过 JavaScript API 使用所有 Bootstrap 插件。所有公共 API 都是单一的、可链接的方法，并返回所操作的集合。

$ （“.btn.danger” ）。按钮（“切换” ）。addClass （“胖” ）

所有方法都应该接受一个可选的选项对象，一个针对特定方法的字符串，或者什么都没有（它启动一个具有默认行为的插件）：

$ （“#myModal” ）。modal () // 用默认值初始化                       
$ （“#myModal” ）。modal ({ keyboard : false }) // 没有键盘初始化     
$ （“#myModal” ）。modal ( 'show' ) // 立即初始化并调用 show                

每个插件还在 `Constructor` 属性上公开其原始构造函数$.fn.popover.Constructor：如果您想获取特定的插件实例，请直接从元素中检索它：$('[rel=popover]').data('popover')。

无冲突

有时需要将 Bootstrap 插件与其他 UI 框架一起使用。在这些情况下，有时会发生命名空间冲突。如果发生这种情况，您可以调用.noConflict您希望恢复其值的插件。

var bootstrapButton = $ 。fn 。按钮。noConflict () // 将 $.fn.button 返回到先前分配的值 
$ . fn 。bootstrapBtn = bootstrapButton             // 赋予 $().bootstrapBtn 引导功能

活动

Bootstrap 为大多数插件的独特操作提供自定义事件。通常，这些以不定式和过去分词形式出现 - 其中不定式（例如show）在事件开始时触发，其过去分词形式（例如shown）在动作完成时触发。

所有不定式事件都提供 preventDefault 功能。这提供了在动作开始之前停止执行的能力。

$ （'#myModal' ）。上（'显示' ，功能（e ）{   
    如果（！数据）返回e 。preventDefault () // 停止显示模态   
})

关于过渡

对于简单的过渡效果，将bootstrap-transition.js与其他 JS 文件一起包含一次。如果您使用的是已编译（或缩小）的bootstrap.js，则无需包含它——它已经存在。

用例

过渡插件的几个例子：

• 在模态中滑动或淡出
• 淡出标签
• 淡出警报
• 滑动轮播窗格

例子

模态是精简但灵活的对话框提示，具有最低要求的功能和智能默认值。

静态示例

在页脚中带有页眉、正文和一组操作的渲染模式。

<div class = "模态隐藏淡入淡出" > 
  <div类= “模态标题” > 
    <button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × </按钮>    
    <h3>模态标题</h3>
  </div>
  <div类= “模态体” > 
    <p>一个很好的身体...... </p>
  </div>
  <div类= “模态页脚” > 
    <a href = "#" class = "btn" >关闭</a>  
    <a href = "#" class = "btn btn-primary" >保存更改</a>  
  </div>
</div>

现场演示

单击下面的按钮，通过 JavaScript 切换模式。它将向下滑动并从页面顶部淡入。

<!-- 触发模态的按钮 -->
<a href = "#myModal" role = "button" class = "btn" data-toggle = "modal" >启动演示模式</a>    
 
<!-- 模态 -->
<div id = "myModal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria- labelledby = "myModalLabel" aria-hidden = "true" >      
  <div类= “模态标题” > 
    <button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × </button>    
    <h3 id = "myModalLabel" >模态标题</h3> 
  </div>
  <div类= “模态体” > 
    <p>一个很好的身体...... </p>
  </div>
  <div类= “模态页脚” > 
    <button class = "btn" data-dismiss = "modal" aria-hidden = "true" >关闭</button>   
    <button class = "btn btn-primary" >保存更改</button> 
  </div>
</div>

用法

通过数据属性

无需编写 JavaScript 即可激活模式。在控制器元素上设置data-toggle="modal"，如按钮，以及一个data-target="#foo"或href="#foo"以特定模式为目标进行切换。

<button type = "button" data-toggle = "modal" data-target = "#myModal" >启动模态</button>   

通过 JavaScript

myModal使用单行 JavaScript调用带有 id 的模式：

$ （'#myModal' ）。模态（选项）

选项

选项可以通过数据属性或 JavaScript 传递。对于数据属性，将选项名称附加到 中data-，如data-backdrop="".

<a data-toggle="modal" href="remote.html" data-target="#modal">click me</a>

方法

.modal（选项）

将您的内容激活为模式。接受一个可选选项object。

$ （'#myModal' ）。模态（{
  键盘：假 
})

.modal('切换')

手动切换模式。

$ （'#myModal' ）。模态（'切换' ）

.modal('显示')

手动打开一个模态。

$ （'#myModal' ）。模态（“显示” ）

.modal('隐藏')

手动隐藏模态。

$ （'#myModal' ）。模态（“隐藏” ）

活动

Bootstrap 的模态类公开了一些用于连接模态功能的事件。

$ （'#myModal' ）。on ( '隐藏' , function () {   
  // 做一点事…
})

例子

使用这个简单的插件几乎可以将下拉菜单添加到任何东西，包括导航栏、选项卡和药丸。

在导航栏中

在选项卡内

用法

通过数据属性

添加data-toggle="dropdown"到链接或按钮以切换下拉菜单。

<div类= “下拉” > 
  <a class = "dropdown-toggle" data-toggle = "dropdown" href = "#" > Dropdown 触发器</a>   
  <ul类= “下拉菜单”角色= “菜单” aria- labelledby = “dLabel” >   
    ...
  </ul>
</div>

要保持 URL 完整，请使用data-target属性而不是href="#".

<div类= “下拉” > 
  <a class = "dropdown-toggle" id = "dLabel" role = "button" data-toggle = "dropdown" data-target = "#" href = "/page.html" >      
    落下
    <b类= "插入符号" ></b> 
  </a>
  <ul类= “下拉菜单”角色= “菜单” aria- labelledby = “dLabel” >   
    ...
  </ul>
</div>

通过 JavaScript

通过 JavaScript 调用下拉菜单：

$ （'.dropdown-toggle' ）。下拉（）

选项

没有任何

方法

$().dropdown('切换')

用于切换给定导航栏或选项卡式导航的菜单的编程 api。

导航栏中的示例

ScrollSpy 插件用于根据滚动位置自动更新导航目标。滚动导航栏下方的区域并观察活动类的变化。下拉子项目也将突出显示。

用法

通过数据属性

要轻松地将 scrollspy 行为添加到您的顶栏导航，只需添加data-spy="scroll"到您要监视的元素（通常是正文）并data-target=".navbar"选择要使用的导航。您需要将 scrollspy 与.nav组件一起使用。

<body data-spy = "scroll" data-target = ".navbar" > ... </body>  

通过 JavaScript

通过 JavaScript 调用 scrollspy：

$ （'#navbar' ）。卷轴间谍()

方法

.scrollspy('刷新')

当使用 scrollspy 和从 DOM 中添加或删除元素时，你需要像这样调用 refresh 方法：

$ ( '[data-spy="scroll"]' )。每个（函数（）{  
  var $spy = $ (这个)。scrollspy ( '刷新' )
});

选项

选项可以通过数据属性或 JavaScript 传递。对于数据属性，将选项名称附加到 中data-，如data-offset="".

活动

示例选项卡

添加快速、动态的选项卡功能以在本地内容窗格之间进行转换，甚至通过下拉菜单。

用法

通过 JavaScript 启用可选项卡（每个选项卡需要单独激活）：

$ （'#myTab a' ）。点击（功能（e ）{  
  e . 防止默认（）；
  $ （这个）。选项卡（“显示” ）；
})

您可以通过多种方式激活单个选项卡：

$ ( '#myTab a[href="#profile"]' )。选项卡（“显示” ）；// 按名称选择标签 
$ ( '#myTab a:first' )。选项卡（“显示” ）；// 选择第一个标签 
$ ( '#myTab a:last' )。选项卡（“显示” ）；// 选择最后一个标签 
$ ( '#myTab li:eq(2) a' )。选项卡（“显示” ）；// 选择第三个标签（0-indexed） 

标记

您无需编写任何 JavaScript，只需在元素上指定data-toggle="tab"或即可激活选项卡或药丸导航。data-toggle="pill"将nav和nav-tabs类添加到选项卡ul将应用 Bootstrap 选项卡样式。

<ul class = "nav 导航标签" > 
  <li><a href = "#home" data-toggle = "tab" >主页</a></li>  
  <li><a href = "#profile" data-toggle = "tab" >个人资料</a></li>  
  <li><a href = "#messages" data-toggle = "tab" >消息</a></li>  
  <li><a href = "#settings" data-toggle = "tab" >设置</a></li>  
</ul>

方法

$().tab

激活选项卡元素和内容容器。Tab 应该在 DOM 中具有一个data-target或一个href目标容器节点。

<ul类= “nav 导航标签” id = “myTab” >  
  <li class = "active" ><a href = "#home" > Home </a></li>  
  <li><a href = "#profile" >个人资料</a></li> 
  <li><a href = "#messages" >消息</a></li> 
  <li><a href = "#settings" >设置</a></li> 
</ul>
 
<div类= "标签内容" > 
  <div class = "tab-pane active" id = "home" > ... </div>  
  <div class = "tab-pane" id = "profile" > ... </div>  
  <div class = "tab-pane" id = "messages" > ... </div>  
  <div class = "tab-pane" id = "settings" > ... </div>  
</div>
 
<脚本>
  $ (函数() {  
    $ ( '#myTab a:last' )。选项卡（“显示” ）；
  })
</脚本>

活动

$ ( 'a[data-toggle="tab"]' )。on （'显示' ，函数（e ）{   
  e . 目标// 激活的选项卡
  e . relatedTarget // 上一个标签
})

例子

受到 Jason Frame 编写的优秀 jQuery.tipsy 插件的启发；工具提示是一个更新版本，它不依赖图像，使用 CSS3 制作动画，使用数据属性存储本地标题。

出于性能原因，工具提示和弹出框数据 API 是可选的，这意味着您必须自己初始化它们。

将鼠标悬停在下面的链接上以查看工具提示：

四个方向

输入组中的工具提示

当使用带有 Bootstrap 输入组的工具提示和弹出框时，您必须设置container（如下所述）选项以避免不必要的副作用。

用法

通过 JavaScript 触发工具提示：

$ （'#example' ）。工具提示（选项）

选项

选项可以通过数据属性或 JavaScript 传递。对于数据属性，将选项名称附加到 中data-，如data-animation="".

标记

<a href = "#" data-toggle = "tooltip" title = "first tooltip" >悬停在我身上</a>   

方法

$().tooltip(选项)

将工具提示处理程序附加到元素集合。

.tooltip('显示')

显示元素的工具提示。

$ （'#element' ）。工具提示（“显示” ）

.tooltip('隐藏')

隐藏元素的工具提示。

$ （'#element' ）。工具提示（“隐藏” ）

.tooltip('切换')

切换元素的工具提示。

$ （'#element' ）。工具提示（“切换” ）

.tooltip('销毁')

隐藏和破坏元素的工具提示。

$ （'#element' ）。工具提示（“销毁” ）

例子

向任何元素添加小的内容覆盖，如 iPad 上的内容，以容纳辅助信息。将鼠标悬停在按钮上以触发弹出窗口。需要包含工具提示。

静态弹出框

有四个选项可用：上对齐、右对齐、下对齐和左对齐。

没有显示为弹出框的标记是从 JavaScript 和data属性中的内容生成的。

现场演示

四个方向

用法

通过 JavaScript 启用弹出框：

$ （'#example' ）。弹出框（选项）

选项

选项可以通过数据属性或 JavaScript 传递。对于数据属性，将选项名称附加到 中data-，如data-animation="".

标记

出于性能原因，选择加入 Tooltip 和 Popover data-apis。如果您想使用它们，只需指定一个选择器选项。

方法

$().popover(选项)

初始化元素集合的弹出框。

.popover('显示')

显示元素弹出框。

$ （'#element' ）。弹出窗口（“显示” ）

.popover('隐藏')

隐藏元素弹出框。

$ （'#element' ）。弹出框（'隐藏' ）

.popover('切换')

切换元素弹出框。

$ （'#element' ）。弹出框（'切换' ）

.popover('销毁')

隐藏和销毁元素的弹出框。

$ （'#element' ）。弹出框（“销毁” ）

示例警报

使用此插件向所有警报消息添加解除功能。

用法

启用通过 JavaScript 解除警报：

$ （“.alert” ）。警报()

标记

只需添加data-dismiss="alert"到您的关闭按钮即可自动提供警报关闭功能。

<a class = "close" data-dismiss = "alert" href = "#" > × </a>   

方法

$().alert()

使用关闭功能包装所有警报。要让警报在关闭时显示动画，请确保它们已经应用了.fadeand.in类。

.alert('关闭')

关闭警报。

$ （“.alert” ）。警报（'关闭' ）

活动

Bootstrap 的警报类公开了一些用于连接警报功能的事件。

$ （'#my-alert' ）。绑定（'关闭' ，函数（）{   
  // 做一点事…
})

示例用途

用按钮做更多事情。控制按钮状态或为更多组件（如工具栏）创建按钮组。

有状态的

添加data-loading-text="Loading..."以在按钮上使用加载状态。

<button type = "button" class = "btn btn-primary" data-loading-text = "Loading..." >加载状态</button>   

单切换

添加data-toggle="button"以激活单个按钮上的切换。

<button type = "button" class = "btn btn-primary" data-toggle = "button" > Single Toggle </button>   

复选框

添加data-toggle="buttons-checkbox"在 btn-group 上切换复选框样式。

<div class = "btn-group" data-toggle = "buttons-checkbox" >  
  <button type = "button" class = "btn btn-primary" >左</button>  
  <button type = "button" class = "btn btn-primary" >中间</button>  
  <button type = "button" class = "btn btn-primary" >右</button>  
</div>

收音机

添加data-toggle="buttons-radio"用于在 btn-group 上切换无线电样式。

<div class = "btn-group" data-toggle = "buttons-radio" >  
  <button type = "button" class = "btn btn-primary" >左</button>  
  <button type = "button" class = "btn btn-primary" >中间</button>  
  <button type = "button" class = "btn btn-primary" >右</button>  
</div>

用法

通过 JavaScript 启用按钮：

$ （'.nav-tabs' ）。按钮()

标记

数据属性是按钮插件的组成部分。查看下面的示例代码以了解各种标记类型。

选项

没有任何

方法

$().button('切换')

切换推送状态。使按钮具有已激活的外观。

<button type = "button" class = "btn" data-toggle = "button" > ... </button>    

$().button('加载中')

将按钮状态设置为加载 - 禁用按钮并将文本交换为加载文本。应使用 data 属性在按钮元素上定义加载文本data-loading-text。

<button type = "button" class = "btn" data-loading-text = "loading stuff..." > ... </button>    

$().button('重置')

重置按钮状态 - 将文本交换为原始文本。

$().button(字符串)

重置按钮状态 - 将文本交换为任何数据定义的文本状态。

<按钮类型= “按钮”类= “btn”数据完整文本= “完成！” > ... </按钮>    
<脚本>
  $ （'.btn' ）。按钮（“完成” ）
</脚本>

关于

获得对可折叠组件（如手风琴和导航）的基本样式和灵活支持。

*需要包含过渡插件。

示例手风琴

使用折叠插件，我们构建了一个简单的手风琴风格小部件：

<div class = "accordion" id = "accordion2" >  
  <div class = "手风琴组" > 
    <div class = "手风琴标题" > 
      <a class = "accordion-toggle" data-toggle = "collapse" data-parent = "#accordion2" href = "#collapseOne" >    
        可折叠组项目 #1
      </a>
    </div>
    <div id = "collapseOne" class = "accordion-body 折叠在" >  
      <div class = "手风琴内部" > 
        动漫卡通头像...
      </div>
    </div>
  </div>
  <div class = "手风琴组" > 
    <div class = "手风琴标题" > 
      <a class = "accordion-toggle" data-toggle = "collapse" data-parent = "#accordion2" href = "#collapseTwo" >    
        可折叠组项目 #2
      </a>
    </div>
    <div id = "collapseTwo" class = "手风琴体折叠" >  
      <div class = "手风琴内部" > 
        动漫卡通头像...
      </div>
    </div>
  </div>
</div>
...

您也可以使用没有手风琴标记的插件。制作一个按钮来切换另一个元素的展开和折叠。

<button type = "button" class = "btn btn-danger" data-toggle = "collapse" data-target = "#demo" >    
  简单可折叠
</按钮>
 
<div id = "demo" class = "collapse in" > ... </div>  

用法

通过数据属性

只需添加data-toggle="collapse"一个data-targetto 元素即可自动分配对可折叠元素的控制。该data-target属性接受一个 CSS 选择器来应用折叠。确保将类添加collapse到可折叠元素。如果您希望它默认打开，请添加附加类in。

要将手风琴式的组管理添加到可折叠控件，请添加 data 属性data-parent="#selector"。请参阅演示以查看此操作。

通过 JavaScript

手动启用：

$ （“.collapse” ）。崩溃()

选项

选项可以通过数据属性或 JavaScript 传递。对于数据属性，将选项名称附加到 中data-，如data-parent="".

方法

.collapse（选项）

将您的内容激活为可折叠元素。接受一个可选选项object。

$ （'#myCollapsible' ）。崩溃（{
  切换：假 
})

.collapse('切换')

将可折叠元素切换为显示或隐藏。

.collapse('显示')

显示可折叠元素。

.collapse('隐藏')

隐藏可折叠元素。

活动

Bootstrap 的折叠类公开了一些用于挂钩折叠功能的事件。

$ （'#myCollapsible' ）。on ( '隐藏' , function () {   
  // 做一点事…
})

示例轮播

下面的幻灯片显示了一个通用插件和组件，用于在轮播等元素中循环。

第一个缩略图标签

Cras justo odio，dapibus ac facilisis in，egestas eget quam。Donec id elit non mi porta gravida 在 eget metus。Nullam id dolor id nibh ultricies vehicula ut id elit。

Second Thumbnail label

Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.

Third Thumbnail label

Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.

‹ ›

<div id = "myCarousel" class = "carousel slide" >  
  <ol class = “轮播指示器” > 
    <li data-target = "#myCarousel" data-slide-to = "0" class = "active" ></li>   
    <li data-target = "#myCarousel" data-slide-to = "1" ></li>  
    <li data-target = "#myCarousel" data-slide-to = "2" ></li>  
  </ol>
  <!-- 轮播项目 -->
  <div class = "carousel-inner" > 
    <div class = "活动项目" > ... </div> 
    <div class = "item" > … </div> 
    <div class = "item" > … </div> 
  </div>
  <!-- 轮播导航 -->
  <a class = "carousel-control left" href = "#myCarousel" data-slide = "prev" > ‹ </a>   
  <a class = "carousel-control right" href = "#myCarousel" data-slide = "next" > › </a>   
</div>

用法

通过数据属性

使用数据属性轻松控制轮播的位置。data-slide接受关键字prevor next，它改变相对于当前位置的幻灯片位置。或者，使用data-slide-to将原始幻灯片索引传递给 carousel data-slide-to="2"，它将幻灯片位置跳转到以 开头的特定索引0。

通过 JavaScript

手动调用轮播：

$ （'.carousel' ）。轮播()

选项

选项可以通过数据属性或 JavaScriptz 传递。对于数据属性，将选项名称附加到 中data-，如data-interval="".

方法

.carousel（选项）

使用可选选项初始化轮播object并开始循环浏览项目。

$ （'.carousel' ）。轮播（{
  间隔：2000 
})

.carousel('循环')

从左到右循环浏览轮播项目。

.carousel('暂停')

停止轮播在项目中循环。

.carousel(数字)

将轮播循环到特定帧（基于 0，类似于数组）。

.carousel('prev')

循环到上一个项目。

.carousel('下一个')

循环到下一个项目。

活动

Bootstrap 的 carousel 类公开了两个用于连接 carousel 功能的事件。

例子

一个基本的、易于扩展的插件，用于使用任何表单文本输入快速创建优雅的预输入。

<输入类型= “文本”数据提供= “提前输入” >  

您需要进行设置autocomplete="off"以防止默认浏览器菜单出现在 Bootstrap 预输入下拉菜单中。

用法

通过数据属性

添加数据属性以注册具有预先输入功能的元素，如上例所示。

通过 JavaScript

使用以下命令手动调用 typeahead：

$ （'.typeahead' ）。预输入()

选项

选项可以通过数据属性或 JavaScript 传递。对于数据属性，将选项名称附加到 中data-，如data-source="".

方法

.typeahead（选项）

使用预输入初始化输入。

例子

左侧的子导航是词缀插件的现场演示。

用法

通过数据属性

要轻松地将词缀行为添加到任何元素，只需添加data-spy="affix"到要监视的元素即可。然后使用偏移量来定义何时打开和关闭元素的固定。

<div data-spy = "affix" data-offset-top = "200" > ... </div>  

通过 JavaScript

通过 JavaScript 调用 affix 插件：

$ （'#navbar' ）。词缀()

选项

选项可以通过数据属性或 JavaScript 传递。对于数据属性，将选项名称附加到 中data-，如data-offset-top="200".