@adapttable/mui

v3.2.3

Published

10 hours ago

Material UI adapter for AdaptTable — a batteries-included MUI data table with sorting, filtering, URL state, selection, RTL, dark mode, and a free DataGrid-style experience.

Downloads

1,080

0High
0Medium
0Low

orwa.mahmoud

react mui material-ui data-table datagrid mui-datagrid-alternative server-side-pagination url-state rtl typescript

@adapttable/mui

📖 Documentation · 🚀 Live demo · Get started · ⚡ Try in StackBlitz

Migrating from MUI X DataGrid? See the migration guide.

The Material UI adapter for AdaptTable — a batteries-included MUI data table with sorting, filtering, URL-synced state, selection + bulk actions, RTL, and dark mode. A free, headless alternative to MUI X DataGrid built on @adapttable/core.

pnpm add @adapttable/mui @adapttable/core @mui/material @emotion/react @emotion/styled react react-dom

Requires Node.js 22.12.0 or newer; packed releases are tested on Node 22.12 and Node 24.

Quickstart

import { DataTable, useFrontendData, type ColumnDef } from "@adapttable/mui";

interface Person {
  id: string;
  name: string;
  city: string;
}

const columns: ColumnDef<Person>[] = [
  { key: "name", header: "Name", accessor: (r) => r.name, sortable: true },
  { key: "city", header: "City", accessor: (r) => r.city },
];

export function People({ data }: { data: Person[] }) {
  const source = useFrontendData({ data, columns });
  return <DataTable source={source} columns={columns} rowKey={(r) => r.id} />;
}

Wrap your app in MUI's ThemeProvider to control light/dark mode and RTL, as usual. Swap useFrontendData for useQuerySource to drive the table from a server-paginated query — the component doesn't change.

Features

Automatic mobile cards — below the mobile breakpoint every row renders as a MUI Card (same filters, search, selection and URL state) and infinite scroll replaces the pager; tune per column with mobileLabel / hideOnMobile, pin either layout with forceMobile. See it flip live.
Client or server data through one TableSource contract — same props either way.
Global search box — debounced; matches each row's searchable text on client data and hands the term to the backend on a server tier. Turn it off with searchable={false}.
URL-synced search / sort / filters / page — shareable, deep-linkable links.
Sorting via TableSortLabel headers.
Filtering — a Drawer or Popover of filters plus removable Chips, with a filter count on the trigger. Nested AND/OR filter tree in the same panel.
Header filters (headerFilters()) — a funnel in each filtered column's header opens the same field as the Filters panel, bound to the same state, URL params and chips.
Custom filter types (filterTypes([...])) — register a FilterTypeSpec with its own widget, operators and predicate; it gets the form field, header funnel, URL params and chips.
Selection + bulk actions using MUI Checkboxes, composed with bulkActions(...).
Row actions with optional confirm, isHidden / isDisabled per row.
Row expansion — inline detail panels via rowDetail(...).
Nested tables (nestedTable(...)) — a full DataTable with its own columns, sorting and paging inside an expanded row.
Inline cell editing (editing(handler) + editable columns) — text, number and select editors; Enter commits, Escape cancels, Tab moves on. Omit the handler and no cell opens.
Row reordering (rowReorder(handler)) — drag handle, Space-lift keyboard, dataset-relative indices.
Row pinning (rowPinning(...)) — sticky top and bottom rows outside the virtual window.
Pinned summary rows (pinnedSummaryRows(...)) — host-owned totals stuck outside sort, filter, grouping, pagination and selection, including on grouped and tree tables.
Row and column spanning (cellSpan(...)) — one cell list per row; covered cells are omitted.
Full-width and separator rows (extraRows(...)) — host-injected slots spliced in by beforeRowId.
Row styling and heights (rowAppearance(...)) — conditional inline style and per-row height.
Keyboard cell navigation (cellNavigation()) — one tab stop, arrow keys, ARIA grid semantics and screen-reader announcements. It is also the gate for cell-range selection, clipboard copy/paste of a range, and the fill handle.
Row grouping (grouping(...) or groupingPanel(...)) — one column key or an ordered list to nest, with per-group aggregates.
Aggregation — a footer summaryRow, group subtotals from aggregatable columns, and built-in or custom aggregate() operations; totals recompute from the filtered rows.
Pivot tables — rows, columns and measures with subtotals, from the optional @adapttable/core/pivot entry.
Tree data (tree(...)) — hierarchical rows with expand/collapse, on desktop and on cards.
Column management — show/hide, reorder, pin (sticky) and resize, plus collapsible column groups.
Sparkline columns (@adapttable/react/sparkline) — bar, line and area as inline SVG. The base bundle never pays for it.
PDF export and print layout (@adapttable/core/pdf) — optional entry; pdfWriter() on exportCsv, printTable for the browser dialog.
Formula engine (@adapttable/core/formula) — spreadsheet formulas over rows and aggregates; circular refs report #CYCLE!.
Feature composition (features={[rowReorder(fn)]}) from @adapttable/mui/row-reorder-style subpaths — the import is the switch, and standardFeatures() on the /preset entry is the one-import path. Host plugins share the same setup(host) surface.
Saved views — name a filter/sort/column arrangement and switch between them.
CSV export (exportCsv(...)) — current page, the full filtered set, or the selected rows; choose the columns, or hand the whole thing to your backend.
XLSX export (@adapttable/core/xlsx) — optional entry; xlsxWriter() on exportCsv writes a real .xlsx workbook with no extra dependency.
Command palette and context menus (commandPalette(), contextMenu()) — Cmd/Ctrl+K opens a searchable list of table actions; right-click opens a menu for the header, row or cell.
View controls — densityChooser(), fullscreen(), print(...), statusBar(), selectionStats(), sidePanel(...) and undoRedoButtons(), each an opt-in toolbar control from its own subpath.
Virtualization (virtualize(...)) — opt-in row/card windowing for very large lists.
Pagination — Pagination footer, or infinite scroll (auto by device).
SSR & server components — renders with no DOM; the client boundary is already in the build, so it drops straight into the Next.js App Router. Docs.
States — Skeleton loading, Alert error with retry, and an empty state.
RTL via dir; dark mode follows the MUI theme.
Customisation — slots (skeleton, empty), className, size, injectable confirm, and the full headless escape hatch via @adapttable/react.