---
id: "packages/active-grid/api"
title: "All exports"
description: "Every export of active-grid, generated from the package source - an index of the components, functions, constants and types, with a page per component and per topic."
url: "/packages/active-grid/api"
locale: "en"
revision: "f59246b0c5e31dca"
---

# All exports

> [!NOTE]
> **Generated from the source**
>
> Every export of active-grid, read from the package itself, with a page per
> component and per topic. The package's own reference explains the main
> surfaces in context: [Grid props](/packages/active-grid/props), [Columns
> API](/packages/active-grid/columns-api), [Filters
> API](/packages/active-grid/filters-api), [Server
> API](/packages/active-grid/server-api) and [Cells and
> utilities](/packages/active-grid/cells-and-utilities). The stylesheet is the
> second entry point: `@workspace/active-grid/styles.css`.

## Components

**[GridDefaults](/packages/active-grid/api/context)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridDefaults`](/packages/active-grid/api/context#api-griddefaults) | component | The one defaults boundary of the grid: the presentation, the translator and the behaviour configuration for every grid rendered below it. |
| [`GridDefaultsProps`](/packages/active-grid/api/context#active-grid-griddefaultsprops) | interface |  |

**[ActiveGrid](/packages/active-grid/api/components-grid)**

| Export | Kind | Description |
| --- | --- | --- |
| [`ActiveGrid`](/packages/active-grid/api/components-grid#api-activegrid) | component |  |

**[LookupGrid](/packages/active-grid/api/lookup-grid)**

| Export | Kind | Description |
| --- | --- | --- |
| [`LookupGrid`](/packages/active-grid/api/lookup-grid#api-lookupgrid) | component |  |
| [`LookupGridProps`](/packages/active-grid/api/lookup-grid#active-grid-lookupgridprops) | type | Discriminated union: server (default) or client mode. |

**[Cells](/packages/active-grid/api/cells)**

| Export | Kind | Description |
| --- | --- | --- |
| [`BadgeCell`](/packages/active-grid/api/cells#api-badgecell) | component | Categorical badge cell: kind, type, department, category, origin. |
| [`DateCell`](/packages/active-grid/api/cells#api-datecell) | component |  |
| [`ExpanderCell`](/packages/active-grid/api/cells#api-expandercell) | component |  |
| [`getExpanderColumn`](/packages/active-grid/api/cells#active-grid-getexpandercolumn) | function |  |
| [`getSelectionColumn`](/packages/active-grid/api/cells#active-grid-getselectioncolumn) | function |  |
| [`LinkCell`](/packages/active-grid/api/cells#api-linkcell) | component | A cell that links its value. |
| [`SelectionCell`](/packages/active-grid/api/cells#api-selectioncell) | component |  |
| [`StatusCell`](/packages/active-grid/api/cells#api-statuscell) | component | Status presentation in a cell: the grid's `UiStatusBadge` on the fixed `GridStatusTone` axis, with the label derivation added. |
| [`TextCell`](/packages/active-grid/api/cells#api-textcell) | component | Minimal text renderer — no opinion on font or layout. |

**[Controls](/packages/active-grid/api/controls)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridPagination`](/packages/active-grid/api/controls#api-gridpagination) | component |  |
| [`GroupingToolbar`](/packages/active-grid/api/controls#api-groupingtoolbar) | component |  |

**[GridContextMenu](/packages/active-grid/api/menus)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridContextMenu`](/packages/active-grid/api/menus#api-gridcontextmenu) | component |  |

**[Primitives](/packages/active-grid/api/primitives)**

| Export | Kind | Description |
| --- | --- | --- |
| [`SortIndicator`](/packages/active-grid/api/primitives#api-sortindicator) | component |  |
| [`CellErrorBoundary`](/packages/active-grid/api/primitives#api-cellerrorboundary) | component | A lightweight Error Boundary specifically for table cells. |
| [`FilterIcon`](/packages/active-grid/api/primitives#api-filtericon) | component | AG-Grid style filter icon (three horizontal lines). |

**[Filters (components)](/packages/active-grid/api/components-filters)**

| Export | Kind | Description |
| --- | --- | --- |
| [`BooleanFilter`](/packages/active-grid/api/components-filters#api-booleanfilter) | component |  |
| [`DateFilter`](/packages/active-grid/api/components-filters#api-datefilter) | component |  |
| [`FilterCheckboxItem`](/packages/active-grid/api/components-filters#api-filtercheckboxitem) | component |  |
| [`FilterClearButton`](/packages/active-grid/api/components-filters#api-filterclearbutton) | component | The clear button of an inline filter. |
| [`FilterDateInput`](/packages/active-grid/api/components-filters#api-filterdateinput) | component |  |
| [`FilterNumberInput`](/packages/active-grid/api/components-filters#api-filternumberinput) | component | Human number input in a popover filter. |
| [`FilterOperatorSelect`](/packages/active-grid/api/components-filters#api-filteroperatorselect) | component |  |
| [`FilterPopover`](/packages/active-grid/api/components-filters#api-filterpopover) | component |  |
| [`FilterPopoverBody`](/packages/active-grid/api/components-filters#api-filterpopoverbody) | component |  |
| [`FilterPopoverContent`](/packages/active-grid/api/components-filters#api-filterpopovercontent) | component |  |
| [`FilterPopoverHeader`](/packages/active-grid/api/components-filters#api-filterpopoverheader) | component |  |
| [`FilterPopoverTrigger`](/packages/active-grid/api/components-filters#api-filterpopovertrigger) | component |  |
| [`FilterSearchInput`](/packages/active-grid/api/components-filters#api-filtersearchinput) | component |  |
| [`FilterTextInput`](/packages/active-grid/api/components-filters#api-filtertextinput) | component |  |
| [`FilterWrapper`](/packages/active-grid/api/components-filters#api-filterwrapper) | component |  |
| [`NumberFilter`](/packages/active-grid/api/components-filters#api-numberfilter) | component | Inline number filter — AG Grid Floating Filter pattern. |
| [`SelectFilter`](/packages/active-grid/api/components-filters#api-selectfilter) | component |  |
| [`TextFilter`](/packages/active-grid/api/components-filters#api-textfilter) | component | Inline text filter — AG Grid Floating Filter pattern. |

## Functions, constants and types

**[Grid configuration error](/packages/active-grid/api/grid-configuration-error)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridConfigurationError`](/packages/active-grid/api/grid-configuration-error#active-grid-gridconfigurationerror) | class | A grid configuration the grid cannot run with. |
| [`GridConfigurationErrorCode`](/packages/active-grid/api/grid-configuration-error#active-grid-gridconfigurationerrorcode) | type | The closed set of configuration mistakes the grid refuses. |
| [`GridConfigurationErrorOptions`](/packages/active-grid/api/grid-configuration-error#active-grid-gridconfigurationerroroptions) | interface |  |

**[GridTextDirection](/packages/active-grid/api/direction)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridTextDirection`](/packages/active-grid/api/direction#active-grid-gridtextdirection) | type | The base direction of one text run. |

**[Logger](/packages/active-grid/api/logger)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridDiagnostic`](/packages/active-grid/api/logger#active-grid-griddiagnostic) | interface | One diagnostic of the grid. |
| [`GridDiagnosticLevel`](/packages/active-grid/api/logger#active-grid-griddiagnosticlevel) | type | How serious a grid diagnostic is. |
| [`GridDiagnosticSink`](/packages/active-grid/api/logger#active-grid-griddiagnosticsink) | type | Where the grid delivers its diagnostics. |

**[Grid translation context](/packages/active-grid/api/grid-translation-context)**

| Export | Kind | Description |
| --- | --- | --- |
| [`useGridTranslation`](/packages/active-grid/api/grid-translation-context#active-grid-usegridtranslation) | hook | The effective translator of the enclosing grid, including an instance override: for a custom cell or editor that renders grid-owned words. |
| [`useGridLocale`](/packages/active-grid/api/grid-translation-context#active-grid-usegridlocale) | hook | The effective presentation of the enclosing grid, including an instance override: a locale code or a presentation context. |
| [`GridTranslateFunction`](/packages/active-grid/api/grid-translation-context#active-grid-gridtranslatefunction) | type | Translation function type — compatible with active-i18n's TranslateFunction. |

**[englishGridTranslator](/packages/active-grid/api/english-grid-translator)**

| Export | Kind | Description |
| --- | --- | --- |
| [`englishGridTranslator`](/packages/active-grid/api/english-grid-translator#active-grid-englishgridtranslator) | function | The package's English translator, for a host, fixture, test or example that wants English and says so by passing it (`t={englishGridTranslator}` or `<GridDefaults… |

**[createContextMenu](/packages/active-grid/api/context-menu-utils)**

| Export | Kind | Description |
| --- | --- | --- |
| [`createContextMenu`](/packages/active-grid/api/context-menu-utils#active-grid-createcontextmenu) | function | Utility to build context menu items in a type-safe way. |

**[clearAllGridStates](/packages/active-grid/api/clear-grid-states)**

| Export | Kind | Description |
| --- | --- | --- |
| [`clearAllGridStates`](/packages/active-grid/api/clear-grid-states#active-grid-clearallgridstates) | function | Clear all grid state entries from localStorage. |

**[Build interval where](/packages/active-grid/api/build-interval-where)**

| Export | Kind | Description |
| --- | --- | --- |
| [`buildIntervalWhere`](/packages/active-grid/api/build-interval-where#active-grid-buildintervalwhere) | function | Builds a Prisma-shaped `where` fragment for an `IntervalFilterValue` over two numeric boundary fields. |
| [`IntervalFields`](/packages/active-grid/api/build-interval-where#active-grid-intervalfields) | interface | The two numeric boundary fields a row's interval is stored in. |

**[GridStatePriority](/packages/active-grid/api/resolve-initial-state)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridStatePriority`](/packages/active-grid/api/resolve-initial-state#active-grid-gridstatepriority) | type | Conflict-resolution strategy between the two external state sources — the URL (`enableUrlSync`) and localStorage (`enablePersistence`) — for the four *contested* state slices. |

**[Server contract (helpers)](/packages/active-grid/api/helpers-server-contract)**

| Export | Kind | Description |
| --- | --- | --- |
| [`aggregateCount`](/packages/active-grid/api/helpers-server-contract#active-grid-aggregatecount) | function | Aggregate mapping for a count. |
| [`aggregateScalar`](/packages/active-grid/api/helpers-server-contract#active-grid-aggregatescalar) | function | Aggregate mapping on a scalar field. |
| [`byCount`](/packages/active-grid/api/helpers-server-contract#active-grid-bycount) | function | Sort mapping on the count of a relation. |
| [`byField`](/packages/active-grid/api/helpers-server-contract#active-grid-byfield) | function | Sort mapping on a scalar field. |
| [`everyByField`](/packages/active-grid/api/helpers-server-contract#active-grid-everybyfield) | function | Filter mapping with relation `every`. |
| [`fieldFilter`](/packages/active-grid/api/helpers-server-contract#active-grid-fieldfilter) | function | Filter mapping on a scalar field. |
| [`globalEveryByField`](/packages/active-grid/api/helpers-server-contract#active-grid-globaleverybyfield) | function | Global-search mapping with relation `every`. |
| [`globalField`](/packages/active-grid/api/helpers-server-contract#active-grid-globalfield) | function | Mark a column as participating in the global search-box (the toolbar's single-search input). |
| [`globalNoneByField`](/packages/active-grid/api/helpers-server-contract#active-grid-globalnonebyfield) | function | Global-search mapping with relation `none`. |
| [`globalSomeByField`](/packages/active-grid/api/helpers-server-contract#active-grid-globalsomebyfield) | function | Global-search mapping with relation `some`. |
| [`groupByField`](/packages/active-grid/api/helpers-server-contract#active-grid-groupbyfield) | function | Group-by mapping on a scalar field. |
| [`groupByRelation`](/packages/active-grid/api/helpers-server-contract#active-grid-groupbyrelation) | function | Group-by mapping that resolves through a relation. |
| [`multiField`](/packages/active-grid/api/helpers-server-contract#active-grid-multifield) | function | Filter mapping that ORs across multiple scalar paths. |
| [`noneByField`](/packages/active-grid/api/helpers-server-contract#active-grid-nonebyfield) | function | Filter mapping with relation `none`. |
| [`scalarField`](/packages/active-grid/api/helpers-server-contract#active-grid-scalarfield) | function | Shortcut that fills both `sort` and `filter` for a scalar column. |
| [`someByField`](/packages/active-grid/api/helpers-server-contract#active-grid-somebyfield) | function | Filter mapping with relation `some`. |

**[Server contract (types)](/packages/active-grid/api/types-server-contract)**

| Export | Kind | Description |
| --- | --- | --- |
| [`AggregateCountMapping`](/packages/active-grid/api/types-server-contract#active-grid-aggregatecountmapping) | interface |  |
| [`AggregateOp`](/packages/active-grid/api/types-server-contract#active-grid-aggregateop) | type |  |
| [`AggregateScalarMapping`](/packages/active-grid/api/types-server-contract#active-grid-aggregatescalarmapping) | interface |  |
| [`FilterFieldMapping`](/packages/active-grid/api/types-server-contract#active-grid-filterfieldmapping) | interface |  |
| [`FilterMultiFieldMapping`](/packages/active-grid/api/types-server-contract#active-grid-filtermultifieldmapping) | interface |  |
| [`FilterRelationMapping`](/packages/active-grid/api/types-server-contract#active-grid-filterrelationmapping) | interface |  |
| [`GlobalFieldMapping`](/packages/active-grid/api/types-server-contract#active-grid-globalfieldmapping) | interface |  |
| [`GlobalRelationMapping`](/packages/active-grid/api/types-server-contract#active-grid-globalrelationmapping) | interface |  |
| [`GroupByFieldMapping`](/packages/active-grid/api/types-server-contract#active-grid-groupbyfieldmapping) | interface |  |
| [`GroupByRelationMapping`](/packages/active-grid/api/types-server-contract#active-grid-groupbyrelationmapping) | interface |  |
| [`SerializableAggregateMapping`](/packages/active-grid/api/types-server-contract#active-grid-serializableaggregatemapping) | type |  |
| [`SerializableFilterMapping`](/packages/active-grid/api/types-server-contract#active-grid-serializablefiltermapping) | type |  |
| [`SerializableGlobalMapping`](/packages/active-grid/api/types-server-contract#active-grid-serializableglobalmapping) | type |  |
| [`SerializableGroupByMapping`](/packages/active-grid/api/types-server-contract#active-grid-serializablegroupbymapping) | type |  |
| [`SerializableSortMapping`](/packages/active-grid/api/types-server-contract#active-grid-serializablesortmapping) | type |  |
| [`ServerColumnContract`](/packages/active-grid/api/types-server-contract#active-grid-servercolumncontract) | interface | Client-side query-contract for a column. |
| [`SortCountMapping`](/packages/active-grid/api/types-server-contract#active-grid-sortcountmapping) | interface |  |
| [`SortFieldMapping`](/packages/active-grid/api/types-server-contract#active-grid-sortfieldmapping) | interface |  |

**[From active-helpers](/packages/active-grid/api/from-active-helpers)**

| Export | Kind | Description |
| --- | --- | --- |
| [`serializeDecimals`](/packages/active-grid/api/from-active-helpers#active-grid-serializedecimals) | function | Recursively convert decimal.js instances (Prisma `Decimal`) to plain numbers, so a query result can cross the server-to-client boundary, which does not serialize class instances. |

**[Filter utils](/packages/active-grid/api/filter-utils)**

| Export | Kind | Description |
| --- | --- | --- |
| [`evaluateFilter`](/packages/active-grid/api/filter-utils#active-grid-evaluatefilter) | function |  |
| [`evaluateFilterExpression`](/packages/active-grid/api/filter-utils#active-grid-evaluatefilterexpression) | function | Evaluate a filter expression tree against a row. |
| [`advancedFilterFn`](/packages/active-grid/api/filter-utils#active-grid-advancedfilterfn) | function | A predicate a column's `filterFn` may be set to directly. |

**[createLocaleSortFn](/packages/active-grid/api/locale-collation)**

| Export | Kind | Description |
| --- | --- | --- |
| [`createLocaleSortFn`](/packages/active-grid/api/locale-collation#active-grid-createlocalesortfn) | function | Builds a comparator that orders a column's text in `locale`. |

**[Export utils](/packages/active-grid/api/export-utils)**

| Export | Kind | Description |
| --- | --- | --- |
| [`copyToClipboard`](/packages/active-grid/api/export-utils#active-grid-copytoclipboard) | function | Copy rows to the clipboard as TSV. |
| [`exportToCSV`](/packages/active-grid/api/export-utils#active-grid-exporttocsv) | function |  |
| [`exportToCSVGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttocsvgrouped) | function | Export to CSV with group structure. |
| [`exportToCSVServerGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttocsvservergrouped) | function | Export server-side grouped data to CSV. |
| [`exportToExcel`](/packages/active-grid/api/export-utils#active-grid-exporttoexcel) | function |  |
| [`exportToExcelGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttoexcelgrouped) | function | Export to Excel with group structure. |
| [`exportToExcelServerGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttoexcelservergrouped) | function | Export server-side grouped data to Excel. |
| [`exportToJSON`](/packages/active-grid/api/export-utils#active-grid-exporttojson) | function |  |
| [`exportToJSONGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttojsongrouped) | function | Export to JSON with hierarchical group structure. |
| [`exportToJSONServerGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttojsonservergrouped) | function | Export server-side grouped data to JSON with hierarchical structure. |
| [`exportToPDF`](/packages/active-grid/api/export-utils#active-grid-exporttopdf) | function | Export rows to PDF as a formatted table. |
| [`exportToPDFGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttopdfgrouped) | function | Export to PDF with group structure. |
| [`exportToPDFServerGrouped`](/packages/active-grid/api/export-utils#active-grid-exporttopdfservergrouped) | function | Export server-side grouped data to PDF. |
| [`GridClipboardOptions`](/packages/active-grid/api/export-utils#active-grid-gridclipboardoptions) | interface | Options for the clipboard copy. |
| [`GridExcelExportOptions`](/packages/active-grid/api/export-utils#active-grid-gridexcelexportoptions) | type | The options of an XLSX export: the data-mode options every data format shares, plus the sheet's direction. |
| [`GridPdfExportOptions`](/packages/active-grid/api/export-utils#active-grid-gridpdfexportoptions) | interface | PDF is HUMAN output: always presentation, so always with a locale. |
| [`ServerGroupedExportConfig`](/packages/active-grid/api/export-utils#active-grid-servergroupedexportconfig) | interface | Configuration for server-side grouped export. |

**[Grid export error](/packages/active-grid/api/grid-export-error)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridExportError`](/packages/active-grid/api/grid-export-error#active-grid-gridexporterror) | class | Why a grid export did not produce a file. |
| [`GridExportErrorCode`](/packages/active-grid/api/grid-export-error#active-grid-gridexporterrorcode) | type | The closed set of export failures the grid names. |
| [`GridExportErrorOptions`](/packages/active-grid/api/grid-export-error#active-grid-gridexporterroroptions) | interface | What a `GridExportError` carries besides its code. |

**[Export fonts](/packages/active-grid/api/export-fonts)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridExportDirection`](/packages/active-grid/api/export-fonts#active-grid-gridexportdirection) | type | The direction a visual or workbook export is written in: `rtl` puts the first column on the right of a PDF page and opens an XLSX sheet right to left. |
| [`GridExportFontFace`](/packages/active-grid/api/export-fonts#active-grid-gridexportfontface) | interface | One font file of a family. |
| [`GridExportFontFamily`](/packages/active-grid/api/export-fonts#active-grid-gridexportfontfamily) | interface | A host font family, under the host's own name. |
| [`GridExportFonts`](/packages/active-grid/api/export-fonts#active-grid-gridexportfonts) | interface | The fonts of the grid's PDF export: the primary family first, then the fallback families in the order the host wants them tried. |
| [`GridExportFontSource`](/packages/active-grid/api/export-fonts#active-grid-gridexportfontsource) | type | The bytes of one font file, or a loader the grid calls once, before the document is built, when an export needs the face. |

**[Export values](/packages/active-grid/api/export-values)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridExportMode`](/packages/active-grid/api/export-values#active-grid-gridexportmode) | type | The two export output classes. |
| [`GridExportRunOptions`](/packages/active-grid/api/export-values#active-grid-gridexportrunoptions) | type | Mode options accepted by the export functions. |

**[useColumnSizingVars](/packages/active-grid/api/use-column-sizing)**

| Export | Kind | Description |
| --- | --- | --- |
| [`useColumnSizingVars`](/packages/active-grid/api/use-column-sizing#active-grid-usecolumnsizingvars) | hook | Computes CSS variable values from engine column sizing state. |

**[useKeyboardNavigation](/packages/active-grid/api/use-keyboard-navigation)**

| Export | Kind | Description |
| --- | --- | --- |
| [`useKeyboardNavigation`](/packages/active-grid/api/use-keyboard-navigation#active-grid-usekeyboardnavigation) | hook |  |

**[useAutoSize](/packages/active-grid/api/use-auto-size)**

| Export | Kind | Description |
| --- | --- | --- |
| [`useAutoSize`](/packages/active-grid/api/use-auto-size#active-grid-useautosize) | hook |  |

**[Use responsive columns](/packages/active-grid/api/use-responsive-columns)**

| Export | Kind | Description |
| --- | --- | --- |
| [`useResponsiveColumns`](/packages/active-grid/api/use-responsive-columns#active-grid-useresponsivecolumns) | hook | Watches the grid container width via ResizeObserver and auto-toggles column visibility based on `meta.responsivePriority` breakpoints. |
| [`UseResponsiveColumnsOptions`](/packages/active-grid/api/use-responsive-columns#active-grid-useresponsivecolumnsoptions) | interface |  |

**[useGridImperative](/packages/active-grid/api/use-grid-imperative)**

| Export | Kind | Description |
| --- | --- | --- |
| [`useGridImperative`](/packages/active-grid/api/use-grid-imperative#active-grid-usegridimperative) | hook | Typed wrapper for an `ActiveGrid`'s imperative API. |

**[Use grid mutation](/packages/active-grid/api/use-grid-mutation)**

| Export | Kind | Description |
| --- | --- | --- |
| [`useGridMutation`](/packages/active-grid/api/use-grid-mutation#active-grid-usegridmutation) | hook | One-stop hook for the "run async mutation, then patch the grid" pattern. |
| [`GridMutationOptions`](/packages/active-grid/api/use-grid-mutation#active-grid-gridmutationoptions) | interface |  |
| [`GridMutationResult`](/packages/active-grid/api/use-grid-mutation#active-grid-gridmutationresult) | type | Structural mirror of `ActionResult<T>` from `@workspace/active-types`. |
| [`GridMutationStrategy`](/packages/active-grid/api/use-grid-mutation#active-grid-gridmutationstrategy) | type | Strategy applied to the grid after a successful mutation. |
| [`UseGridMutationResult`](/packages/active-grid/api/use-grid-mutation#active-grid-usegridmutationresult) | interface |  |

**[Create resource server fetch fn](/packages/active-grid/api/create-resource-server-fetch-fn)**

| Export | Kind | Description |
| --- | --- | --- |
| [`createResourceServerFetchFn`](/packages/active-grid/api/create-resource-server-fetch-fn#active-grid-createresourceserverfetchfn) | function |  |
| [`CreateResourceServerFetchFnConfig`](/packages/active-grid/api/create-resource-server-fetch-fn#active-grid-createresourceserverfetchfnconfig) | interface | Build a grid `ServerFetchFunction<TRow>` on top of a resource data-action. |
| [`ResourceServerAction`](/packages/active-grid/api/create-resource-server-fetch-fn#active-grid-resourceserveraction) | type | A resource data-action (produced by `active-resources`' `createResourceDataAction`). |

**[Capability contract](/packages/active-grid/api/capability-contract)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridServerAggregateOp`](/packages/active-grid/api/capability-contract#active-grid-gridserveraggregateop) | type | Mirror of `active-resources`' `AggregateOp`. |
| [`GridServerCapabilities`](/packages/active-grid/api/capability-contract#active-grid-gridservercapabilities) | interface | Server-declared UI capabilities for a resource-backed grid. |
| [`GridServerFilterCapability`](/packages/active-grid/api/capability-contract#active-grid-gridserverfiltercapability) | interface | Per-field filter capability as the server declares it. |
| [`GridServerFilterType`](/packages/active-grid/api/capability-contract#active-grid-gridserverfiltertype) | type | Server-side filter type vocabulary — mirror of `active-resources`' `FieldFilterType`. |

**[Interaction](/packages/active-grid/api/interaction)**

| Export | Kind | Description |
| --- | --- | --- |
| [`CellPosition`](/packages/active-grid/api/interaction#active-grid-cellposition) | interface |  |
| [`ContextMenuBuilder`](/packages/active-grid/api/interaction#active-grid-contextmenubuilder) | type | Builds the consumer's items of a row menu for the row it opened on. |
| [`ContextMenuContext`](/packages/active-grid/api/interaction#active-grid-contextmenucontext) | interface | What an opened row menu is about, handed to a `ContextMenuBuilder` as its second argument. |
| [`ContextMenuItem`](/packages/active-grid/api/interaction#active-grid-contextmenuitem) | type |  |
| [`BatchCommitPayload`](/packages/active-grid/api/interaction#active-grid-batchcommitpayload) | interface |  |
| [`CellRange`](/packages/active-grid/api/interaction#active-grid-cellrange) | interface | A rectangular selection range defined by start and end cell coordinates. |
| [`CellSelectionState`](/packages/active-grid/api/interaction#active-grid-cellselectionstate) | interface | Full cell selection state. |
| [`DirtyCellEntry`](/packages/active-grid/api/interaction#active-grid-dirtycellentry) | interface |  |
| [`EditingCommitPayload`](/packages/active-grid/api/interaction#active-grid-editingcommitpayload) | interface |  |
| [`EditMode`](/packages/active-grid/api/interaction#active-grid-editmode) | type |  |

**[Settings](/packages/active-grid/api/settings)**

| Export | Kind | Description |
| --- | --- | --- |
| [`ColumnBorderMode`](/packages/active-grid/api/settings#active-grid-columnbordermode) | type |  |
| [`GridFooterConfig`](/packages/active-grid/api/settings#active-grid-gridfooterconfig) | interface | Configuration for the Sticky Footer (Aggregations). |
| [`GridHeaderConfig`](/packages/active-grid/api/settings#active-grid-gridheaderconfig) | interface | Configuration for the Grid Header. |
| [`GridHeaderMenuConfig`](/packages/active-grid/api/settings#active-grid-gridheadermenuconfig) | interface | Configuration for the Header Menu (the 3 dots per column). |
| [`GridPaginationStyleConfig`](/packages/active-grid/api/settings#active-grid-gridpaginationstyleconfig) | interface | Configuration for the Pagination Bar. |
| [`GridRowMenuConfig`](/packages/active-grid/api/settings#active-grid-gridrowmenuconfig) | interface | Configuration for the Row Context Menu (Right-click). |
| [`GridSettings`](/packages/active-grid/api/settings#active-grid-gridsettings) | interface |  |
| [`resolveColumnBorderMode`](/packages/active-grid/api/settings#active-grid-resolvecolumnbordermode) | function |  |

**[Columns](/packages/active-grid/api/columns)**

| Export | Kind | Description |
| --- | --- | --- |
| [`ColumnFilterType`](/packages/active-grid/api/columns#active-grid-columnfiltertype) | type |  |
| [`FilterComponentProps`](/packages/active-grid/api/columns#active-grid-filtercomponentprops) | interface | Props passed to a custom filter component registered via `meta.customFilter`. |
| [`IntervalInputProps`](/packages/active-grid/api/columns#active-grid-intervalinputprops) | interface | Props for a custom boundary-input inside the built-in `interval` filter (`meta.intervalInput`). |
| [`GridColumnDef`](/packages/active-grid/api/columns#active-grid-gridcolumndef) | type | A column definition. |
| [`GridColumnDefaults`](/packages/active-grid/api/columns#active-grid-gridcolumndefaults) | interface |  |
| [`GridColumnMeta`](/packages/active-grid/api/columns#active-grid-gridcolumnmeta) | interface | Per-column meta configuration. |
| [`GridColumnTypes`](/packages/active-grid/api/columns#active-grid-gridcolumntypes) | type |  |
| [`HeaderRendererProps`](/packages/active-grid/api/columns#active-grid-headerrendererprops) | interface | Props passed to a custom `meta.headerRenderer`. |
| [`GridStatusTone`](/packages/active-grid/api/columns#active-grid-gridstatustone) | type | The five generic status tones a status cell draws with (`meta.statusTones`, `<StatusCell tone>`). |
| [`hasAccessorFn`](/packages/active-grid/api/columns#active-grid-hasaccessorfn) | function | The same narrowing for the other accessor: does this definition compute its value from the row, and if so with which function? |
| [`hasAccessorKey`](/packages/active-grid/api/columns#active-grid-hasaccessorkey) | function | The one narrowing for the union above: does this definition read its value by naming a row field, and if so what is that field called? |

**[Data](/packages/active-grid/api/data)**

| Export | Kind | Description |
| --- | --- | --- |
| [`FacetOption`](/packages/active-grid/api/data#active-grid-facetoption) | interface |  |
| [`GridQueryRequest`](/packages/active-grid/api/data#active-grid-gridqueryrequest) | interface |  |
| [`PagedResponse`](/packages/active-grid/api/data#active-grid-pagedresponse) | interface |  |
| [`ServerFetchFunction`](/packages/active-grid/api/data#active-grid-serverfetchfunction) | type |  |
| [`ServerFetchParams`](/packages/active-grid/api/data#active-grid-serverfetchparams) | interface |  |
| [`ServerOptions`](/packages/active-grid/api/data#active-grid-serveroptions) | interface |  |

**[Props](/packages/active-grid/api/props)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridExportFormat`](/packages/active-grid/api/props#active-grid-gridexportformat) | type |  |
| [`GridExportOptions`](/packages/active-grid/api/props#active-grid-gridexportoptions) | interface |  |
| [`GridExportRowScope`](/packages/active-grid/api/props#active-grid-gridexportrowscope) | type | The row set the built-in row menu can export, and which it may therefore name HONESTLY. |
| [`GridExportScope`](/packages/active-grid/api/props#active-grid-gridexportscope) | type | The row set one export wrote: the current page or the loaded rows (the `GridExportRowScope` of the grid), or the reader's selection. |
| [`GridImperativeHandle`](/packages/active-grid/api/props#active-grid-gridimperativehandle) | interface |  |
| [`GridSelectionAction`](/packages/active-grid/api/props#active-grid-gridselectionaction) | interface | ONE action offered on the current selection. |
| [`GridSelectionActionTone`](/packages/active-grid/api/props#active-grid-gridselectionactiontone) | type | How a selection action is presented. |
| [`GridToolbarConfig`](/packages/active-grid/api/props#active-grid-gridtoolbarconfig) | interface |  |
| [`SelectionModel`](/packages/active-grid/api/props#active-grid-selectionmodel) | type | Represents the current selection state, distinguishing between inclusive mode (specific IDs selected) and exclusive mode (all selected except specific IDs — used for… |
| [`SelectionQuery`](/packages/active-grid/api/props#active-grid-selectionquery) | interface | The QUESTION an exclusive selection answers. |
| [`SelectionQueryFilter`](/packages/active-grid/api/props#active-grid-selectionqueryfilter) | interface | One column filter that was active at the moment an EXCLUSIVE selection was made. |
| [`GridPaginationOptions`](/packages/active-grid/api/props#active-grid-gridpaginationoptions) | interface |  |
| [`GridProps`](/packages/active-grid/api/props#active-grid-gridprops) | type |  |
| [`LoadingDisplayOptions`](/packages/active-grid/api/props#active-grid-loadingdisplayoptions) | interface | Per-state loading configuration. |
| [`LoadingDisplayValue`](/packages/active-grid/api/props#active-grid-loadingdisplayvalue) | type | An indicator name, or your own node rendered inside the grid box. |
| [`LoadingIndicator`](/packages/active-grid/api/props#active-grid-loadingindicator) | type | A built-in loading indicator. |

**[GridMeta](/packages/active-grid/api/meta)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridMeta`](/packages/active-grid/api/meta#active-grid-gridmeta) | type | Public API type for grid meta configuration. |

**[GridPresentation](/packages/active-grid/api/presentation)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GridPresentation`](/packages/active-grid/api/presentation#active-grid-gridpresentation) | type | The presentation of a grid: the active-format `ValuePresentation` (a language code, or a presentation context whose one value feeds every central formatter). |

**[Auto size](/packages/active-grid/api/auto-size)**

| Export | Kind | Description |
| --- | --- | --- |
| [`AutoSizeMode`](/packages/active-grid/api/auto-size#active-grid-autosizemode) | type |  |
| [`AutoSizeOnMountOptions`](/packages/active-grid/api/auto-size#active-grid-autosizeonmountoptions) | interface |  |
| [`AutoSizeOptions`](/packages/active-grid/api/auto-size#active-grid-autosizeoptions) | interface |  |
| [`AutoSizeResult`](/packages/active-grid/api/auto-size#active-grid-autosizeresult) | interface |  |
| [`HeaderMeasureResult`](/packages/active-grid/api/auto-size#active-grid-headermeasureresult) | interface |  |
| [`MeasureContext`](/packages/active-grid/api/auto-size#active-grid-measurecontext) | interface |  |
| [`DEFAULT_AUTO_SIZE_OPTIONS`](/packages/active-grid/api/auto-size#active-grid-default-auto-size-options) | constant |  |
| [`DEFAULT_AUTO_SIZE_ON_MOUNT`](/packages/active-grid/api/auto-size#active-grid-default-auto-size-on-mount) | constant |  |
| [`getAutoSizeConfig`](/packages/active-grid/api/auto-size#active-grid-getautosizeconfig) | function |  |
| [`normalizeAutoSizeOnMount`](/packages/active-grid/api/auto-size#active-grid-normalizeautosizeonmount) | function |  |

**[CsvDelimiter](/packages/active-grid/api/csv-delimiter)**

| Export | Kind | Description |
| --- | --- | --- |
| [`CsvDelimiter`](/packages/active-grid/api/csv-delimiter#active-grid-csvdelimiter) | type | One valid CSV delimiter. |

**[BuiltInOperatorPreset](/packages/active-grid/api/operator-presets)**

| Export | Kind | Description |
| --- | --- | --- |
| [`BuiltInOperatorPreset`](/packages/active-grid/api/operator-presets#active-grid-builtinoperatorpreset) | type | The names of the built-in presets. |

**[Config](/packages/active-grid/api/config)**

| Export | Kind | Description |
| --- | --- | --- |
| [`ActiveGridMenuConfig`](/packages/active-grid/api/config#active-grid-activegridmenuconfig) | interface |  |
| [`ActiveGridUIConfig`](/packages/active-grid/api/config#active-grid-activegriduiconfig) | interface |  |
| [`GridAutoSizeConfig`](/packages/active-grid/api/config#active-grid-gridautosizeconfig) | interface | The measurement settings of automatic column width determination. |
| [`GridBehaviorConfig`](/packages/active-grid/api/config#active-grid-gridbehaviorconfig) | interface |  |
| [`GridColumnConfig`](/packages/active-grid/api/config#active-grid-gridcolumnconfig) | interface |  |
| [`GridConfig`](/packages/active-grid/api/config#active-grid-gridconfig) | interface |  |
| [`GridExportConfig`](/packages/active-grid/api/config#active-grid-gridexportconfig) | interface |  |
| [`GridFeaturesConfig`](/packages/active-grid/api/config#active-grid-gridfeaturesconfig) | interface |  |
| [`GridFilteringConfig`](/packages/active-grid/api/config#active-grid-gridfilteringconfig) | interface |  |
| [`GridLayoutConfig`](/packages/active-grid/api/config#active-grid-gridlayoutconfig) | interface |  |
| [`GridLinkComponent`](/packages/active-grid/api/config#active-grid-gridlinkcomponent) | type | A host's own link, for the grid's internal links (`LinkCell`): a router link such as `next/link`, so navigation stays client-side. |
| [`GridLinkProps`](/packages/active-grid/api/config#active-grid-gridlinkprops) | interface | What a host link component receives from `GridLinkComponent`'s caller: the destination, the grid's class for the link and its text. |
| [`GridPaginationDefaults`](/packages/active-grid/api/config#active-grid-gridpaginationdefaults) | interface |  |
| [`GridStorageConfig`](/packages/active-grid/api/config#active-grid-gridstorageconfig) | interface |  |
| [`PartialGridConfig`](/packages/active-grid/api/config#active-grid-partialgridconfig) | type |  |

**[Grid (types)](/packages/active-grid/api/types-grid)**

| Export | Kind | Description |
| --- | --- | --- |
| [`Cell`](/packages/active-grid/api/types-grid#active-grid-cell) | type | One row paired with one column: a cell of a record's row, or of a generated row. |
| [`CellContext`](/packages/active-grid/api/types-grid#active-grid-cellcontext) | interface | What a body-cell renderer receives: a cell of a row that stands for a record, so `row.original` is that record. |
| [`Column`](/packages/active-grid/api/types-grid#active-grid-column) | interface | One column of the catalogue. |
| [`ColumnFiltersState`](/packages/active-grid/api/types-grid#active-grid-columnfiltersstate) | type | The active column filters, in the order they were declared. |
| [`GeneratedCell`](/packages/active-grid/api/types-grid#active-grid-generatedcell) | interface | A cell of a row that grouping generated. |
| [`GeneratedCellContext`](/packages/active-grid/api/types-grid#active-grid-generatedcellcontext) | interface | What the renderer of a generated row's cell receives: a row that stands for a value several records share and carries no record of its own. |
| [`GeneratedRow`](/packages/active-grid/api/types-grid#active-grid-generatedrow) | interface | A row grouping generated: it stands for a value several records share, and there is no record it stands for. |
| [`Grid`](/packages/active-grid/api/types-grid#active-grid-grid) | interface | One grid instance. |
| [`GroupingState`](/packages/active-grid/api/types-grid#active-grid-groupingstate) | type | The columns the rows are grouped by, outermost first. |
| [`Header`](/packages/active-grid/api/types-grid#active-grid-header) | interface | One header: a column, at a depth, over a run of laid-out leaf columns. |
| [`HeaderContext`](/packages/active-grid/api/types-grid#active-grid-headercontext) | interface | What a header or footer renderer receives. |
| [`HeaderGroup`](/packages/active-grid/api/types-grid#active-grid-headergroup) | interface | One level of the header hierarchy. |
| [`Row`](/packages/active-grid/api/types-grid#active-grid-row) | type | One row of a model: a `SourceRow` that stands for a record, or a `GeneratedRow` that grouping produced. |
| [`SortingState`](/packages/active-grid/api/types-grid#active-grid-sortingstate) | type | The sort entries, in priority order. |
| [`SourceCell`](/packages/active-grid/api/types-grid#active-grid-sourcecell) | interface | A cell of a row that stands for a record. |
| [`SourceRow`](/packages/active-grid/api/types-grid#active-grid-sourcerow) | interface | A row that stands for one record of the data. |

**[Column helper](/packages/active-grid/api/column-helper)**

| Export | Kind | Description |
| --- | --- | --- |
| [`createColumnHelper`](/packages/active-grid/api/column-helper#active-grid-createcolumnhelper) | function | Builder for type-safe column definitions with per-column value inference. |
| [`ColumnHelper`](/packages/active-grid/api/column-helper#active-grid-columnhelper) | interface | Builder for column definitions, with per-column value-type inference. |

**[Server grouping](/packages/active-grid/api/server-grouping)**

| Export | Kind | Description |
| --- | --- | --- |
| [`GroupAggregation`](/packages/active-grid/api/server-grouping#active-grid-groupaggregation) | interface | Aggregation to compute per group on the server. |
| [`GroupByColumn`](/packages/active-grid/api/server-grouping#active-grid-groupbycolumn) | interface | Column to group by in server-side grouping. |
| [`GroupInfo`](/packages/active-grid/api/server-grouping#active-grid-groupinfo) | interface | Metadata for a single group in a grouped response. |
| [`ServerGroupRow`](/packages/active-grid/api/server-grouping#active-grid-servergrouprow) | interface | Synthetic row marker used to represent a server-side group header in the flat row list. |
| [`ServerLoadMoreRow`](/packages/active-grid/api/server-grouping#active-grid-serverloadmorerow) | interface | Synthetic row marker for a "load more" button within a server-side group. |
| [`isServerGroupRow`](/packages/active-grid/api/server-grouping#active-grid-isservergrouprow) | function | Type guard: is this row a synthetic server group header? |
| [`isServerLoadMoreRow`](/packages/active-grid/api/server-grouping#active-grid-isserverloadmorerow) | function | Type guard: is this row a "load more" marker? |

**[Filters (types)](/packages/active-grid/api/types-filters)**

| Export | Kind | Description |
| --- | --- | --- |
| [`DateFilterPreset`](/packages/active-grid/api/types-filters#active-grid-datefilterpreset) | interface |  |
| [`DateOperator`](/packages/active-grid/api/types-filters#active-grid-dateoperator) | type |  |
| [`FilterCondition`](/packages/active-grid/api/types-filters#active-grid-filtercondition) | interface | A single filter condition on a column. |
| [`FilterExpression`](/packages/active-grid/api/types-filters#active-grid-filterexpression) | type | Root filter expression — always a group. |
| [`FilterExpressionNode`](/packages/active-grid/api/types-filters#active-grid-filterexpressionnode) | type | A node in the filter expression tree — either a condition or a group. |
| [`FilterGroup`](/packages/active-grid/api/types-filters#active-grid-filtergroup) | interface | A group of conditions with AND/OR logic. |
| [`FilterOperator`](/packages/active-grid/api/types-filters#active-grid-filteroperator) | type |  |
| [`FilterOperatorOption`](/packages/active-grid/api/types-filters#active-grid-filteroperatoroption) | interface |  |
| [`FilterValue`](/packages/active-grid/api/types-filters#active-grid-filtervalue) | type |  |
| [`IntervalFilterValue`](/packages/active-grid/api/types-filters#active-grid-intervalfiltervalue) | interface | Value of an `interval`-type column filter. |
| [`IntervalMode`](/packages/active-grid/api/types-filters#active-grid-intervalmode) | type | Interval-filter semantics. |
| [`NoValueFilter`](/packages/active-grid/api/types-filters#active-grid-novaluefilter) | type |  |
| [`NoValueOperator`](/packages/active-grid/api/types-filters#active-grid-novalueoperator) | type |  |
| [`NumberOperator`](/packages/active-grid/api/types-filters#active-grid-numberoperator) | type |  |
| [`RangeFilter`](/packages/active-grid/api/types-filters#active-grid-rangefilter) | type |  |
| [`RangeOperator`](/packages/active-grid/api/types-filters#active-grid-rangeoperator) | type |  |
| [`SingleValueFilter`](/packages/active-grid/api/types-filters#active-grid-singlevaluefilter) | type |  |
| [`TextOperator`](/packages/active-grid/api/types-filters#active-grid-textoperator) | type |  |
| [`isFilterGroup`](/packages/active-grid/api/types-filters#active-grid-isfiltergroup) | function | Type guard: checks if a node is a FilterGroup (has combinator). |
| [`getBooleanOperators`](/packages/active-grid/api/types-filters#active-grid-getbooleanoperators) | function |  |
| [`getDateOperators`](/packages/active-grid/api/types-filters#active-grid-getdateoperators) | function |  |
| [`getNumberOperators`](/packages/active-grid/api/types-filters#active-grid-getnumberoperators) | function |  |
| [`getOperatorsForType`](/packages/active-grid/api/types-filters#active-grid-getoperatorsfortype) | function |  |
| [`getTextOperators`](/packages/active-grid/api/types-filters#active-grid-gettextoperators) | function |  |

**[DEFAULT_DATE_PRESETS](/packages/active-grid/api/date-filter-presets)**

| Export | Kind | Description |
| --- | --- | --- |
| [`DEFAULT_DATE_PRESETS`](/packages/active-grid/api/date-filter-presets#active-grid-default-date-presets) | constant |  |