vue-formless 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Xu Yiming
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.en.md

@@ -0,0 +1,86 @@
+# vue-formless
+
+English | [简体中文](./README.md)
+
+> Vue 3 form library: a page-level control table plus FormView, with layout kept off the inputs. **0.1.1** — APIs may still change in 0.x.
+
+Same mixed layout: Element Row/Col/Item on the left, `<User.*>` plus nested `FormView` density on the right.
+
+![Mixed layout code](./docs/mixed-layout-code.png)
+
+Playground side by side (layout match):
+
+![Mixed layout preview](./docs/mixed-layout-preview.png)
+
+```bash
+pnpm add vue-formless
+# or npm i vue-formless
+```
+
+Peer: `vue` ^3.3.
+
+## Usage
+
+Bind host Form / Item / Row / Col once in the project (no official Element adapter):
+
+```ts
+import { ElCol, ElForm, ElFormItem, ElInput, ElRow } from 'element-plus'
+import { createFormControls, createFormView, resolveFormItemProp, type ItemFl } from 'vue-formless'
+
+declare module 'vue-formless' {
+  interface ControlSchema {
+    label?: string
+  }
+}
+
+export const FormView = createFormView({
+  layout: { Row: ElRow, Col: ElCol, column: 2, gutter: 16 },
+  form: {
+    component: ElForm,
+    props: (fl) => ({ model: fl.modelValue }),
+  },
+  item: {
+    component: ElFormItem,
+    props: (fl: ItemFl) => ({
+      label: fl.label,
+      prop: resolveFormItemProp(fl.binding, fl.controlKey),
+    }),
+  },
+})
+
+export const User = createFormControls({
+  name: { label: 'Name', component: ElInput },
+})
+```
+
+```vue
+<FormView ref="formRef" v-model="form" fl:layout label-width="96px">
+  <User.Name />
+  <User.Name col:span="max" />
+</FormView>
+```
+
+`validate()` / `resetFields()` go through the FormView ref (proxied host Form). Layout details: [docs/adr](./docs/adr/README.md).
+
+## Layout
+
+```text
+packages/vue-formless              # kernel (npm: vue-formless)
+packages/layout                    # internal grid, bundled into the kernel
+playground                         # Element Plus baseline vs Formless
+docs/adr                           # architecture decisions
+```
+
+## Development
+
+```bash
+pnpm i
+pnpm dev          # playground
+pnpm build        # library
+pnpm test
+pnpm typecheck
+```
+
+## License
+
+[MIT](./LICENSE)

package/README.md

@@ -0,0 +1,93 @@
+# vue-formless
+
+简体中文 | [English](./README.en.md)
+
+> Vue 3 表单组合式库：控件表 + FormView，布局与输入拆开。当前 **0.1.1**，`0.x` 期间 API 仍可能调整。
+
+同一套混合布局：左边手写 Element Row/Col/Item，右边 `<User.*>` + 嵌套 `FormView` 换密度。
+
+![混合布局代码对照](./docs/mixed-layout-code.png)
+
+Playground 平铺对比（布局对齐）：
+
+![混合布局平铺对比](./docs/mixed-layout-preview.png)
+
+```bash
+pnpm add vue-formless
+# 或 npm i vue-formless
+```
+
+peer：`vue` ^3.3。
+
+## 用法
+
+项目里绑一次宿主（无官方 Element 适配包）：
+
+```ts
+import { ElCol, ElForm, ElFormItem, ElInput, ElRow } from 'element-plus'
+import { createFormControls, createFormView, resolveFormItemProp, type ItemFl } from 'vue-formless'
+
+declare module 'vue-formless' {
+  interface ControlSchema {
+    label?: string
+  }
+}
+
+export const FormView = createFormView({
+  layout: { Row: ElRow, Col: ElCol, column: 2, gutter: 16 },
+  form: {
+    component: ElForm,
+    props: (fl) => ({ model: fl.modelValue }),
+  },
+  item: {
+    component: ElFormItem,
+    props: (fl: ItemFl) => ({
+      label: fl.label,
+      prop: resolveFormItemProp(fl.binding, fl.controlKey),
+    }),
+  },
+})
+
+export const User = createFormControls({
+  name: { label: '姓名', component: ElInput },
+})
+```
+
+```vue
+<FormView ref="formRef" v-model="form" fl:layout label-width="96px">
+  <User.Name />
+  <User.Name col:span="max" />
+</FormView>
+```
+
+`validate()` / `resetFields()` 走 FormView 的 ref（代理内层 Form）。栅格细节见 [docs/adr](./docs/adr/README.md)。
+
+## 仓库结构
+
+```text
+packages/vue-formless              # 内核（npm：vue-formless）
+packages/layout                    # 内部栅格，打进内核 dist
+playground                         # Element Plus 基线 vs Formless
+docs/adr                           # 架构决策
+```
+
+## 开发
+
+```bash
+pnpm i
+pnpm dev          # 启动 playground
+pnpm build        # 构建库
+pnpm test
+pnpm typecheck
+```
+
+Playground 对照：基础表单、筛选条、只读详情、混合布局、DateRange。
+
+```bash
+pnpm playground
+# http://localhost:5173
+```
+
+## License
+
+[MIT](./LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-formless",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Vue 3 表单组合式 hooks",
   "type": "module",
   "sideEffects": false,
@@ -15,16 +15,12 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "docs",
+    "README.md",
+    "README.en.md",
+    "LICENSE"
   ],
-  "scripts": {
-    "build": "pnpm --filter @vue-formless/layout build && vite build",
-    "dev": "vite build --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "pnpm typecheck && pnpm test && pnpm build"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/xuyimingwork/vue-formless.git"
@@ -48,14 +44,5 @@
   },
   "peerDependencies": {
     "vue": "^3.3.0"
-  },
-  "devDependencies": {
-    "@vue-formless/layout": "workspace:*",
-    "@vitejs/plugin-vue-jsx": "^5.1.6",
-    "typescript": "^5.8.3",
-    "vite": "^6.3.5",
-    "vite-plugin-dts": "^4.5.4",
-    "vitest": "^3.2.4",
-    "vue": "^3.5.16"
   }
 }