Readme.md 2.4 KB

KeyTable for DataTables

This package contains distribution files for the KeyTable extension for DataTables. Only the core software for this library is contained in this package - to be correctly styled, a styling package for KeyTable must also be included. Styling options include DataTable's native styling, Bootstrap and Foundation.

KeyTable allows you to use keyboard navigation on a DataTables enhanced table, like an Excel spreadsheet - a cell shows a focus outline which can be moved using the keyboard or mouse operations. This can be particularly useful in an editable table that uses Editor allowing end users to update data very quickly.

Installation

Browser

For inclusion of this library using a standard <script> tag, rather than using this package, it is recommended that you use the DataTables download builder which can create CDN or locally hosted packages for you, will all dependencies satisfied.

npm

npm install datatables.net-keytable
var $ = require( 'jquery' );
require( 'datatables.net-keytable' )( window, $ );

bower

bower install --save datatables.net-keytable

Documentation

Full documentation of the DataTables options, API and plug-in interface are available on the DOCS_LINK. The site also contains information on the wide variety of plug-ins that are available for DataTables, which can be used to enhance and customise your table even further.

Bug / Support

Support for DataTables is available through the DataTables forums and commercial support options are available.

Contributing

If you are thinking of contributing code to DataTables, first of all, thank you! All fixes, patches and enhancements to DataTables are very warmly welcomed. This repository is a distribution repo, so patches and issues sent to this repo will not be accepted. Instead, please direct pull requests to the DataTables/KeyTable. For issues / bugs, please direct your questions to the DataTables forums.

License

This software is released under the MIT license. You are free to use, modify and distribute this software, but all copyright information must remain.