ag-grid-react
Version:
AG Grid React Component
27 lines (26 loc) • 1.24 kB
TypeScript
import React from 'react';
import type { Module } from 'ag-grid-community';
export interface AgGridProviderProps {
/**
* The AG Grid Modules to be used by all grid instances within this provider.
*/
modules: Module[];
/**
* The AG Grid license key to be used by all grid instances within this provider when Enterprise features are used.
*/
licenseKey?: string;
/**
* The child components that will have access to the AG Grid context.
*/
children: React.ReactNode;
}
export declare const ModulesContext: React.Context<Module[]>;
export declare const LicenseContext: React.Context<string | undefined>;
/**
* Provide AG Grid Modules to all grid instances within this scope via React Context. If nested, modules are accumulated from all providers and provided to each AgGridReact instance.
*
* If a licenseKey is provided it will be passed to the global `LicenseManager.setLicenseKey(licenseKey)`.
*
* This is an alternative to providing modules globally via `ModuleRegistry.registerModules()` and setting the license key via `LicenseManager.setLicenseKey()`.
*/
export declare function AgGridProvider({ modules, licenseKey, children }: Readonly<AgGridProviderProps>): React.JSX.Element;