bootstrap-progressbar 技术文档

1. 安装指南

bootstrap-progressbar 是一个基于 jQuery 的插件，用于扩展基本的 twitter-bootstrap 进度条。以下是安装步骤：

• 下载最新版本：v0.9.0
• 克隆仓库：git clone [e-mail]:minddust/bootstrap-progressbar.git
• 使用 Bower 安装：bower install bootstrap-progressbar

2. 项目的使用说明

基本使用

1. 引入 bootstrap-progressbar.js

   <script type="text/javascript" src="bootstrap-progressbar.js"></script>
   

2. 在你选择的进度条上激活 bootstrap-progressbar 功能：

   $('.progress .bar').progressbar();           // bootstrap 2
   $('.progress .progress-bar').progressbar();  // bootstrap 3
   

3. 设置 aria 属性并移除 width 样式属性（或者将其设置为 0）

   1. data-transitiongoal

      <div class="progress">
          <div class="progress-bar" data-transitiongoal="75"></div>
      </div>
      

   2. aria-valuemin（默认：0）和 aria-valuemax（默认：100）

      <div class="progress">
          <div class="progress-bar" data-transitiongoal="75" aria-valuemin="-1337" aria-valuemax="9000"></div>
      </div>
      

扩展使用

• 是否需要额外的样式文件？

  • 对于水平条，如果没有文本或文本填充：否
  • 对于任何垂直条或水平条中的居中文本或右对齐条：是

• 多次触发

  可以多次触发进度条。只需更改属性并再次触发 .progressbar()。之前的设置将被保留。

3. 项目API使用文档

以下是 bootstrap-progressbar 的默认配置和可自定义的设置：

Progressbar.defaults = {
    transition_delay: 300,         // 动画开始前的延迟时间，单位为毫秒
    refresh_speed: 50,             // 文本刷新、'aria-valuenow' 属性更新和 'update' 回调调用之间的时间间隔，单位为毫秒
    display_text: 'none',          // 确定是否在进度条上显示文本，以及显示的位置
    use_percentage: true,          // 如果显示文本，这个选项决定了是显示百分比还是数量
    percent_format: function(percent) { return percent + '%'; },  // 百分比格式化函数
    amount_format: function(amount_part, amount_total) { return amount_part + ' / ' + amount_total; },  // 数量格式化函数
    update: $.noop,                 // 进度条过渡时调用的回调函数
    done: $.noop,                   // 过渡过程完成时调用的回调函数
    fail: $.noop                   // 发生错误时调用的回调函数
};

4. 项目安装方式

如前所述，bootstrap-progressbar 可以通过以下方式安装：

• 直接下载最新版本的压缩包并解压使用。
• 通过克隆 GitHub 仓库来获取最新版本的代码。
• 使用 Bower 包管理器进行安装。

以上是 bootstrap-progressbar 的技术文档，详细介绍了安装、使用和 API 文档，帮助用户更好地了解和使用这个项目。