documentation.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation &middot; Bootstrap Table</title>
  6. <meta name="author" content="zhixin">
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <link rel="stylesheet" href="../assets/bootstrap/css/bootstrap.min.css">
  9. <link rel="stylesheet" href="../src/bootstrap-table.css">
  10. <link rel="stylesheet" href="docs.css">
  11. <!--<link rel="stylesheet" href="//wenzhixin.net.cn/css/fork.css">-->
  12. <!--[if lt IE 9]>
  13. <script src="//wenzhixin.net.cn/js/html5shiv.js"></script>
  14. <script src="//wenzhixin.net.cn/js/respond.min.js"></script>
  15. <![endif]-->
  16. </head>
  17. <body>
  18. <a class="sr-only" href="#content">Skip to main content</a>
  19. <header class="navbar navbar-inverse navbar-fixed-top bs-docs-nav">
  20. <div class="container">
  21. <div class="navbar-header">
  22. <button class="navbar-toggle" type="button" data-toggle="collapse"
  23. data-target=".bs-navbar-collapse">
  24. <span class="sr-only">Toggle navigation</span>
  25. <span class="icon-bar"></span>
  26. <span class="icon-bar"></span>
  27. <span class="icon-bar"></span>
  28. </button>
  29. <a class="navbar-brand" href="index.html">
  30. Bootstrap Table
  31. </a>
  32. </div>
  33. <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation">
  34. <ul class="nav navbar-nav">
  35. <li>
  36. <a href="getting-started.html">Getting started</a>
  37. </li>
  38. <li class="active">
  39. <a href="documentation.html">Documentation</a>
  40. </li>
  41. <li>
  42. <a href="examples.html">Examples</a>
  43. </li>
  44. </ul>
  45. <ul class="nav navbar-nav navbar-right">
  46. <!-- GitHub buttons: see http://ghbtns.com -->
  47. <li><iframe class="navbar-text" src="http://ghbtns.com/github-btn.html?user=wenzhixin&repo=bootstrap-table&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></li>
  48. <li><iframe class="navbar-text" src="http://ghbtns.com/github-btn.html?user=wenzhixin&repo=bootstrap-table&type=fork&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe></li>
  49. <li><iframe class="navbar-text" src="http://ghbtns.com/github-btn.html?user=wenzhixin&type=follow&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="165" height="20"></iframe></li>
  50. </ul>
  51. </nav>
  52. </div>
  53. </header>
  54. <div class="bs-header" id="content">
  55. <div class="container">
  56. <h1>Documentation</h1>
  57. <p>The documentation contains Table Properties, Column Properties, Events, Methods, and much more.</p>
  58. </div>
  59. </div>
  60. <div class="container">
  61. <div class="row">
  62. <div class="col-md-3">
  63. <div class="bs-sidebar" role="complementary">
  64. <ul class="nav bs-sidenav">
  65. <li><a href="#properties">Table Properties</a></li>
  66. <li><a href="#columns">Column Properties</a></li>
  67. <li><a href="#events">Events</a></li>
  68. <li><a href="#methods">Methods</a></li>
  69. <li><a href="#localizations">Localizations</a></li>
  70. <li><a href="#the-defaults">The Defaults</a></li>
  71. </ul>
  72. </div>
  73. </div>
  74. <div class="col-md-9" role="main">
  75. <div class="page-header alert alert-info">
  76. <a class="close" data-dismiss="alert" href="#" aria-hidden="true">&times;</a>
  77. <b>NOTE:</b> Bootstrap Table is licensed under the <a href="https://github.com/wenzhixin/bootstrap-table/blob/master/LICENSE">The MIT License</a>. Completely free, you can arbitrarily use and modify this plugin. If you like this plugin, you can <a href="http://github.com/wenzhixin/bootstrap-table"><b>Star</b></a> this repo, your support is my biggest motive force, thanks.
  78. </div>
  79. <div>
  80. <div class="page-header">
  81. <h1 id="properties">Table Properties:</h1>
  82. </div>
  83. <table id="table"></table>
  84. </div>
  85. <div>
  86. <div class="page-header">
  87. <h1 id="columns">Column Properties:</h1>
  88. </div>
  89. <table id="column"></table>
  90. </div>
  91. <div>
  92. <div class="page-header">
  93. <h1 id="events">Events:</h1>
  94. </div>
  95. <table id="event"></table>
  96. </div>
  97. <div>
  98. <div class="page-header">
  99. <h1 id="methods">Methods:</h1>
  100. </div>
  101. <table id="method"></table>
  102. </div>
  103. <div>
  104. <div class="page-header">
  105. <h1 id="localizations">Localizations:</h1>
  106. </div>
  107. <table id="localization"></table>
  108. </div>
  109. <div>
  110. <div class="page-header">
  111. <h1 id="the-defaults">The Defaults:</h1>
  112. </div>
  113. <div>
  114. <pre><code>&lt;script&gt;
  115. $.extend($.fn.bootstrapTable.defaults, {
  116. bootstrapVersion: 3,
  117. classes: 'table table-hover',
  118. height: undefined,
  119. undefinedText: '-',
  120. sortName: undefined,
  121. sortOrder: 'asc',
  122. striped: false,
  123. columns: [],
  124. data: [],
  125. method: 'get',
  126. url: undefined,
  127. contentType: 'application/json',
  128. queryParams: function(params) {return {};}, // pageSize, pageNumber, searchText
  129. pagination: false,
  130. sidePagination: 'client', // client or server
  131. totalRows: 0, // server side need to set
  132. pageNumber: 1,
  133. pageSize: 10,
  134. pageList: [10, 25, 50, 100],
  135. search: false,
  136. selectItemName: 'btSelectItem',
  137. showHeader: true,
  138. showColumns: false,
  139. idField: undefined,
  140. cardView: false,
  141. clickToSelect: false,
  142. singleSelect: false,
  143. toolbar: undefined,
  144. rowStyle: function(row, index) {return {};},
  145. formatLoadingMessage: function() {
  146. return 'Loading, please wait…';
  147. },
  148. formatRecordsPerPage: function(pageNumber) {
  149. return sprintf('%s records per page', pageNumber);
  150. },
  151. formatShowingRows: function(pageFrom, pageTo, totalRows) {
  152. return sprintf('Showing %s to %s of %s rows', pageFrom, pageTo, totalRows);
  153. },
  154. formatSearch: function() {
  155. return 'Search';
  156. },
  157. formatNoMatches: function() {
  158. return 'No matching records found';
  159. },
  160. onAll: function(name, args) {return false;},
  161. onClickRow: function(item, $element) {return false;},
  162. onDblClickRow: function(item, $element) {return false;},
  163. onSort: function(name, order) {return false;},
  164. onCheck: function(row) {return false;},
  165. onUncheck: function(row) {return false;},
  166. onCheckAll: function() {return false;},
  167. onUncheckAll: function() {return false;},
  168. onLoadSuccess: function(data) {return false;},
  169. onLoadError: function(status) {return false;},
  170. onBeforeLoad: function(res) {return res;}
  171. });
  172. $.extend($.fn.bootstrapTable.columnDefaults, {
  173. radio: false,
  174. checkbox: false,
  175. field: undefined,
  176. title: undefined,
  177. align: undefined, // left, right, center
  178. valign: undefined, // top, middle, bottom
  179. width: undefined,
  180. sortable: false,
  181. order: 'asc', // asc, desc
  182. visible: true,
  183. formatter: undefined,
  184. sorter: undefined
  185. });
  186. &lt;/script&gt;
  187. </code></pre>
  188. </div>
  189. </div>
  190. </div>
  191. </div>
  192. </div>
  193. <!--<a href="https://github.com/wenzhixin/bootstrap-table" class="fork_me"></a>-->
  194. <footer class="bs-footer" role="contentinfo">
  195. <div class="container">
  196. <p>Copyright © 2012-2014, Bootstrap Table is licensed under the The MIT License. Coded by wenzhixin. </p>
  197. <ul class="footer-links">
  198. <li>Currently: v1.0.6</li>
  199. <li class="muted">·</li>
  200. <li><a href="http://wenzhixin.net.cn">My website</a></li>
  201. <li class="muted">·</li>
  202. <li><a href="http://repos.wenzhixin.net.cn">My repos</a></li>
  203. <li class="muted">·</li>
  204. <li><a href="https://github.com/wenzhixin">Github (@wenzhixin)</a></li>
  205. <li class="muted">·</li>
  206. <li><a href="https://github.com/wenzhixin/bootstrap-table/issues?state=open">Issues</a></li>
  207. <li class="muted">·</li>
  208. <li><a href="mailto:wenzhixin2010@gmail.com">Email</a></li>
  209. </ul>
  210. </div>
  211. </footer>
  212. <script src="../assets/jquery.min.js"></script>
  213. <script src="../assets/bootstrap/js/bootstrap.min.js"></script>
  214. <script src="../src/bootstrap-table.js"></script>
  215. <script src="docs.js"></script>
  216. <script src="//wenzhixin.net.cn/js/analytics.js"></script>
  217. </body>
  218. </html>