kruster/index.d.ts

A small tool to help improve the rendering performance of very large HTML tables.

// Type definitions for Kruster 1.2.9
// Project: Kruster
// Definitions by: nikolas howard <https://github.com/nikkorn>

export as namespace Kruster;

export = Kruster;

declare class Kruster {
    /**
     * Create a new instance of Kruster and apply modifications to target table body.
     * @param config the configuration options.
     */
    constructor(config: Kruster.Configuration);

    /**
     * Returns the table body without the DOM and style modifications made by Kruster.
     */
    getCleanTable(): Element;

    /**
     * Get an array of all of the table rows excluding Kruster rows.
     */
    getRows(): HTMLTableRowElement[];

    /**
     * Get the row element at the specified index.
     * @param index The row index.
     */
    getRowAt(index: number): HTMLTableRowElement;

    /**
     * Get the index of the specified row element.
     * @param rowElement The row element.
     */
    getRowIndex(rowElement: HTMLTableRowElement): number;

    /**
     * Refresh the instance to reflect changes to the table layout.
     */
    refresh(): void;

    /**
     * Destroys the instance, reverting the table to its original state.
     * @param removeTableModifications A flag defining whether the table should be cleansed of any modifications made by Kruster.
     */
    destroy(removeTableModifications?: boolean): void;
}

declare namespace Kruster {
    /**
     * Configuration options to create a new instance of Kruster.
     */
    interface Configuration {
        /**
         * The target table body.
         */
        tableBody: Element;

        /**
         * The potentially scrollable parent of the table body.
         */
        scrollableParent: Element;

        /**
         * The size of the the table row clusters. Default: 100.
         */
        clusterSize?: number;

        /**
         * Whether Kruster should refresh in response to  window resize events. Default: false.
         */
        autoRefresh?: boolean;

        /**
         * Callback which is called when a cluster is made visible.
         */
        onClusterShow?(event: ClusterChangeEvent): void;

        /**
         * Callback which is called when a cluster is made hidden.
         */
        onClusterHide?(event: ClusterChangeEvent): void;
    }

    /**
     * Cluster visibility change event details.
     */
    interface ClusterChangeEvent {
        /**
         * The cluster index.
         */
        clusterIndex: number;

        /**
         * The row elements of the cluster.
         */
        rows: HTMLTableRowElement[];
    }
}