material-react-table-narender 1.0.0

package/packages/material-react-table/README.md

@@ -0,0 +1,215 @@
+# Material React Table V3
+
+View [Documentation](https://www.material-react-table.com/)
+
+<a href="https://npmjs.com/package/material-react-table" target="_blank">
+  <img alt="" src="https://badgen.net/npm/v/material-react-table?color=blue" />
+</a>
+<a href="https://npmtrends.com/material-react-table" target="_blank">
+  <img alt="" src="https://badgen.net/npm/dt/material-react-table?label=installs&icon=npm&color=blue" />
+</a>
+<a href="https://bundlephobia.com/result?p=material-react-table" target="_blank">
+  <img alt="" src="https://badgen.net/bundlephobia/minzip/material-react-table@latest?color=blue" />
+</a>
+<a href="https://star-history.com/#kevinvandy/material-react-table&Date" target="_blank">
+  <img alt="" src="https://badgen.net/github/stars/KevinVandy/material-react-table?color=blue" />
+</a>
+<a href="https://github.com/KevinVandy/material-react-table/blob/v3/LICENSE" target="_blank">
+  <img alt="" src="https://badgen.net/github/license/KevinVandy/material-react-table?color=blue" />
+</a>
+ <a
+  href="https://github.com/sponsors/kevinvandy"
+  target="_blank"
+  rel="noopener"
+>
+  <img alt="" src="https://img.shields.io/badge/sponsor-violet" />
+</a>
+<a
+  href="https://discord.gg/5wqyRx6fnm"
+  target="_blank"
+  rel="noopener"
+>
+  <img alt="" src="https://dcbadge.vercel.app/api/server/5wqyRx6fnm?style=flat">
+</a>
+
+## About
+
+### _Quickly Create React Data Tables with Material Design_
+
+### **Built with [Material UI <sup>V6</sup>](https://mui.com) and [TanStack Table <sup>V8</sup>](https://tanstack.com/table/v8)**
+
+<img src="https://material-react-table.com/banner.png" alt="MRT" height="50" />
+
+> Want to use Mantine instead of Material UI? Check out [Mantine React Table](https://www.mantine-react-table.com)
+
+## Learn More
+
+- Join the [Discord](https://discord.gg/5wqyRx6fnm) server to join in on the development discussion or ask questions
+- View the [Docs Website](https://www.material-react-table.com/)
+- See all [Props, Options, APIs, Components, and Hooks](https://www.material-react-table.com/docs/api)
+
+### Quick Examples
+
+- [Basic Table](https://www.material-react-table.com/docs/examples/basic/) (See Default Features)
+- [Minimal Table](https://www.material-react-table.com/docs/examples/minimal/) (Turn off Features like Pagination, Sorting, Filtering, and Toolbars)
+- [Advanced Table](https://www.material-react-table.com/docs/examples/advanced/) (See some of the Advanced Features)
+- [Custom Headless Table](https://www.material-react-table.com/docs/examples/custom-headless/) (Build your own table markup)
+- [Dragging / Ordering Examples](https://www.material-react-table.com/docs/examples/column-ordering/) (Drag and Drop)
+- [Editing (CRUD) Examples](https://www.material-react-table.com/docs/examples/editing-crud/) (Create, Edit, and Delete Rows)
+- [Expanding / Grouping Examples](https://www.material-react-table.com/docs/examples/aggregation-and-grouping/) (Sum, Average, Count, etc.)
+- [Filtering Examples](https://www.material-react-table.com/docs/examples/filter-variants/) (Faceted Values, Switching Filters, etc.)
+- [Sticky Pinning Examples](https://www.material-react-table.com/docs/examples/sticky-header/) (Sticky Headers, Sticky Columns, Sticky Rows, etc.)
+- [Remote Data Fetching Examples](https://www.material-react-table.com/docs/examples/react-query/) (Server-side Pagination, Sorting, and Filtering)
+- [Virtualized Examples](https://www.material-react-table.com/docs/examples/virtualized/) (10,000 rows at once!)
+- [Infinite Scrolling](https://www.material-react-table.com/docs/examples/infinite-scrolling/) (Fetch data as you scroll)
+- [Localization (i18n)](https://www.material-react-table.com/docs/guides/localization#built-in-locale-examples) (Over a dozen languages built-in)
+
+View additional [storybook examples](https://www.material-react-table.dev/)
+
+## Features
+
+_All features can easily be enabled/disabled_
+
+_**Fully Fleshed out [Docs](https://www.material-react-table.com/docs/guides#guides) are available for all features**_
+
+- [x] 30-56kb gzipped - [Bundlephobia](https://bundlephobia.com/package/material-react-table)
+- [x] Advanced TypeScript Generics Support (TypeScript Optional)
+- [x] Aggregation and Grouping (Sum, Average, Count, etc.)
+- [x] Cell Actions (Right-click Context Menu)
+- [x] Click To Copy Cell Values
+- [x] Column Action Dropdown Menu
+- [x] Column Hiding
+- [x] Column Ordering via Drag'n'Drop
+- [x] Column Pinning (Freeze Columns)
+- [x] Column Resizing
+- [x] Customize Icons
+- [x] Customize Styling of internal Mui Components
+- [x] Data Editing and Creating (5 different editing modes)
+- [x] Density Toggle
+- [x] Detail Panels (Expansion)
+- [x] Faceted Value Generation for Filter Options
+- [x] Filtering (supports client-side and server-side)
+- [x] Filter Match Highlighting
+- [x] Full Screen Mode
+- [x] Global Filtering (Search across all columns, rank by best match)
+- [x] Header Groups & Footers
+- [x] Localization (i18n) support
+- [x] Manage your own state or let the table manage it internally for you
+- [x] Pagination (supports client-side and server-side)
+- [x] Row Actions (Your Custom Action Buttons)
+- [x] Row Numbers
+- [x] Row Ordering via Drag'n'Drop
+- [x] Row Pinning
+- [x] Row Selection (Checkboxes)
+- [x] SSR compatible
+- [x] Sorting (supports client-side and server-side)
+- [x] Theming (Respects your Material UI Theme)
+- [x] Toolbars (Add your own action buttons)
+- [x] Tree Data / Expanding Sub-rows
+- [x] Virtualization (@tanstack/react-virtual)
+
+## Getting Started
+
+### Installation
+
+View the full [Installation Docs](https://www.material-react-table.com/docs/getting-started/install)
+
+1. Ensure that you have React 18 or later installed
+
+2. Install Peer Dependencies (Material UI V6)
+
+```bash
+npm install @mui/material @mui/x-date-pickers @mui/icons-material @emotion/react @emotion/styled
+```
+
+3. Install material-react-table
+
+```bash
+npm install material-react-table
+```
+
+> _`@tanstack/react-table`, `@tanstack/react-virtual`, and `@tanstack/match-sorter-utils`_ are internal dependencies, so you do NOT need to install them yourself.
+
+### Usage
+
+> Read the full usage docs [here](https://www.material-react-table.com/docs/getting-started/usage/)
+
+```jsx
+import { useMemo, useState, useEffect } from 'react';
+import {
+  MaterialReactTable,
+  useMaterialReactTable,
+} from 'material-react-table';
+
+//data must be stable reference (useState, useMemo, useQuery, defined outside of component, etc.)
+const data = [
+  {
+    name: 'John',
+    age: 30,
+  },
+  {
+    name: 'Sara',
+    age: 25,
+  },
+];
+
+export default function App() {
+  const columns = useMemo(
+    () => [
+      {
+        accessorKey: 'name', //simple recommended way to define a column
+        header: 'Name',
+        muiTableHeadCellProps: { sx: { color: 'green' } }, //optional custom props
+        Cell: ({ cell }) => <span>{cell.getValue()}</span>, //optional custom cell render
+      },
+      {
+        accessorFn: (row) => row.age, //alternate way
+        id: 'age', //id required if you use accessorFn instead of accessorKey
+        header: 'Age',
+        Header: () => <i>Age</i>, //optional custom header render
+      },
+    ],
+    [],
+  );
+
+  //optionally, you can manage any/all of the table state yourself
+  const [rowSelection, setRowSelection] = useState({});
+
+  useEffect(() => {
+    //do something when the row selection changes
+  }, [rowSelection]);
+
+  const table = useMaterialReactTable({
+    columns,
+    data,
+    enableColumnOrdering: true, //enable some features
+    enableRowSelection: true,
+    enablePagination: false, //disable a default feature
+    onRowSelectionChange: setRowSelection, //hoist internal state to your own state (optional)
+    state: { rowSelection }, //manage your own state, pass it back to the table (optional)
+  });
+
+  const someEventHandler = () => {
+    //read the table state during an event from the table instance
+    console.log(table.getState().sorting);
+  };
+
+  return (
+    <MaterialReactTable table={table} /> //other more lightweight MRT sub components also available
+  );
+}
+```
+
+_Open in [Code Sandbox](https://codesandbox.io/s/simple-material-react-table-example-t5c3ji)_
+
+## Contributors
+
+<a href="https://github.com/kevinvandy/material-react-table/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=kevinvandy/material-react-table" />
+</a>
+
+PRs are Welcome, but please discuss in [GitHub Discussions](https://github.com/KevinVandy/material-react-table/discussions) or the [Discord Server](https://discord.gg/5wqyRx6fnm) first if it is a large change!
+
+Read the [Contributing Guide](https://github.com/KevinVandy/material-react-table/blob/v3/CONTRIBUTING.md) to learn how to run this project locally.
+
+<!-- Use the FORCE, Luke! -->

package/packages/material-react-table/build-locales.mjs

@@ -0,0 +1,112 @@
+/* eslint-disable */
+import typescript from '@rollup/plugin-typescript';
+import fs from 'fs';
+import { rollup } from 'rollup';
+
+const supportedLocales = [
+  'ar',
+  'az',
+  'bg',
+  'cs',
+  'da',
+  'de',
+  'el',
+  'en',
+  'es',
+  'et',
+  'fa',
+  'fi',
+  'fr',
+  'he',
+  'hr',
+  'hu',
+  'hy',
+  'id',
+  'it',
+  'ja',
+  'ko',
+  'nl',
+  'no',
+  'np',
+  'pl',
+  'pt',
+  'pt-BR',
+  'ro',
+  'ru',
+  'sk',
+  'sr-Cyrl-RS',
+  'sr-Latn-RS',
+  'sv',
+  'tr',
+  'uk',
+  'vi',
+  'zh-Hans',
+  'zh-Hant',
+];
+
+async function build(locale) {
+  const bundle = await rollup({
+    input: `./src/locales/${locale}.ts`,
+    plugins: [
+      typescript({
+        declaration: false,
+        declarationDir: undefined,
+        rootDir: './src',
+        sourceMap: false,
+      }),
+    ],
+  });
+
+  await bundle.write({
+    file: `./locales/${locale}/index.js`,
+    format: 'cjs',
+    sourcemap: false,
+  });
+
+  await bundle.write({
+    file: `./locales/${locale}/index.esm.js`,
+    format: 'esm',
+    sourcemap: false,
+  });
+
+  const typeFile = `import { type MRT_Localization } from '../..';
+export declare const MRT_Localization_${locale
+    .toUpperCase()
+    .replaceAll('-', '_')}: MRT_Localization;
+  `;
+
+  await fs.writeFile(`./locales/${locale}/index.d.ts`, typeFile, (err) => {
+    if (err) console.log(err);
+  });
+
+  await fs.writeFile(`./locales/${locale}/index.esm.d.ts`, typeFile, (err) => {
+    if (err) console.log(err);
+  });
+
+  await fs.writeFile(
+    `./locales/${locale}/package.json`,
+    JSON.stringify(
+      {
+        main: 'index.js',
+        module: 'index.esm.js',
+        sideEffects: false,
+        types: 'index.d.ts',
+      },
+      null,
+      2,
+    ),
+    (err) => {
+      if (err) console.log(err);
+    },
+  );
+
+  console.log(`Built ${locale} locale`);
+}
+
+async function run() {
+  for (const locale of supportedLocales) {
+    await build(locale);
+  }
+}
+
+run().catch((error) => console.error(error));

package/packages/material-react-table/index.ts

@@ -0,0 +1 @@
+export * from './src';

package/packages/material-react-table/package.json

@@ -0,0 +1,121 @@
+{
+  "version": "3.0.3",
+  "license": "MIT",
+  "name": "material-react-table-narender",
+  "description": "A fully featured Material UI V6 implementation of TanStack React Table V8, written from the ground up in TypeScript.",
+  "author": "KevinVandy",
+  "keywords": [
+    "react-table",
+    "material-ui",
+    "material-table",
+    "tanstack table",
+    "data table"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KevinVandy/material-react-table.git"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/kevinvandy"
+  },
+  "homepage": "https://www.material-react-table.com/",
+  "bugs": {
+    "url": "https://github.com/KevinVandy/material-react-table/issues"
+  },
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "locales",
+    "src"
+  ],
+  "size-limit": [
+    {
+      "path": "dist/index.js",
+      "limit": "55 KB"
+    },
+    {
+      "path": "dist/index.esm.js",
+      "limit": "51 KB"
+    }
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build": "pnpm lib:build",
+    "build-locales": "pnpm lib:build-locales",
+    "build-lib": "pnpm lib:build-lib",
+    "dev": "pnpm lib:dev",
+    "lib:build": "pnpm build-lib && pnpm build-locales",
+    "lib:build-locales": "node build-locales.mjs",
+    "lib:build-lib": "rmdir /s /q dist && rollup -c rollup.config.mjs && size-limit",
+    "lib:dev": "rollup -c rollup.config.mjs --watch",
+    "lint": "eslint .",
+    "size": "size-limit",
+    "storybook": "storybook dev -p 6006",
+    "storybook:build": "storybook build",
+    "storybook:dev": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
+  },
+  "devDependencies": {
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.0",
+    "@faker-js/faker": "^9.3.0",
+    "@mui/icons-material": "^6.2.0",
+    "@mui/material": "^6.2.0",
+    "@mui/x-date-pickers": "^7.23.2",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@size-limit/preset-small-lib": "^11.1.6",
+    "@storybook/addon-a11y": "^8.4.7",
+    "@storybook/addon-essentials": "^8.4.7",
+    "@storybook/addon-links": "^8.4.7",
+    "@storybook/addon-storysource": "^8.4.7",
+    "@storybook/blocks": "^8.4.7",
+    "@storybook/preview-api": "^8.4.7",
+    "@storybook/react": "^8.4.7",
+    "@storybook/react-vite": "^8.4.7",
+    "@types/node": "^22.10.2",
+    "@types/react": "^19.0.1",
+    "@types/react-dom": "^19.0.2",
+    "@typescript-eslint/eslint-plugin": "8.5.0",
+    "@typescript-eslint/parser": "8.5.0",
+    "@vitejs/plugin-react": "^4.3.4",
+    "eslint": "^9.16.0",
+    "eslint-plugin-mui-path-imports": "^0.0.15",
+    "eslint-plugin-perfectionist": "^4.3.0",
+    "eslint-plugin-storybook": "^0.11.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-is": "^19.0.0",
+    "rollup": "^2.79.1",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-delete": "^2.1.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "size-limit": "^11.1.6",
+    "storybook": "^8.4.7",
+    "storybook-dark-mode": "^4.0.2",
+    "tslib": "^2.8.1",
+    "typescript": "5.6.2",
+    "vite": "^6.0.3"
+  },
+  "peerDependencies": {
+    "@emotion/react": ">=11.13",
+    "@emotion/styled": ">=11.13",
+    "@mui/icons-material": ">=6",
+    "@mui/material": ">=6",
+    "@mui/x-date-pickers": ">=7.15",
+    "react": ">=18.0",
+    "react-dom": ">=18.0"
+  },
+  "dependencies": {
+    "@tanstack/match-sorter-utils": "8.19.4",
+    "@tanstack/react-table": "8.20.5",
+    "@tanstack/react-virtual": "3.11.1",
+    "highlight-words": "2.0.0"
+  }
+}

package/packages/material-react-table/rollup.config.mjs

@@ -0,0 +1,51 @@
+import pkg from './package.json' assert { type: 'json' };
+import typescript from '@rollup/plugin-typescript';
+import copy from 'rollup-plugin-copy';
+import del from 'rollup-plugin-delete';
+import dts from 'rollup-plugin-dts';
+import external from 'rollup-plugin-peer-deps-external';
+
+export default [
+  {
+    external: [
+      '@mui/icons-material',
+      '@mui/material',
+      '@mui/x-date-pickers',
+      '@tanstack/match-sorter-utils',
+      '@tanstack/react-table',
+      '@tanstack/react-virtual',
+      'highlight-words',
+      'react',
+    ],
+    input: './src/index.ts',
+    output: [
+      {
+        file: `./${pkg.main}`,
+        format: 'cjs',
+        sourcemap: true,
+      },
+      {
+        file: `./${pkg.module}`,
+        format: 'esm',
+        sourcemap: true,
+      },
+    ],
+    plugins: [
+      external(),
+      typescript({
+        rootDir: './src',
+      }),
+    ],
+  },
+  {
+    input: './dist/types/index.d.ts',
+    output: [{ file: `./${pkg.typings}`, format: 'esm' }],
+    plugins: [
+      del({
+        hook: 'buildEnd',
+        targets: ['dist/types'],
+      }),
+      dts(),
+    ],
+  },
+];

package/packages/material-react-table/src/components/MaterialReactTable.tsx

@@ -0,0 +1,36 @@
+import { useMaterialReactTable } from '../hooks/useMaterialReactTable';
+import {
+  type MRT_RowData,
+  type MRT_TableInstance,
+  type MRT_TableOptions,
+  type Xor,
+} from '../types';
+import { MRT_TablePaper } from './table/MRT_TablePaper';
+
+type TableInstanceProp<TData extends MRT_RowData> = {
+  table: MRT_TableInstance<TData>;
+};
+
+export type MaterialReactTableProps<TData extends MRT_RowData> = Xor<
+  TableInstanceProp<TData>,
+  MRT_TableOptions<TData>
+>;
+
+const isTableInstanceProp = <TData extends MRT_RowData>(
+  props: MaterialReactTableProps<TData>,
+): props is TableInstanceProp<TData> =>
+  (props as TableInstanceProp<TData>).table !== undefined;
+
+export const MaterialReactTable = <TData extends MRT_RowData>(
+  props: MaterialReactTableProps<TData>,
+) => {
+  let table: MRT_TableInstance<TData>;
+
+  if (isTableInstanceProp(props)) {
+    table = props.table;
+  } else {
+    table = useMaterialReactTable(props);
+  }
+
+  return <MRT_TablePaper table={table} />;
+};