56 lines
2.3 KiB
Markdown
56 lines
2.3 KiB
Markdown
# FixedColumns for DataTables
|
|
|
|
This package contains distribution files for the [FixedColumns extension](https://datatables.net/extensions/fixedcolumns) for [DataTables](https://datatables.net/). Only the core software for this library is contained in this package - to be correctly styled, a styling package for FixedColumns must also be included. Styling options include DataTable's native styling, [Bootstrap](http://getbootstrap.com) and [Foundation](http://foundation.zurb.com/).
|
|
|
|
FixedColumns provides the ability to fix one or more columns to the left and / or right hand side of a DataTable that scrolls along the x-axis. This can be used if the columns show grouping, index or similar information.
|
|
|
|
|
|
## 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](//datatables.net/download) which can create CDN or locally hosted packages for you, will all dependencies satisfied.
|
|
|
|
### npm
|
|
|
|
```
|
|
npm install datatables.net-fixedcolumns
|
|
```
|
|
|
|
ES3 Syntax
|
|
```
|
|
var $ = require( 'jquery' );
|
|
require( 'datatables.net-fixedcolumns' )( window, $ );
|
|
```
|
|
|
|
ES6 Syntax
|
|
```
|
|
import 'datatables.net-fixedcolumns'
|
|
```
|
|
|
|
### bower
|
|
|
|
```
|
|
bower install --save datatables.net-fixedcolumns
|
|
```
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
Full documentation and examples for FixedColumns can be found [on the website](https://datatables.net/extensions/fixedcolumns).
|
|
|
|
## Bug / Support
|
|
|
|
Support for DataTables is available through the [DataTables forums](//datatables.net/forums) and [commercial support options](//datatables.net/support) 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/FixedColumns](http://github.com/DataTables/FixedColumns). For issues / bugs, please direct your questions to the [DataTables forums](//datatables.net/forums).
|
|
|
|
|
|
## License
|
|
|
|
This software is released under the [MIT license](//datatables.net/license). You are free to use, modify and distribute this software, but all copyright information must remain.
|