@agile-team/mach-table-react 0.29.1 → 0.29.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agile-team/mach-table-react",
-  "version": "0.29.1",
+  "version": "0.29.2",
   "description": "Official React 18+ adapter for the MachTable enterprise data grid",
   "keywords": [
     "react",
@@ -96,14 +96,8 @@
   "sideEffects": [
     "**/*.css"
   ],
-  "scripts": {
-    "build": "tsup && node ../../scripts/copy-adapter-style.mjs react",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage"
-  },
   "dependencies": {
-    "@agile-team/mach-table": "workspace:*"
+    "@agile-team/mach-table": "0.29.2"
   },
   "peerDependencies": {
     "react": ">=18.0.0",
@@ -112,5 +106,12 @@
   "devDependencies": {
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
-  }
-}
+  },
+  "scripts": {
+    "build": "tsup && node ../../scripts/copy-adapter-style.mjs react",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
+  },
+  "readme": "<p align=\"center\">\n  <img src=\"https://raw.githubusercontent.com/ChenyCHENYU/MachTable/main/assets/mach-table-logo.svg\" alt=\"MachTable\" width=\"760\" />\n</p>\n\n# @agile-team/mach-table-react\n\nMachTable 0.28 的官方 React 18+ 适配包。一个依赖即可获得 Core、泛型 `<MachTable>`、应用/路由配置、按需工作流、StrictMode 安全清理和最新闭包事件处理。\n\n```bash\npnpm add @agile-team/mach-table-react\n```\n\n应用入口只引入一次样式：\n\n```ts\nimport \"@agile-team/mach-table-react/styles.css\";\n```\n\n## 基础接入\n\n```tsx\nimport { useMemo } from \"react\";\nimport { MachTable, indexColumn, useMachTable, type ColDef } from \"@agile-team/mach-table-react\";\n\ninterface Row { id: string; name: string }\n\nexport function Customers({ rows }: { rows: Row[] }) {\n  const table = useMachTable<Row>();\n  const columns = useMemo<ColDef<Row>[]>(\n    () => [indexColumn({ headerName: \"序号\" }), { field: \"name\", flex: 1, editable: true }],\n    []\n  );\n\n  return (\n    <div style={{ height: 520 }}>\n      <MachTable<Row>\n        apiRef={table.apiRef}\n        rowData={rows}\n        columnDefs={columns}\n        rowKey=\"id\"\n        enableColumnResize\n        persistence={{ key: \"customers:list\", sections: [\"columns\"] }}\n      />\n    </div>\n  );\n}\n```\n\n对象型列和配置建议用 `useMemo` 保持引用稳定。`useMachTable()` 同时提供 `apiRef`、响应式 `api` 与 `ready`。\n\n## 应用配置\n\n```ts\n// src/config/mach-table.config.ts\nimport { defineMachTableConfig, defineMachTablePreset } from \"@agile-team/mach-table-react\";\n\nexport default defineMachTableConfig({\n  defaults: {\n    size: \"compact\",\n    columnLayout: \"fit\",\n    enableColumnResize: true,\n    defaultColDef: { sortable: true, filter: true, resizable: true }\n  },\n  defaultPreset: \"list\",\n  presets: {\n    list: defineMachTablePreset({ stripedRows: true }),\n    crud: defineMachTablePreset({ rowSelection: \"multiple\", editType: \"fullRow\" })\n  }\n});\n```\n\n```tsx\n<MachTableProvider config={machTableConfig}>\n  <App />\n</MachTableProvider>\n```\n\nProvider 可按路由/布局嵌套，最近一层覆盖外层，表格 props 优先级最高。\n\n## 按需加载\n\nReact 不模拟全局组件注册。路由本身懒加载时普通 import 已自然拆包；需要独立边界时：\n\n```tsx\nconst MachTable = lazy(() => import(\"@agile-team/mach-table-react\"));\n```\n\n可选能力使用子入口：\n\n```tsx\nimport { useMachTableQuery, useMachTableEditing } from \"@agile-team/mach-table-react/workflows\";\nimport { MachTableToolbar } from \"@agile-team/mach-table-react/ui\";\nimport { reactCellRenderer } from \"@agile-team/mach-table-react/adapters\";\nimport { createWorkerDataProcessor } from \"@agile-team/mach-table-react/worker\";\n```\n\n- `/workflows`：请求取消、防过期覆盖、服务端分页、跨页选择、脏数据和冲突保存；`reset()` 清空全部表格过滤且只请求一次。\n- `/ui`：可选标准工具栏。\n- `/adapters`：自定义 React cell/detail renderer 桥接。\n- `/worker`：大型本地过滤/排序的独立 Worker 能力。\n\n```tsx\nconst query = useMachTableQuery({\n  query: filters,\n  queryKey: filters,\n  rowKey: \"id\",\n  request: orderApi.page,\n  mode: \"manual\"\n});\n\n<MachTable<Row> apiRef={table.apiRef} columnDefs={columns} {...query.bindings} />;\n```\n\n该包自动依赖 `@agile-team/mach-table` 并重导出 Core 类型；宿主只需提供 `react` 和 `react-dom >= 18`。\n\n文档：[React 指南](https://github.com/ChenyCHENYU/MachTable/blob/main/docs/guide/react.md) · [企业接入](https://github.com/ChenyCHENYU/MachTable/blob/main/docs/guide/enterprise-integration.md) · [SSR](https://github.com/ChenyCHENYU/MachTable/blob/main/docs/guide/ssr.md)\n\nSource-available © ChenyCHENYU (Agile Team). 任何使用均须事先取得书面授权。详见 [LICENSE](https://github.com/ChenyCHENYU/MachTable/blob/main/LICENSE) 与[授权流程](https://github.com/ChenyCHENYU/MachTable/blob/main/LICENSING.md)。\n"
+}