@le-form-create/designer 0.0.0-stage → 3.5.0-2026102105

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 xaboy
+
+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.md

@@ -1,3 +1,94 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @le-form-create/designer
+
+基于 form-create 的 Vue 3 低代码可视化表单设计器（Element Plus 版）。本包是上游 `@form-create/designer`（原 `xaboy/form-create-designer`）的 fork，在官方设计器基础上做了若干面向业务使用的定制扩展。
+
+## 基础依赖与上游关系（重要）
+
+很多使用者会混淆本项目的"基础"。明确如下：
+
+- 并不存在独立发布的 `@form-create/element-designer` 包。Element Plus 版的设计器在上游统一以 **`@form-create/designer`** 这一包名发布。
+- 本包就是 **`@form-create/designer`（Element Plus 版设计器）** 的 fork 与扩展。
+- `@form-create/designer` 本身**构建于 `@form-create/element-ui` 之上**：后者是面向 Vue 3 + Element Plus 的表单渲染 / 生成引擎（对外暴露 `formCreate`）。本包在 `package.json` 中将 `@form-create/element-ui`（当前 `@^3.3.1`）列为直接依赖。
+
+一句话总结：**本包 = `@form-create/designer` 的定制版，运行时依赖 `@form-create/element-ui` 表单引擎。**
+
+## 功能特性
+
+- 通过拖拽可视化设计表单，导出 / 导入 JSON 表单规则
+- 内置 40+ 常用表单组件与布局组件
+- 支持扩展自定义组件
+- 丰富的设计器操作 API（`FcDesigner` 实例方法、设计器配置 API）
+- 支持子表单、分组、事件配置、样式配置、表格布局、表单校验、多语言
+
+## 本 fork 相较上游的扩展
+
+以下为本包在上游基础之上新增 / 调整的定制内容：
+
+1. **常用组件宽度 100% 适配**
+   为富文本编辑器、日期、时间、级联选择器、计数器控件在外层 `fc-form-item` 父容器添加专属 class，并通过后代选择器把控件根节点宽度约束为 `100%`，使其在表单栅格内自适应铺满。仅约束容器，不改动控件内部布局。涉及：
+   - 富文本编辑器：`fc-rich-editor`
+   - 日期 / 日期区间：`fc-date-picker`
+   - 时间 / 时间区间、级联选择器：`fc-time-picker` / `fc-cascader`
+   - 计数器：`fc-input-number`
+
+2. **富文本编辑器封装组件 `FcRichEditor`**
+   对上游富文本组件（`@form-create/component-wangeditor`）做外层容器封装：`inheritAttrs: false`，将 `modelValue / disabled / config / init` 及 `v-model` 事件监听透传到底层编辑器，仅在外层容器施加 `fc-rich-editor` 宽度样式。
+
+3. **默认中文界面**
+   设计器根节点包裹 `el-config-provider` 并注入 `element-plus` 的 `zh-cn` locale，使日期 / 时间等组件默认显示中文。消费方仍可在自身 `ConfigProvider` 中覆盖语言。
+
+4. **内置「动态多行」组件（`TemplateName`）**
+   用于在表单字段内渲染可增删的动态多行数据表。支持配置：
+   - 第 0 列（key 列）：控件类型放开为全部控件类型，属性与单组件属性面板一致（含标准「选项数据」）；
+   - 第 1…N 列（value 列）：每列控件类型、属性、宽度可配；
+   - 列内控件对齐、不错位；
+   - 整组件 `disabled` / `readonly`，以及与校验联动的"按列精确描红"。
+
+## 安装
+
+```bash
+npm install @le-form-create/designer
+npm install element-plus
+```
+
+> `@form-create/element-ui` 已作为本包的依赖一并安装，无需单独安装。`element-plus` 需由使用方安装并在应用中注册（见"使用"）。
+
+## 使用
+
+```js
+import FcDesigner from '@le-form-create/designer'
+import ElementPlus from 'element-plus'
+import 'element-plus/dist/index.css'
+
+const app = createApp(App)
+app.use(ElementPlus)
+app.use(FcDesigner)
+app.use(FcDesigner.formCreate)
+```
+
+```html
+<fc-designer ref="designer" />
+```
+
+## CDN 用法
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/element-plus/dist/index.css" />
+<script src="https://unpkg.com/vue"></script>
+<script src="https://unpkg.com/element-plus/dist/index.full.js"></script>
+<script src="https://unpkg.com/@form-create/element-ui/dist/form-create.min.js"></script>
+<script src="https://unpkg.com/@le-form-create/designer/dist/index.umd.js"></script>
+```
+
+## 设计器 API 简述
+
+- 通过 `<fc-designer ref="designer" />` 获取 `FcDesigner` 实例，用于拖拽规则管理、组件增删、导出 JSON 等。
+- `FcDesigner.formCreate` 为底层 `formCreate` 引擎实例，需在 `app.use(FcDesigner)` 之后一并 `app.use(FcDesigner.formCreate)`。
+
+## 版本说明
+
+- 版本号沿用上游开源版本 `3.5.0` 作为基准，并以 `-YYYYMMDDnn` 后缀标识本 fork 的自定义构建，例如 `3.5.0-2026102104`。
+
+## License
+
+MIT © 2021-present xaboy（上游作者），本 fork 沿用 MIT 许可。