TableSort

A flexible modern table-sort js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/table-sort

NPM

npm i @pluginjs/table-sort

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/table-sort/dist/table-sort.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/table-sort/dist/table-sort.css">

Production:

<script src="https://unpkg.com/@pluginjs/table-sort/dist/table-sort.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/table-sort/dist/table-sort.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import TableSort from "@pluginjs/table-sort"
import "@pluginjs/table-sort/dist/table-sort.css"

TableSort.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/table-sort/dist/table-sort.css")
const TableSort = require("@pluginjs/table-sort")

TableSort.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/table-sort/dist/table-sort.css">
<script src="https://unpkg.com/@pluginjs/table-sort/dist/table-sort.js"></script>
<script>
  Pj.tableSort('.element', options)
</script>

API

Options

Options are called on tableSort instances through the tableSort options itself. You can also save the instances to variable for further use.

Name | Description | Default --|--|-- "icons" | Set table icon | {"sort":"pj-icon pj-icon-sort","asc":"pj-icon pj-icon-sort-ascending","desc":"pj-icon pj-icon-sort-descending"}

Events

Events are called on tableSort instances through the tableSort events itself. You can also save the instances to variable for further use.

Name | Description --|-- "update" | Gets fired when plugin is destroy "ready" | Gets fired when plugin is ready "enable" | Gets fired when plugin is enabled "disable" | Gets fired when plugin is disabled "destroy" | Gets fired when plugin is destroy

Methods

Methods are called on tableSort instances through the tableSort method itself. You can also save the instances to variable for further use.

Name | Description --|-- "init" | Initial plugin "enable" | Enabled plugin if plugin is disabled "disable" | Disable plugin "destroy" | Destroy plugin "append" | Append data to table "replace" | Replace data to table "sort" | Sort data to table

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-tableSort

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/table-sort is Licensed under the GPL-v3 license.

If you want to use @pluginjs/table-sort project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.