浏览代码

Add example link for table options.

zhixin 11 年之前
父节点
当前提交
5acbe9f3df
共有 2 个文件被更改,包括 125 次插入56 次删除
  1. 119 52
      docs/docs.js
  2. 6 4
      docs/examples.html

+ 119 - 52
docs/docs.js

@@ -13,11 +13,20 @@ $(function () {
         $('#table').bootstrapTable({
             cardView: cardView,
             columns: [
-                {field: 'name', title: 'Name', align: 'center', sortable: true},
-                {field: 'attribute', title: 'Attribute', align: 'center'},
-                {field: 'type', title: 'Type', align: 'center'},
-                {field: 'description', title: 'Description'},
-                {field: 'default', title: 'Default'}
+                {field: 'name', title: 'Name', align: 'center', valign: 'middle', sortable: true},
+                {field: 'attribute', title: 'Attribute', align: 'center', valign: 'middle'},
+                {field: 'type', title: 'Type', align: 'center', valign: 'middle'},
+                {field: 'description', title: 'Description', valign: 'middle'},
+                {field: 'default', title: 'Default', valign: 'middle'},
+                {field: 'example', title: '', valign: 'middle', formatter: function (value) {
+                    if (!value) {
+                        return '-';
+                    }
+                    return [
+                        '<a title="Example" href="examples.html#' + value + '">',
+                        '<i class="glyphicon glyphicon-eye-open"></i>',
+                        '</a>'].join('');
+                }}
             ],
             data: [
                 {
@@ -25,217 +34,248 @@ $(function () {
                     attribute: 'data-toggle',
                     type: 'String',
                     description: 'Activate bootstrap table without writing JavaScript.',
-                    'default': 'table'
+                    'default': 'table',
+                    example: 'basic-table'
                 },
                 {
                     name: 'classes',
                     attribute: 'data-classes',
                     type: 'String',
                     description: 'The class name of table.',
-                    'default': 'table table-hover'
+                    'default': 'table table-hover',
+                    example: 'classes-table'
                 },
                 {
                     name: 'height',
                     attribute: 'data-height',
                     type: 'Number',
                     description: 'The height of table.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'basic-table'
                 },
                 {
                     name: 'undefinedText',
                     attribute: 'data-undefined-text',
                     type: 'String',
                     description: 'Defines the default undefined text.',
-                    'default': '-'
+                    'default': '-',
+                    example: ''
                 },
                 {
                     name: 'striped',
                     attribute: 'data-striped',
                     type: 'Boolean',
                     description: 'True to stripe the rows.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'classes-table'
                 },
                 {
                     name: 'sortName',
                     attribute: 'data-sort-name',
                     type: 'String',
                     description: 'Defines which column can be sorted.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'sort-table'
                 },
                 {
                     name: 'sortOrder',
                     attribute: 'data-sort-order',
                     type: 'String',
                     description: 'Defines the column sort order, can only be "asc" or "desc".',
-                    'default': 'asc'
+                    'default': 'asc',
+                    example: 'sort-table'
                 },
                 {
                     name: 'columns',
                     attribute: '-',
                     type: 'Array',
                     description: 'The table columns config object, see column properties for more details.',
-                    'default': '[]'
+                    'default': '[]',
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'data',
                     attribute: '-',
                     type: 'Array',
                     description: 'The data to be loaded.',
-                    'default': '[]'
+                    'default': '[]',
+                    example: 'table-methods'
                 },
                 {
                     name: 'method',
                     attribute: 'data-method',
                     type: 'String',
                     description: 'The method type to request remote data.',
-                    'default': 'get'
+                    'default': 'get',
+                    example: 'basic-table'
                 },
                 {
                     name: 'url',
                     attribute: 'data-url',
                     type: 'String',
                     description: 'A URL to request data from remote site.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'basic-table'
                 },
                 {
                     name: 'contentType',
                     attribute: 'data-content-type',
                     type: 'String',
                     description: 'The contentType of request remote data.',
-                    'default': 'application/json'
+                    'default': 'application/json',
+                    example: ''
                 },
                 {
                     name: 'queryParams',
                     attribute: 'data-query-params',
                     type: 'Function',
                     description: 'When request remote data, sending additional parameters by format the queryParams, the parameters object contains: <br>pageSize, pageNumber, searchText, sortName, sortOrder.',
-                    'default': 'function(params) {<br>return {};<br>}'
+                    'default': 'function(params) {<br>return {};<br>}',
+                    example: 'server-side-pagination-table'
                 },
                 {
                     name: 'responseHandler',
                     attribute: 'data-response-handler',
                     type: 'Function',
                     description: 'Before load remote data, handler the response data format, the parameters object contains: <br>res: the response data.',
-                    'default': 'function(res) {<br>return res;<br>}'
+                    'default': 'function(res) {<br>return res;<br>}',
+                    example: 'card-view'
                 },
                 {
                     name: 'pagination',
                     attribute: 'data-pagination',
                     type: 'Boolean',
                     description: 'True to show a pagination toolbar on datagrid bottom.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'pagination-table'
                 },
                 {
                     name: 'sidePagination',
                     attribute: 'data-side-pagination',
                     type: 'String',
                     description: 'Defines the side pagination of table, can only be "client" or "server".',
-                    'default': 'client'
+                    'default': 'client',
+                    example: 'pagination-table'
                 },
                 {
                     name: 'totalRows',
                     attribute: 'data-total-rows',
                     type: 'Number',
                     description: 'Defines the total rows of table, you need to set this option when the sidePagination option is set to "server".',
-                    'default': 0
+                    'default': 0,
+                    example: ''
                 },
                 {
                     name: 'pageNumber',
                     attribute: 'data-page-number',
                     type: 'Number',
                     description: 'When set pagination property, initialize the page number.',
-                    'default': 1
+                    'default': 1,
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'pageSize',
                     attribute: 'data-page-size',
                     type: 'Number',
                     description: 'When set pagination property, initialize the page size.',
-                    'default': 10
+                    'default': 10,
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'pageList',
                     attribute: 'data-page-list',
                     type: 'Array',
                     description: 'When set pagination property, initialize the page size selecting list.',
-                    'default': '[10, 25, 50, 100]'
+                    'default': '[10, 25, 50, 100]',
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'search',
                     attribute: 'data-search',
                     type: 'Boolean',
                     description: 'Enable the search input.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'pagination-table'
                 },
                 {
                     name: 'selectItemName',
                     attribute: 'data-select-item-name',
                     type: 'String',
                     description: 'The name of radio or checkbox input.',
-                    'default': 'btSelectItem'
+                    'default': 'btSelectItem',
+                    example: 'radio-table'
                 },
                 {
                     name: 'showHeader',
                     attribute: 'data-show-header',
                     type: 'Boolean',
                     description: 'False to hide the table header.',
-                    'default': 'true'
+                    'default': 'true',
+                    example: 'hide-header-table'
                 },
                 {
                     name: 'showColumns',
                     attribute: 'data-show-columns',
                     type: 'Boolean',
                     description: 'True to show the columns drop down list.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'show-columns-table'
                 },
                 {
                     name: 'minimunCountColumns',
                     attribute: 'data-minimun-count-columns',
                     type: 'Number',
                     description: 'The minimun count columns to hide of the columns drop down list.',
-                    'default': '1'
+                    'default': '1',
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'idField',
                     attribute: 'data-id-field',
                     type: 'String',
                     description: 'Indicate which field is an identity field.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: ''
                 },
                 {
                     name: 'cardView',
                     attribute: 'data-card-view',
                     type: 'Boolean',
                     description: 'True to show card view table, for example mobile view.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'card-view'
                 },
                 {
                     name: 'clickToSelect',
                     attribute: 'data-click-to-select',
                     type: 'Boolean',
                     description: 'True to select checkbox or radiobox when click rows.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'table-select'
                 },
                 {
                     name: 'singleSelect',
                     attribute: 'data-single-select',
                     type: 'Boolean',
                     description: 'True to allow checkbox selecting only one row.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'single-checkbox-table'
                 },
                 {
                     name: 'toolbar',
                     attribute: 'data-toolbar',
                     type: 'String',
                     description: 'A jQuery selector that indicate the toolbar, for example: <br>#toolbar, .toolbar.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'transform-table'
                 },
                 {
                     name: 'rowStyle',
                     attribute: 'data-row-style',
                     type: 'Function',
-                    description: 'The row formatter function, take two parameters: <br>row: the row record data.<br>index: the row index.<br>Support classes or css, code example:<br><pre>return {<br>    classes: "red", <br>    css: {background: "red", color: "white"}<br>}</pre>',
-                    'default': '{}'
+                    description: 'The row formatter function, take two parameters: <br>row: the row record data.<br>index: the row index.<br>Support classes or css.',
+                    'default': '{}',
+                    example: 'classes-table'
                 }
             ]
         });
@@ -246,7 +286,16 @@ $(function () {
                 {field: 'attribute', title: 'Attribute', align: 'center', valign: 'middle'},
                 {field: 'type', title: 'Type', align: 'center', valign: 'middle', width: 60},
                 {field: 'description', title: 'Description', valign: 'middle', width: 400},
-                {field: 'default', title: 'Default', align: 'right', valign: 'middle', width: 180}
+                {field: 'default', title: 'Default', align: 'right', valign: 'middle', width: 180},
+                {field: 'example', title: '', valign: 'middle', formatter: function (value) {
+                    if (!value) {
+                        return '-';
+                    }
+                    return [
+                        '<a title="Example" href="examples.html#' + value + '">',
+                        '<i class="glyphicon glyphicon-eye-open"></i>',
+                        '</a>'].join('');
+                }}
             ],
             data: [
                 {
@@ -254,96 +303,112 @@ $(function () {
                     attribute: 'data-radio',
                     type: 'Boolean',
                     description: 'True to show a radio. The radio column has fixed width.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'radio-table'
                 },
                 {
                     name: 'checkbox',
                     attribute: 'data-checkbox',
                     type: 'Boolean',
                     description: 'True to show a checkbox. The checkbox column has fixed width.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'checkbox-table'
                 },
                 {
                     name: 'field',
                     attribute: 'data-field',
                     type: 'String',
                     description: 'The column field name.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'title',
                     attribute: 'data-title',
                     type: 'String',
                     description: 'The column title text.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'class',
                     attribute: 'class / data-class',
                     type: 'String',
                     description: 'The column class name.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'classes-table'
                 },
                 {
                     name: 'align',
                     attribute: 'data-align',
                     type: 'String',
                     description: 'Indicate how to align the column data. "left", "right", "center" can be used.',
-                    'default': 'undefined'},
+                    'default': 'undefined',
+                    example: 'via-javascript-table'
+                },
                 {
                     name: 'valign',
                     attribute: 'data-valign',
                     type: 'String',
                     description: 'Indicate how to align the cell data. "top", "middle", "bottom" can be used.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'via-javascript-table'
                 },
                 {
                     name: 'width',
                     attribute: 'data-width',
                     type: 'Number',
                     description: 'The width of column. If not defined, the width will auto expand to fit its contents.',
-                    'default': 'undefined'},
+                    'default': 'undefined',
+                    example: ''
+                },
                 {
                     name: 'sortable',
                     attribute: 'data-sortable',
                     type: 'Boolean',
                     description: 'True to allow the column can be sorted.',
-                    'default': 'false'
+                    'default': 'false',
+                    example: 'sort-table'
                 },
                 {
                     name: 'order',
                     attribute: 'data-order',
                     type: 'String',
                     description: 'The default sort order, can only be "asc" or "desc".',
-                    'default': 'asc'
+                    'default': 'asc',
+                    example: 'sort-table'
                 },
                 {
                     name: 'visible',
                     attribute: 'data-visible',
                     type: 'Boolean',
                     description: 'True to visible the columns item.',
-                    'default': 'true'
+                    'default': 'true',
+                    example: 'show-columns-table'
                 },
                 {
                     name: 'switchable',
                     attribute: 'data-switchable',
                     type: 'Boolean',
                     description: 'False to disable the switchable of columns item.',
-                    'default': 'true'
+                    'default': 'true',
+                    example: 'show-columns-table'
                 },
                 {
                     name: 'formatter',
                     attribute: 'data-formatter',
                     type: 'Function',
                     description: 'The cell formatter function, take two parameters: <br />value: the field value. <br />row: the row record data.<br />index: the row index.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'format-table'
                 },
                 {
                     name: 'sorter',
                     attribute: 'data-sorter',
                     type: 'Function',
                     description: 'The custom field sort function that used to do local sorting, take two parameters: <br />a: the first field value.<br /> b: the second field value.',
-                    'default': 'undefined'
+                    'default': 'undefined',
+                    example: 'custom-sort-table'
                 }
             ]
         });
@@ -499,6 +564,8 @@ $(function () {
                 'default': 'No matching records found'
             }]
         });
+
+        $('[title]').tooltip();
     }
 
     $(window).on('resize', initTables);

+ 6 - 4
docs/examples.html

@@ -389,7 +389,7 @@
                     <h2 id="radio-table">Radio</h2>
                 </div>
                 <div class="bs-example">
-                    <table data-toggle="table" data-url="data1.json" data-height="246" data-click-to-select="true">
+                    <table data-toggle="table" data-url="data1.json" data-height="246" data-click-to-select="true" data-select-item-name="radioName">
                         <thead>
                             <tr>
                                 <th data-field="state" data-radio="true"></th>
@@ -628,7 +628,7 @@
                             Refresh
                         </button>
                     </div>
-                    <table id="table-methods-table" data-height="246" data-url="data1.json">
+                    <table id="table-methods-table" data-height="246">
                         <thead>
                         <tr>
                             <th data-field="state" data-checkbox="true"></th>
@@ -644,7 +644,7 @@
                                 getRows = function() {
                                     var rows = [];
 
-                                    for (var i = 0; i < 5; i++) {
+                                    for (var i = 0; i < 10; i++) {
                                         rows.push({
                                             id: id,
                                             name: 'test' + id,
@@ -655,7 +655,9 @@
                                     return rows;
                                 },
                                 // init table use data
-                                $table = $('#table-methods-table').bootstrapTable();
+                                $table = $('#table-methods-table').bootstrapTable({
+                                    data: getRows()
+                                });
 
                             $('#get-selections').click(function() {
                                 alert('Selected values: ' + JSON.stringify($table.bootstrapTable('getSelections')));