---
layout: docs
title: Table Print
description: Table Print extension of Bootstrap Table.
group: extensions
toc: true
---
Adds a button to the toolbar to print the table in a predefined configurable format.
## Usage
{% highlight html %}
{% endhighlight %}
## Example
[Print](https://examples.bootstrap-table.com/#extensions/print.html)
## Options
### showPrint
- **attribute:** `data-show-print`
- **type:** `Boolean`
- **Detail:**
Set `true` to show the Print button on the toolbar.
- **Default:** `false`
### printAsFilteredAndSortedOnUI
- **attribute:** `data-print-as-filtered-and-sorted-on-ui`
- **type:** `Boolean`
- **Detail:**
Set `true` to print table as sorted and filtered on UI. If `true` is set, explicit predefined print options for filtering and sorting (`printFilter`, `printSortOrder`, `printSortColumn`). They will be applied to data already filtered and sorted by UI controls. For printing data as filtered and sorted on UI - do not set these three options: `printFilter`, `printSortOrder`, `printSortColumn`.
- **Default:** `true`
### printPageBuilder
- **attribute:** `data-print-page-builder`
- **type:** `Function`
- **Detail:**
Receive HTML `` element as a string parameter, returns HTML string for printing. This option is used for styling and adding a header or footer.
- **Default:**
{% highlight javascript %}
printPageBuilder: function(table, styles) {
return `
${styles}
Print Table
Printed on: ${new Date}
${table}
`
}
{% endhighlight %}
### printSortColumn
- **attribute:** `data-print-sort-column`
- **type:** `String`
- **Detail:**
Set column field name to sort by for the printed table.
- **Default:** `undefined`
### printSortOrder
- **attribute:** `data-print-sort-order`
- **type:** `String`
- **Detail:**
Valid values: 'asc', 'desc'. Relevant only if `printSortColumn` is set.
- **Default:** `'asc'`
### printStyles
- **attribute:** `data-print-styles`
- **type:** `Array`
- **Detail:**
Add styles to the printed page, such as custom icons.
- **Default:** `[]`
### Icons
* print: `'fa-print'`
## Column options
### printFilter
- **attribute:** `data-print-filter`
- **type:** `String`
- **Detail:**
Set the value to filter the printed data by this column.
- **Default:** `undefined`
### printFormatter
- **attribute:** `data-print-formatter`
- **type:** `Function`
- **Detail:**
A custom `function(value, row, index)` - returns a string. Formats the cell values for this column in the printed table. Function behavior is similar to the 'formatter' column option.
- **Default:** `undefined`
### printIgnore
- **attribute:** `data-print-ignore`
- **type:** `Boolean`
- **Detail:**
Set `true` to hide this column on the printed page.
- **Default:** `false`
## Localizations
### formatPrint
- **type:** `Function`
- **Default:** `function () { return "Print" }`