datatable-sort.mustache revision cf6c1ae1ed15095f8dc269bb9d7a373a1b87990e
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<style scoped>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly/* custom styles for this example */
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly.dt-example {margin:1em;}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly/* css to counter global site css */
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly.dt-example th {text-transform:none;}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly.dt-example table {width:auto;}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly.dt-example caption {display:table-caption;}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="intro">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly <p>The `Y.Plugin.DataTableSort` plugin adds column sorting functionality to a basic DataTable.</p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<div class="example">
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {{>datatable-sort-source}}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<h2>Implementing Sortable Columns</h2>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>To add column sorting functionality to any DataTable, simply call `.plug(Y.Plugin.DataTableSort)`. The `DataTableSort` plugin is available in the`datatable-sort` submodule. To enable sorting, you must define `sortable:true` in each column definition.</p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny DonnellyYUI().use("datatable-sort", function(Y) {
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Company", label:"Click to Sort Column A", sortable:true},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Phone", label:"Not Sortable Column B"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Contact", label:"Click to Sort Column C", sortable:true}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Company Bee", Phone:"415-555-1234", Contact:"Sally Spencer"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Acme Company", Phone:"650-555-4444", Contact:"John Jones"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Industrial Industries", Phone:"408-555-5678", Contact:"Robin Smith"}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly columnset: cols,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly recordset: data,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly summary: "Contacts list",
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly caption: "Table with simple column sorting"
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly .render("#sort");
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<h6>Pre-sorted Data</h6>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>Often data is already sorted when it loads, and we want the data to reverse-sort the first time the user clicks on the column. In that case, define the `lastSortedBy` value in the DataTableSort plugin to indicate the field that is already sorted and whether it is sorted in "asc" or "desc" order.</p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny DonnellyYUI().use("datatable-sort", function(Y) {
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Company", label:"Click to Sort Column A", sortable:true},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Phone", label:"Not Sortable Column B"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Contact", label:"Click to Sort Column C", sortable:true}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly presortedData = [
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Acme Company", Phone:"415-555-1234", Contact:"John Jones"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Company Bee", Phone:"650-555-4444", Contact:"Sally Spencer"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Industrial Industries", Phone:"408-555-5678", Contact:"Robin Smith"}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly columnset: cols,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly recordset: presortedData,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly summary: "Contacts list",
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly caption: "This table loads with presorted data"
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly lastSortedBy: {
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly field: "Company",
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly .render("#presorted");
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<h6>Configurable Trigger</h6>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>By default, sorts will be triggered when the user clicks on the TH element of a sortable column, which fires a `theadCellClick` DataTable event. You can set this to be any other DataTable custom event by setting the `trigger` attribute in the DataTableSort plugin constructor. Note: Since the `trigger` attribute is `initOnly`, this value can only be set in the plugin constructor and not after the plugin has been instantiated.</p>
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly<p>A related change worth making is to remove the link from the TH content, since the user will not be clicking to sort in this implementation. Simply set the `template` attribute to be the unadorned `"{value}"` string.
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny DonnellyYUI().use("datatable-sort", function(Y) {
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Company", label:"Dblclick to Sort A", sortable:true},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Phone", label:"Not Sortable Column B"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {key:"Contact", label:"Dblclick to Sort C", sortable:true}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Company Bee", Phone:"415-555-1234", Contact:"Sally Spencer"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Acme Company", Phone:"650-555-4444", Contact:"John Jones"},
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly {Company:"Industrial Industries", Phone:"408-555-5678", Contact:"Robin Smith"}
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly columnset: cols,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly recordset: data,
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly summary: "Contacts list",
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly caption: "This table sorts on doubleclick"
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly trigger: "theadCellDblclick",
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly template: "{value}"
cf6c1ae1ed15095f8dc269bb9d7a373a1b87990eJenny Donnelly .render("#dblclick");