Skip to content

Latest commit

 

History

History
197 lines (126 loc) · 6 KB

README.md

File metadata and controls

197 lines (126 loc) · 6 KB
Raw

Tablesaw Build Status

Filament Group

A set of plugins for responsive tables.

Table Modes

Stack

The Stack Table stacks the table headers to a two column layout with headers on the left when the viewport width is less than 40em (640px).

<table class="tablesaw tablesaw-stack" data-mode="stack">

If you only want to use the Stack Table and don’t want all the extra features below (save yourself some bytes), Tablesaw provides a Stack-Only version.

Toggle

The Column Toggle Table allows the user to select which columns they want to be visible.

<table data-mode="columntoggle">

Table headers must have a data-priority attribute to be eligible to toggle. data-priority is a numeric value from 1 to 6, which determine default breakpoints at which a column will show. As of first release, the defaults are:

<th data-priority="persist"><!-- Not eligible for toggle, always shows --></th>
<th data-priority="1"><!-- Shows at (min-width: 20em) (320px) --></th>
<th data-priority="2"><!-- Shows at (min-width: 30em) (480px) --></th>
<th data-priority="3"><!-- Shows at (min-width: 40em) (640px) --></th>
<th data-priority="4"><!-- Shows at (min-width: 50em) (800px) --></th>
<th data-priority="5"><!-- Shows at (min-width: 60em) (960px) --></th>
<th data-priority="6"><!-- Shows at (min-width: 70em) (1120px) --></th>

Add a Mini Map

<table data-mode="columntoggle" data-minimap>

Swipe

Allows the user to use the swipe gesture (or use the left and right buttons) to navigate the columns.

<table data-mode="swipe">

Columns also respect the data-priority="persist" attribute.

<th data-priority="persist"><!-- Always shows --></th>

Add a Mini Map

<table data-mode="swipe" data-minimap>

Mini Map

Use data-minimap to add a series of small dots to show which columns are currently visible and which are hidden. Only available on swipe and columntoggle tables. Examples available above.

Mode Switcher

<table data-mode-switch>

<!-- With a different default mode -->
<table data-mode="swipe" data-mode-switch>

<!-- Exclude a mode from the switcher -->
<table data-mode-switch data-mode-exclude="columntoggle">

Sortable

Allows sorting on columns.

<table data-sortable>
    <thead>
        <tr>
            <!-- Default column -->
            <th data-sortable-col data-sortable-default-col>Rank</th>
            <th data-sortable-col>Movie Title</th>
            <th data-sortable-col>Year</th>
            <th data-sortable-col><abbr title="Rotten Tomato Rating">Rating</abbr></th>
            <!-- Unsortable column -->
            <th>Reviews</th>
        </tr>
    </thead>
    ...

Use data-sortable-switch to add a form element to choose the sort order.

<table data-sortable data-sortable-switch>

Kitchen Table Sink

All of the above options combined into a single table.

Getting Started

TableSaw requires Respond.js for IE8- support.

Using Stack-Only TableSaw

As shown above, we provide a Stack-mode-only package of TableSaw. It’s a barebones version that doesn’t include any of the other features above.

<link rel="stylesheet" href="tablesaw.css">
<!--[if lt IE 9]><script src="respond.min.js"></script><!--<![endif]-->
<script src="tablesaw.js"></script>

And then:

<table class="tablesaw tablesaw-stack" data-mode="stack">

Check out the Stack-Only demo to see a working example.

Using Stack-Only TableSaw SCSS Mixin

To easily customize the breakpoint at which the stack table switches, use the SCSS mixin. First, include the tablesaw.stackonly.scss file instead of tablesaw.stackonly.css in your SASS. Then, use a parent selector on your table.

<div class="my-parent-selector">
    <table class="tablesaw" data-mode="stack">

Include the mixin like so:

.my-parent-selector {
  @include tablesaw-stack( 50em );
}

The argument to tablesaw-stack is the breakpoint at which the table will switch from columns to stacked.

The Full TableSaw

If you want the other modes, it’ll take a little bit more configuration.

The columntoggle mode requires the Filament Group dialog. Install all dependencies easily using bower:

bower install

(if bower is installed globally) or

./node_modules/.bin/bower install

(if bower is not installed globally)

<link rel="stylesheet" href="bower_components/filament-dialog/dialog.css">
<link rel="stylesheet" href="tablesaw.css">

<!--[if lt IE 9]><script src="respond.min.js"></script><!--<![endif]-->
<script src="bower_components/jquery/jquery.js"></script>
<script src="bower_components/filament-dialog/dialog.js"></script>
<script src="bower_components/filament-dialog/dialog-init.js"></script>
<script src="tablesaw.js"></script>

Next include the tablesaw icons in src/icons with your grunticon build and include the grunticon loader.

Check out any of the demos above for complete working examples.

Tests