All exports
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.
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, Columns
API, Filters
API, Server
API and Cells and
utilities. The stylesheet is the
second entry point: @workspace/.
Components#
GridDefaults(component): The one defaults boundary of the grid: the presentation, the translator and the behaviour configuration for every grid rendered below it.GridDefaultsProps(interface)
ActiveGrid(component)
LookupGrid(component)LookupGridProps(type): Discriminated union: server (default) or client mode.
BadgeCell(component): Categorical badge cell: kind, type, department, category, origin.DateCell(component)ExpanderCell(component)getExpanderColumn(function)getSelectionColumn(function)LinkCell(component): A cell that links its value.SelectionCell(component)StatusCell(component): Status presentation in a cell: the grid'sUiStatusBadgeon the fixedGridStatusToneaxis, with the label derivation added.TextCell(component): Minimal text renderer — no opinion on font or layout.
GridPagination(component)GroupingToolbar(component)
GridContextMenu(component)
SortIndicator(component)CellErrorBoundary(component): A lightweight Error Boundary specifically for table cells.FilterIcon(component): AG-Grid style filter icon (three horizontal lines).
BooleanFilter(component)DateFilter(component)FilterCheckboxItem(component)FilterClearButton(component): The clear button of an inline filter.FilterDateInput(component)FilterNumberInput(component): Human number input in a popover filter.FilterOperatorSelect(component)FilterPopover(component)FilterPopoverBody(component)FilterPopoverContent(component)FilterPopoverHeader(component)FilterPopoverTrigger(component)FilterSearchInput(component)FilterTextInput(component)FilterWrapper(component)NumberFilter(component): Inline number filter — AG Grid Floating Filter pattern.SelectFilter(component)TextFilter(component): Inline text filter — AG Grid Floating Filter pattern.
Functions, constants and types#
GridConfigurationError(class): A grid configuration the grid cannot run with.GridConfigurationErrorCode(type): The closed set of configuration mistakes the grid refuses.GridConfigurationErrorOptions(interface)
GridTextDirection(type): The base direction of one text run.
GridDiagnostic(interface): One diagnostic of the grid.GridDiagnosticLevel(type): How serious a grid diagnostic is.GridDiagnosticSink(type): Where the grid delivers its diagnostics.
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(hook): The effective presentation of the enclosing grid, including an instance override: a locale code or a presentation context.GridTranslateFunction(type): Translation function type — compatible with active-i18n's TranslateFunction.
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(function): Utility to build context menu items in a type-safe way.
clearAllGridStates(function): Clear all grid state entries from localStorage.
buildIntervalWhere(function): Builds a Prisma-shapedwherefragment for anIntervalFilterValueover two numeric boundary fields.IntervalFields(interface): The two numeric boundary fields a row's interval is stored in.
GridStatePriority(type): Conflict-resolution strategy between the two external state sources — the URL (enableUrlSync) and localStorage (enablePersistence) — for the four *contested* state slices.
aggregateCount(function): Aggregate mapping for a count.aggregateScalar(function): Aggregate mapping on a scalar field.byCount(function): Sort mapping on the count of a relation.byField(function): Sort mapping on a scalar field.everyByField(function): Filter mapping with relationevery.fieldFilter(function): Filter mapping on a scalar field.globalEveryByField(function): Global-search mapping with relationevery.globalField(function): Mark a column as participating in the global search-box (the toolbar's single-search input).globalNoneByField(function): Global-search mapping with relationnone.globalSomeByField(function): Global-search mapping with relationsome.groupByField(function): Group-by mapping on a scalar field.groupByRelation(function): Group-by mapping that resolves through a relation.multiField(function): Filter mapping that ORs across multiple scalar paths.noneByField(function): Filter mapping with relationnone.scalarField(function): Shortcut that fills bothsortandfilterfor a scalar column.someByField(function): Filter mapping with relationsome.
AggregateCountMapping(interface)AggregateOp(type)AggregateScalarMapping(interface)FilterFieldMapping(interface)FilterMultiFieldMapping(interface)FilterRelationMapping(interface)GlobalFieldMapping(interface)GlobalRelationMapping(interface)GroupByFieldMapping(interface)GroupByRelationMapping(interface)SerializableAggregateMapping(type)SerializableFilterMapping(type)SerializableGlobalMapping(type)SerializableGroupByMapping(type)SerializableSortMapping(type)ServerColumnContract(interface): Client-side query-contract for a column.SortCountMapping(interface)SortFieldMapping(interface)
serializeDecimals(function): Recursively convert decimal.js instances (PrismaDecimal) to plain numbers, so a query result can cross the server-to-client boundary, which does not serialize class instances.
evaluateFilter(function)evaluateFilterExpression(function): Evaluate a filter expression tree against a row.advancedFilterFn(function): A predicate a column'sfilterFnmay be set to directly.
createLocaleSortFn(function): Builds a comparator that orders a column's text inlocale.
copyToClipboard(function): Copy rows to the clipboard as TSV.exportToCSV(function)exportToCSVGrouped(function): Export to CSV with group structure.exportToCSVServerGrouped(function): Export server-side grouped data to CSV.exportToExcel(function)exportToExcelGrouped(function): Export to Excel with group structure.exportToExcelServerGrouped(function): Export server-side grouped data to Excel.exportToJSON(function)exportToJSONGrouped(function): Export to JSON with hierarchical group structure.exportToJSONServerGrouped(function): Export server-side grouped data to JSON with hierarchical structure.exportToPDF(function): Export rows to PDF as a formatted table.exportToPDFGrouped(function): Export to PDF with group structure.exportToPDFServerGrouped(function): Export server-side grouped data to PDF.GridClipboardOptions(interface): Options for the clipboard copy.GridExcelExportOptions(type): The options of an XLSX export: the data-mode options every data format shares, plus the sheet's direction.GridPdfExportOptions(interface): PDF is HUMAN output: always presentation, so always with a locale.ServerGroupedExportConfig(interface): Configuration for server-side grouped export.
GridExportError(class): Why a grid export did not produce a file.GridExportErrorCode(type): The closed set of export failures the grid names.GridExportErrorOptions(interface): What aGridExportErrorcarries besides its code.
GridExportDirection(type): The direction a visual or workbook export is written in:rtlputs the first column on the right of a PDF page and opens an XLSX sheet right to left.GridExportFontFace(interface): One font file of a family.GridExportFontFamily(interface): A host font family, under the host's own name.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(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.
GridExportMode(type): The two export output classes.GridExportRunOptions(type): Mode options accepted by the export functions.
useColumnSizingVars(hook): Computes CSS variable values from engine column sizing state.
useAutoSize(hook)
useResponsiveColumns(hook): Watches the grid container width via ResizeObserver and auto-toggles column visibility based onmeta.responsivePrioritybreakpoints.UseResponsiveColumnsOptions(interface)
useGridImperative(hook): Typed wrapper for anActiveGrid's imperative API.
useGridMutation(hook): One-stop hook for the "run async mutation, then patch the grid" pattern.GridMutationOptions(interface)GridMutationResult(type): Structural mirror ofActionResult<T>from@workspace/active-types.GridMutationStrategy(type): Strategy applied to the grid after a successful mutation.UseGridMutationResult(interface)
Create resource server fetch fn
createResourceServerFetchFn(function)CreateResourceServerFetchFnConfig(interface): Build a gridServerFetchFunction<TRow>on top of a resource data-action.ResourceServerAction(type): A resource data-action (produced byactive-resources'createResourceDataAction).
GridServerAggregateOp(type): Mirror ofactive-resources'AggregateOp.GridServerCapabilities(interface): Server-declared UI capabilities for a resource-backed grid.GridServerFilterCapability(interface): Per-field filter capability as the server declares it.GridServerFilterType(type): Server-side filter type vocabulary — mirror ofactive-resources'FieldFilterType.
CellPosition(interface)ContextMenuBuilder(type): Builds the consumer's items of a row menu for the row it opened on.ContextMenuContext(interface): What an opened row menu is about, handed to aContextMenuBuilderas its second argument.ContextMenuItem(type)BatchCommitPayload(interface)CellRange(interface): A rectangular selection range defined by start and end cell coordinates.CellSelectionState(interface): Full cell selection state.DirtyCellEntry(interface)EditingCommitPayload(interface)EditMode(type)
ColumnBorderMode(type)GridFooterConfig(interface): Configuration for the Sticky Footer (Aggregations).GridHeaderConfig(interface): Configuration for the Grid Header.GridHeaderMenuConfig(interface): Configuration for the Header Menu (the 3 dots per column).GridPaginationStyleConfig(interface): Configuration for the Pagination Bar.GridRowMenuConfig(interface): Configuration for the Row Context Menu (Right-click).GridSettings(interface)resolveColumnBorderMode(function)
ColumnFilterType(type)FilterComponentProps(interface): Props passed to a custom filter component registered viameta.customFilter.IntervalInputProps(interface): Props for a custom boundary-input inside the built-inintervalfilter (meta.intervalInput).GridColumnDef(type): A column definition.GridColumnDefaults(interface)GridColumnMeta(interface): Per-column meta configuration.GridColumnTypes(type)HeaderRendererProps(interface): Props passed to a custommeta.headerRenderer.GridStatusTone(type): The five generic status tones a status cell draws with (meta.statusTones,<StatusCell tone>).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(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?
FacetOption(interface)GridQueryRequest(interface)PagedResponse(interface)ServerFetchFunction(type)ServerFetchParams(interface)ServerOptions(interface)
GridExportFormat(type)GridExportOptions(interface)GridExportRowScope(type): The row set the built-in row menu can export, and which it may therefore name HONESTLY.GridExportScope(type): The row set one export wrote: the current page or the loaded rows (theGridExportRowScopeof the grid), or the reader's selection.GridImperativeHandle(interface)GridSelectionAction(interface): ONE action offered on the current selection.GridSelectionActionTone(type): How a selection action is presented.GridToolbarConfig(interface)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(interface): The QUESTION an exclusive selection answers.SelectionQueryFilter(interface): One column filter that was active at the moment an EXCLUSIVE selection was made.GridPaginationOptions(interface)GridProps(type)LoadingDisplayOptions(interface): Per-state loading configuration.LoadingDisplayValue(type): An indicator name, or your own node rendered inside the grid box.LoadingIndicator(type): A built-in loading indicator.
GridPresentation(type): The presentation of a grid: the active-formatValuePresentation(a language code, or a presentation context whose one value feeds every central formatter).
AutoSizeMode(type)AutoSizeOnMountOptions(interface)AutoSizeOptions(interface)AutoSizeResult(interface)HeaderMeasureResult(interface)MeasureContext(interface)DEFAULT_AUTO_SIZE_OPTIONS(constant)DEFAULT_AUTO_SIZE_ON_MOUNT(constant)getAutoSizeConfig(function)normalizeAutoSizeOnMount(function)
CsvDelimiter(type): One valid CSV delimiter.
BuiltInOperatorPreset(type): The names of the built-in presets.
ActiveGridMenuConfig(interface)ActiveGridUIConfig(interface)GridAutoSizeConfig(interface): The measurement settings of automatic column width determination.GridBehaviorConfig(interface)GridColumnConfig(interface)GridConfig(interface)GridExportConfig(interface)GridFeaturesConfig(interface)GridFilteringConfig(interface)GridLayoutConfig(interface)GridLinkComponent(type): A host's own link, for the grid's internal links (LinkCell): a router link such asnext/link, so navigation stays client-side.GridLinkProps(interface): What a host link component receives fromGridLinkComponent's caller: the destination, the grid's class for the link and its text.GridPaginationDefaults(interface)GridStorageConfig(interface)PartialGridConfig(type)
Cell(type): One row paired with one column: a cell of a record's row, or of a generated row.CellContext(interface): What a body-cell renderer receives: a cell of a row that stands for a record, sorow.originalis that record.Column(interface): One column of the catalogue.ColumnFiltersState(type): The active column filters, in the order they were declared.GeneratedCell(interface): A cell of a row that grouping generated.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(interface): A row grouping generated: it stands for a value several records share, and there is no record it stands for.Grid(interface): One grid instance.GroupingState(type): The columns the rows are grouped by, outermost first.Header(interface): One header: a column, at a depth, over a run of laid-out leaf columns.HeaderContext(interface): What a header or footer renderer receives.HeaderGroup(interface): One level of the header hierarchy.Row(type): One row of a model: aSourceRowthat stands for a record, or aGeneratedRowthat grouping produced.SortingState(type): The sort entries, in priority order.SourceCell(interface): A cell of a row that stands for a record.SourceRow(interface): A row that stands for one record of the data.
createColumnHelper(function): Builder for type-safe column definitions with per-column value inference.ColumnHelper(interface): Builder for column definitions, with per-column value-type inference.
GroupAggregation(interface): Aggregation to compute per group on the server.GroupByColumn(interface): Column to group by in server-side grouping.GroupInfo(interface): Metadata for a single group in a grouped response.ServerGroupRow(interface): Synthetic row marker used to represent a server-side group header in the flat row list.ServerLoadMoreRow(interface): Synthetic row marker for a "load more" button within a server-side group.isServerGroupRow(function): Type guard: is this row a synthetic server group header?isServerLoadMoreRow(function): Type guard: is this row a "load more" marker?
DateFilterPreset(interface)DateOperator(type)FilterCondition(interface): A single filter condition on a column.FilterExpression(type): Root filter expression — always a group.FilterExpressionNode(type): A node in the filter expression tree — either a condition or a group.FilterGroup(interface): A group of conditions with AND/OR logic.FilterOperator(type)FilterOperatorOption(interface)FilterValue(type)IntervalFilterValue(interface): Value of aninterval-type column filter.IntervalMode(type): Interval-filter semantics.NoValueFilter(type)NoValueOperator(type)NumberOperator(type)RangeFilter(type)RangeOperator(type)SingleValueFilter(type)TextOperator(type)isFilterGroup(function): Type guard: checks if a node is a FilterGroup (has combinator).getBooleanOperators(function)getDateOperators(function)getNumberOperators(function)getOperatorsForType(function)getTextOperators(function)
DEFAULT_DATE_PRESETS(constant)