Skip to content

Build your personal knowledge base with Trilium Notes

3.2 KB
Raw Blame
import "tabulator-tables/dist/css/tabulator.css";
import "../../../../src/stylesheets/table.css";

import { isValidElement, RefObject } from "preact";
import { useContext, useEffect, useLayoutEffect, useRef } from "preact/hooks";
import { JSX } from "preact/jsx-runtime";
import { EventCallBackMethods, Module, Options, Tabulator as VanillaTabulator } from "tabulator-tables";

import { ParentComponent, renderReactWidget } from "../../react/react_utils";

export interface TableProps<T extends {}> extends Omit<Options, "data" | "footerElement" | "index"> {
    tabulatorRef?: RefObject<VanillaTabulator | null>;
    className?: string;
    data?: T[];
    modules?: (new (table: VanillaTabulator) => Module)[];
    events?: Partial<EventCallBackMethods>;
    index?: keyof T;
    footerElement?: string | HTMLElement | JSX.Element;
    onReady?: () => void;
}

export default function Tabulator<T extends {}>({ className, columns, data, modules, tabulatorRef: externalTabulatorRef, footerElement, events, index, dataTree, onReady, ...restProps }: TableProps<T>) {
    const parentComponent = useContext(ParentComponent);
    const containerRef = useRef<HTMLDivElement>(null);
    const tabulatorRef = useRef<VanillaTabulator>(null);

    useLayoutEffect(() => {
        if (!modules) return;
        for (const module of modules) {
            VanillaTabulator.registerModule(module);
        }
    }, [modules]);

    useLayoutEffect(() => {
        if (!containerRef.current) return;

        const tabulator = new VanillaTabulator(containerRef.current, {
            columns,
            data,
            footerElement: (parentComponent && isValidElement(footerElement) ? renderReactWidget(parentComponent, footerElement)[0] : undefined),
            index: index as string | number | undefined,
            dataTree,
            ...restProps
        });

        tabulator.on("tableBuilt", () => {
            tabulatorRef.current = tabulator;
            if (externalTabulatorRef) {
                externalTabulatorRef.current = tabulator;
            }
            onReady?.();
        });

        return () => tabulator.destroy();
    }, [ dataTree ] );

    useEffect(() => {
        const tabulator = tabulatorRef.current;
        if (!tabulator || !events) return;

        for (const [ eventName, handler ] of Object.entries(events)) {
            tabulator.on(eventName as keyof EventCallBackMethods, handler);
        }

        return () => {
            for (const [ eventName, handler ] of Object.entries(events)) {
                tabulator.off(eventName as keyof EventCallBackMethods, handler);
            }
        };
    }, Object.values(events ?? {}));

    // Columns before data: `setColumns()` resets the scroll at once, while `replaceData()` renders
    // in position a microtask later, so set the other way round it renders at the old offset.
    useEffect(() => {
        if (!columns) return;
        tabulatorRef.current?.setColumns(columns);
    }, [ columns ]);
    // Change in data. replaceData rather than setData: it renders in position instead of
    // resetting the scroll (see resetScroll in Tabulator's RowManager).
    useEffect(() => { tabulatorRef.current?.replaceData(data); }, [ data ]);

    return (
        <div ref={containerRef} className={className} />
    );
}