Bootstrap Table

Bootstrap Table is an extended Bootstrap table plugin designed for Twitter Bootstrap (all versions supported). Key features include:

• Responsive Design: Supports responsive web layouts.
• Layout Control: Scrollable tables with fixed headers, and the ability to show/hide columns, headers, or footers.
• Data Handling: Get data in JSON format using AJAX and simple column sorting via click.
• Selection & View Modes: Single or multiple row selection, Card view, and Detail view.
• Advanced UI: Powerful pagination, column formatting, and localization.
• Extensibility: Fully configurable via data attributes and supports various extensions.

Bootstrap Table focuses on the latest, stable releases of all major browsers and platforms, prioritizing modern browsers with high performance and security.

While alternative browsers using WebKit, Blink, or Gecko (including platform web view APIs) are not explicitly supported, Bootstrap Table should function correctly in most cases. Compatibility is designed to be consistent with Bootstrap's own browser and device support requirements.

The Table Pipeline extension enables client-side data caching for server-side requests. It provides a performance balance for large datasets by allowing the table to fetch data in 'cache windows' rather than making a new server request for every single page change.

How it works:

1. The extension divides the total dataset into windows based on the pipelineSize.
2. When a user changes pages, the extension checks if the new offset falls within the current cached window.
3. If it does, the data is served from the local cache (a 'cache hit').
4. If it does not, a new server-side request is issued for the next window (a 'cache reset').

Server-side Requirement: To use this extension, your server-side implementation MUST use the limit (set to pipelineSize) and offset parameters to return only the data within the requested cache window, along with the total number of rows.

The order of parameters in row-click callbacks depends on whether you are using jQuery event delegation or the Bootstrap Table configuration object:

1. jQuery .on() method: The first parameter is always the standard jQuery event object. Signature: function (event, row, $element)

2. onClickRow configuration option: The event object is omitted. Signature: function (row, $element)

// Using jQuery .on()
$('#eventsTable').on('click-row.bs.table', function (event, row, $element) {
  // event is present
})

// Using onClickRow option
{
  onClickRow: function (row, $element) {
    // event is NOT the first parameter
  }
}

If you are contributing to the project or building from source, the repository is organized as follows:

• src/: Contains the source code for the core CSS and JavaScript.
• src/extensions/: Source code for various extensions.
• src/locale/: Source code for localization files.
• src/themes/: Source code for different themes.
• site/: Contains the source code for the official documentation website.
• Root files: package.json (package info), LICENSE (licensing), and README.md (development guidelines).

bootstrap-table/
├── site/
└── src/
    ├── extensions/
    ├── locale/
    ├── themes/
    ├── bootstrap-table.css
    └── bootstrap-table.js

The Print extension respects the core Bootstrap Table rowStyle and cellStyle options.

• Inline Styles: The css property (supporting objects, strings, or arrays) is applied to the printed output.
• Class-based Styles: If you use CSS classes for styling, you must include the relevant CSS file or rules via the printStyles option.
• Custom Builders: If using printPageBuilder, ensure the styles argument is included in your returned HTML so that class-based styles are available.

By default, the Addrbar extension uses five standard query parameters:

• page: page number
• size: page size
• order: asc/dsc
• sort: the sort keyword
• search: search keyword

If you have multiple tables on one page, they will all attempt to use these same keys, causing conflicts. To resolve this, set the data-addr-prefix attribute to a unique string for each table. The extension will then prefix the standard parameters with your custom string.

Bootstrap Table requires the use of the HTML5 doctype. Omitting it may result in incomplete or incorrect styling.

<!doctype html>
<html lang="en">
  ...
</html>