jquery-sync-table-column-widths

• NAME
• INSTALLATION
• SYNOPSIS
  • Load
  • Use
• TYPES
  • Input
  • Output
  • MasterSelector
  • Options
• EXPORTS
  • Plugin (default)
• METHODS
  • JQuery#syncColumnWidths
• DEVELOPMENT
  • NPM Scripts
• COMPATIBILITY
• SEE ALSO
• VERSION
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

jquery-sync-table-column-widths - a jQuery plugin to synchronize table column widths

INSTALLATION

$ npm install jquery-sync-table-column-widths

SYNOPSIS

Load

import Plugin from 'jquery-sync-table-column-widths'
 
const jQuery = require('jquery')
const plugin = Plugin.register(jQuery, options)
 
plugin.on('sync', table => { ... })

Use

$('.my-tables').syncColumnWidths()
 
// or
 
$('.my-tables').syncColumnWidths(master)

TYPES

The following types are referenced in the exports below.

Input

type Input = (
    this: HTMLTableCellElement,
    index: number,
    table: HTMLTableElement,
    cell: HTMLTableCellElement
) => string;

Output

type Output = (
    this: { index: number; state: Object },
    cell: HTMLTableCellElement,
    table: HTMLTableElement
) => string;

MasterSelector

type MasterSelector = JQuery.Selector | HTMLTableElement | ((HTMLTableElement) => boolean)

Options

type Options {
    input?: Input,
    output?: Output,
    debug?: boolean,
    master?: MasterSelector,
}

EXPORTS

Plugin (default)

import Plugin from 'jquery-sync-column-widths'
 
Plugin.register(jQuery, options)

METHODS

JQuery#syncColumnWidths

Signature: syncColumnWidths(jQuery: JQuery, options?: Options) => this

DEVELOPMENT

NPM Scripts

The following NPM scripts are available:

• build - compile the plugin and package it for release
• clean - remove temporary files and build artifacts
• test - run the test suite

COMPATIBILITY

This plugin should work in any browser supported by jQuery. It has been tested with jQuery 3.3.1, though it may work with older versions.

SEE ALSO

• jQuery

VERSION

0.4.0

AUTHOR

chocolateboy

COPYRIGHT AND LICENSE

Copyright © 2018-2019 by chocolateboy.

This is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.