@xbeeant/form-engine-react 0.0.1 → 0.0.2

package/README.md

@@ -1,69 +1,97 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      ...tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      ...tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      ...tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+# @xbeeant/form-engine-react
+
+`@xbeeant/form-engine` 的 React 渲染适配层。
+
+通过 `useSyncExternalStore` + 按路径精准版本订阅渲染字段，联动更新只重渲染受影响的组件；Schema 解析与路径计算全部在 Core 完成，本包直接消费渲染树。
+
+## 安装
+
+```bash
+npm install @xbeeant/form-engine-react @xbeeant/form-engine
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
+peerDependencies：`react >= 18`、`react-dom >= 18`。
+
+## 快速开始
+
+```tsx
+import { useForm, NexusForm } from '@xbeeant/form-engine-react';
+import { registerAntdUI } from '@xbeeant/form-engine-ui';
+
+const schema = {
+  type: 'object',
+  displayType: 'row',
+  properties: {
+    username: {
+      type: 'string',
+      widget: 'input',
+      title: '用户名',
+      required: true,
     },
+    age: { type: 'integer', widget: 'number', title: '年龄' },
   },
-])
+};
+
+function App() {
+  const [form] = useForm();
+  return (
+    <NexusForm
+      form={form}
+      schema={schema}
+      initialValues={{ username: 'alice' }}
+      onFinish={(values) => console.log(values)}
+      onFinishFailed={(errors) => console.log(errors)}
+      footer
+    />
+  );
+}
+```
+
+> 需要先注册 UI 组件：`registerAntdUI(engine)`（engine 由 `useForm()` 内部创建）或 `engine.use(antdPreset)` 注入 `@xbeeant/form-engine-ui`。未注册 widget 的字段会优雅降级渲染。
+
+## API
+
+### NexusForm
+
+| Prop | 类型 | 说明 |
+| :--- | :--- | :--- |
+| `form` | `FormController` | 由 `useForm()` 创建的表单实例 |
+| `schema` | `NexusSchema` | Schema 定义（缺省则渲染 children） |
+| `initialValues` | `Record<string, unknown>` | 初始值 |
+| `widgets` / `layouts` | `Record<string, (props) => ReactNode>` | 额外注册的组件 |
+| `onFinish` | `(formData) => void \| Promise` | 提交成功回调 |
+| `onFinishFailed` | `(errors: Map<string, string[]>) => void` | 校验失败回调 |
+| `footer` | `boolean \| ReactNode` | 是否显示默认提交/重置按钮，或自定义 |
+| `displayType` / `labelWidth` / `label` / `colon` / `column` / `readOnly` | — | 表单布局配置，优先级：组件 props > Schema 顶层 > 默认值 |
+| `className` / `style` / `children` | — | 常规属性 |
+
+### useForm
+
+```ts
+const [form] = useForm(); // 返回 [FormController]，可选 useForm(engine) 复用已有实例
 ```
+
+`FormController` 常用方法：`submit()`、`resetFields()`、`setValues(values)`、`setValueByPath(path, value)`、`getValues(paths?)`、`getAllValues()`、`getHiddenValues()`、`validateFields(paths?)`、`getFieldError(path)`、`setSchema(schema)`、`setSchemaByPath(path, patch)`、`registerValidator(path, fn)`、`scrollToPath(path)` 等。`submit` 失败时自动滚动聚焦第一个错误字段。
+
+### Hooks
+
+| Hook | 说明 |
+| :--- | :--- |
+| `useFormData()` | 订阅完整 formData（全局快照） |
+| `useFieldValue(path)` | 订阅单字段值（精准版本订阅，仅该字段重渲染） |
+| `useFieldState(path)` | 订阅单字段完整状态（value / errors / visible / required ...） |
+| `useWatch(path)` | 监听字段值变化（`(value, oldValue) => void`） |
+| `useWatchState(path)` | 监听字段状态变化 |
+| `useWatchMultiple(paths)` | 同时监听多个字段 |
+| `useWatchAll()` | 监听所有字段值变化 |
+| `useEngine()` | 获取当前引擎实例 |
+| `useFieldValidator(path, validator)` | 为字段注册校验器 |
+| `useFormConfig()` | 获取表单布局配置（displayType / labelWidth / column ...） |
+
+## 关联包
+
+| 包 | 说明 |
+| :--- | :--- |
+| `@xbeeant/form-engine` | 表单引擎核心（纯 TypeScript） |
+| `@xbeeant/form-engine-ui` | Ant Design 控件与布局库 |
+| `@xbeeant/form-engine-designer` | Schema 可视化设计器 |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xbeeant/form-engine-react",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -70,6 +70,7 @@
     }
   },
   "dependencies": {
-    "@xbeeant/form-engine": "^0.0.1"
-  }
+    "@xbeeant/form-engine": "^0.0.2"
+  },
+  "gitHead": "5e640d99e81bec24182061a9f431c39647e562dd"
 }