Package Exports
- @alaarab/ogrid-core
Readme
@alaarab/ogrid-core
Framework-agnostic types, hooks, and utilities for OGrid data tables.
This package is the shared foundation used by @alaarab/ogrid-fluent and @alaarab/ogrid-material. You typically don't need to install it directly -- both framework packages re-export everything from core.
Install
npm install @alaarab/ogrid-coreWhat's Included
Types
IColumnDef<T>-- Column definition with sorting, filtering, and renderingIDataSource<T>-- Server-side data source interfaceIFetchParams-- Parameters forfetchPage()IFilters-- Unified filter values (text, multi-select, people)UserLike-- Minimal user shape for people pickerIColumnFilterDef,IColumnMeta,IPageResult,ColumnFilterType
Hooks
useFilterOptions(dataSource, fields)-- Loads filter options for multi-select columns
Utilities
toDataGridFilterProps(filters)-- SplitsIFiltersintomultiSelectFilters,textFilters,peopleFilterstoUserLike(user)-- Converts a user-like object toUserLikeexportToCsv(items, columns, getValue, filename)-- Full CSV exportbuildCsvHeader,buildCsvRows,triggerCsvDownload,escapeCsvValue-- Low-level CSV helpers
License
MIT