/** * Copied from `datatables.net-fixedheader/types/types.d.ts` * so that we do not have to import the full module to get the types */ import type { Api } from 'datatables.net'; declare module 'datatables.net' { interface Config { fixedHeader?: boolean | ConfigFixedHeader; } interface Api { /** * FixedHeader methods container * * @returns Api for chaining with the additional FixedHeader methods */ fixedHeader: ApiFixedHeaderMethods; } interface DataTablesStatic { /** * FixedHeader class */ FixedHeader: { /** * Create a new FixedHeader instance for the target DataTable */ new (dt: Api, settings: boolean | ConfigFixedHeader): DataTablesStatic['FixedHeader']; /** * FixedHeader version */ version: string; /** * Default configuration values */ defaults: ConfigFixedHeader; }; } } interface ConfigFixedHeader { footer?: boolean; footerOffset?: number; header?: boolean; headerOffset?: number; } interface ApiFixedHeaderMethods extends Api { /** * Recalculate the position of the DataTable on the page and adjust the fixed element as appropriate. * * @returns The DataTables API for chaining */ adjust(): Api; /** * Disable the fixed elements * * @returns The DataTables API for chaining */ disable(): Api; /** * Enable / disable the fixed elements * * @param enable Flag to indicate if the FixedHeader elements should be enabled or disabled, default true. * @returns The DataTables API for chaining */ enable(enable?: boolean): Api; /** * Simply gets the status of FixedHeader for this table. * * @returns true if FixedHeader is enabled on this table. false otherwise. */ enabled(): boolean; /** * Get the fixed footer's offset. * * @returns The current footer offset */ footerOffset(): number; /** * Set the fixed footer's offset * * @param offset The offset to be set * @returns DataTables Api for chaining */ footerOffset(offset: number): Api; /** * Get the fixed header's offset. * * @returns The current header offset */ headerOffset(): number; /** * Set the fixed header's offset * * @param offset The offset to be set * @returns The DataTables API for chaining */ headerOffset(offset: number): Api; } export {};