UNPKG

2.8 kBTypeScriptView Raw
1import { CSSDeclaration, OneDArray, TColumn, TData } from './types';
2import Storage from './storage/storage';
3import Pipeline from './pipeline/pipeline';
4import Tabular from './tabular';
5import { SearchConfig } from './view/plugin/search/search';
6import { PaginationConfig } from './view/plugin/pagination';
7import Header from './header';
8import { ServerStorageOptions } from './storage/server';
9import { GenericSortConfig } from './view/plugin/sort/sort';
10import { Language, Translator } from './i18n/language';
11import { ComponentChild, RefObject } from 'preact';
12import { EventEmitter } from './util/eventEmitter';
13import { GridEvents } from './events';
14import { PluginManager, Plugin } from './plugin';
15import Grid from './grid';
16import { Store } from './state/store';
17export declare const ConfigContext: import("preact").Context<any>;
18export interface Config {
19 instance: Grid;
20 store: Store;
21 eventEmitter: EventEmitter<GridEvents>;
22 plugin: PluginManager;
23 container?: Element;
24 tableRef?: RefObject<HTMLTableElement>;
25 data?: TData | (() => TData) | (() => Promise<TData>);
26 server?: ServerStorageOptions;
27 header?: Header;
28 from: HTMLElement;
29 storage: Storage<any>;
30 processingThrottleMs: number;
31 pipeline: Pipeline<Tabular>;
32 autoWidth: boolean;
33 width: string;
34 height: string;
35 pagination: PaginationConfig | boolean;
36 sort: GenericSortConfig | boolean;
37 translator: Translator;
38 fixedHeader: boolean;
39 resizable: boolean;
40 columns: OneDArray<TColumn | string | ComponentChild>;
41 search: SearchConfig | boolean;
42 language: Language;
43 plugins?: Plugin<any>[];
44 style?: Partial<{
45 table: CSSDeclaration;
46 td: CSSDeclaration;
47 th: CSSDeclaration;
48 container: CSSDeclaration;
49 header: CSSDeclaration;
50 footer: CSSDeclaration;
51 }>;
52 className?: Partial<{
53 table: string;
54 th: string;
55 thead: string;
56 tbody: string;
57 tr: string;
58 td: string;
59 container: string;
60 footer: string;
61 header: string;
62 search: string;
63 sort: string;
64 pagination: string;
65 paginationSummary: string;
66 paginationButton: string;
67 paginationButtonNext: string;
68 paginationButtonCurrent: string;
69 paginationButtonPrev: string;
70 loading: string;
71 notfound: string;
72 error: string;
73 }>;
74}
75export declare class Config {
76 constructor();
77 assign(partialConfig: Partial<Config>): Config;
78 update(partialConfig: Partial<Config>): Config;
79 static defaultConfig(): Partial<Config>;
80 static fromPartialConfig(partialConfig: Partial<Config>): Partial<Config>;
81}
82
\No newline at end of file