Package Exports
- @alaarab/ogrid-core
Readme
OGrid Core — Headless types, hooks, and utilities for OGrid data grids.
Documentation · Getting Started · API Reference
Framework-agnostic foundation for OGrid data grids. You typically don't need to install this directly — the UI packages (@alaarab/ogrid, @alaarab/ogrid-fluent, @alaarab/ogrid-material) re-export everything from core.
What's Inside
Hooks
useOGrid— Orchestrator: pagination, sorting, filtering, visibility, editing, row selection, status bar, grid APIuseDataGridState— All DataGridTable state: layout, selection, editing, interaction, context menu, view modelsuseColumnHeaderFilterState— Filter popover (open, temp values, apply/clear, people search debounce)useColumnChooserState— Column visibility dropdownuseInlineCellEditorState— Inline cell editoruseRichSelectState— Searchable rich select dropdownuseSideBarState— Side bar panel managementuseActiveCell,useCellSelection,useCellEditing,useRowSelection,useKeyboardNavigation,useClipboard,useFillHandle,useUndoRedo,useContextMenu,useColumnResize,useFilterOptions,useDebounce
Types
IColumnDef<T> · IColumnGroupDef · IDataSource<T> · IFilters · FilterValue · IDateFilterValue · UserLike · IOGridApi<T> · IOGridProps<T> · IOGridDataGridProps<T> · ICellEditorProps<T> · IGridColumnState · ISideBarDef · ColumnFilterType · IColumnMeta
Utilities
processClientSideData · exportToCsv · getCellValue · flattenColumns · buildHeaderRows · getPaginationViewModel · getHeaderFilterConfig · getCellRenderDescriptor · computeAggregations · formatShortcut · GRID_CONTEXT_MENU_ITEMS
Headless Components
OGridLayout · StatusBar · GridContextMenu · SideBar · MarchingAntsOverlay
Install
npm install @alaarab/ogrid-coreOnly peer dep is react ^17 || ^18 || ^19.
Documentation
Full docs at alaarab.github.io/ogrid.
License
MIT — Free forever.