ag-grid-community/dist/types/src/interfaces/iFrameworkOverrides.d.ts

Advanced Data Grid / Data Table supporting Javascript / Typescript / React / Angular / Vue

import type { LocalEventService } from '../agStack/events/localEventService';
import type { AgFrameworkOverrides } from '../agStack/interfaces/agFrameworkOverrides';
import type { IFrameworkEventListenerService } from './iFrameworkEventListenerService';
/** @internal AG_GRID_INTERNAL - Not for public use. Can change / be removed at any time. */
export interface IFrameworkOverrides extends AgFrameworkOverrides {
    /** Used for Angular event listener wrapping */
    createLocalEventListenerWrapper?(existingFrameworkEventListenerService: IFrameworkEventListenerService<any, any> | undefined, localEventService: LocalEventService<any>): IFrameworkEventListenerService<any, any> | undefined;
    /** Used for Angular event listener wrapping */
    createGlobalEventListenerWrapper?(): IFrameworkEventListenerService<any, any>;
    frameworkComponent(name: string, components?: any): any;
    isFrameworkComponent(comp: any): boolean;
    /**
     * Allows Angular to batch render Cell Components all within a single Angular ngZone.run().
     */
    readonly batchFrameworkComps: boolean;
    /**
     * Which rendering engine is used for the grid components. Can be either 'vanilla' or 'react'.
     */
    readonly renderingEngine: 'vanilla' | 'react';
    /**
     * Returns the framework specific url for linking to a documentation page.
     * @param path Optional path to append to the base url. i.e 'aligned-grids' Does not need the leading `/`
     */
    getDocLink(path?: string): string;
    /** Used by `RowRenderer` when getting lock. Allows React async refreshes to work. */
    getLockOnRefresh?(): void;
    /** Used by `RowRenderer` when releasing lock. Allows React async refreshes to work. */
    releaseLockOnRefresh?(): void;
    /** Used by the CtrlsService to decide whether to trigger the whenReady callbacks asynchronously.
     * Required for React to work with StrictMode from v19 with the current implementation of the CtrlsService.
     */
    runWhenReadyAsync?(): boolean;
}