f-docx-editor 0.1.3 → 0.1.5

package/README.md

@@ -13,6 +13,7 @@ npm install f-docx-editor
 f-docx-editor/
 ├── src/
 │   ├── FDocxEditor.vue       # 核心组件
+│   ├── FDocxTemplateEditor.vue # 全文模板编辑组件
 │   ├── index.js              # 组件导出入口
 │   ├── App.vue               # 开发测试用 App
 │   └── main.js               # 开发入口
@@ -40,8 +41,7 @@ npm run build:lib
 发布到 npm
 
 npm run build:lib
-cd dist
-npm publish --access public
+npm run publish
 
 ```js
 import FDocxEditor from 'f-docx-editor'
@@ -90,11 +90,28 @@ import 'f-docx-editor/FDocxEditor.css'
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
 | `renderData` | `Object` | `{}` | docxtemplater 渲染数据，包含普通变量、循环数据、图表数据和富文本数据 |
-| `renderType` | `'view' \| 'edit'` | `'view'` | `view` 为只预览，`edit` 为定点可编辑 |
+| `renderType` | `'view' \| 'edit' \| 'templateEdit'` | `'view'` | `view` 为只预览，`edit` 为定点可编辑，`templateEdit` 为全文模板编辑 |
 | `templateUrl` | `String` | `''` | 推荐使用，指定 docx 模板文件地址 |
 | `templateFileName` | `String` | `'运营报告.docx'` | 未传 `templateUrl` 时，从站点根路径加载该文件 |
 | `exportFileName` | `String` | `''` | 自定义导出文件名 |
 
+## 模板编辑
+
+`renderType="templateEdit"` 会进入全文 Word 模板编辑模式。该模式直接加载原始 docx 模板，不执行变量渲染，也不会隐藏 `[EDITOR_START]` / `[EDITOR_END]` 等显性标签。
+
+保存模板时通过组件 ref 调用 `saveTemplate()`，组件会抛出 `template-save` 事件，由外层把修改后的 docx 文件提交给后端。
+
+```vue
+<template>
+  <FDocxEditor
+    ref="editorRef"
+    render-type="templateEdit"
+    template-url="/api/report-template.docx"
+    @template-save="handleTemplateSave"
+  />
+</template>
+```
+
 ## 暴露方法
 
 通过 `ref` 可以调用：
@@ -106,6 +123,8 @@ import 'f-docx-editor/FDocxEditor.css'
 | `getSavePayload()` | 获取建议提交给后端的保存结构 |
 | `getEditorHtml()` | 获取当前弹窗编辑器 HTML |
 | `getEditorJson()` | 获取当前弹窗编辑器 JSON |
+| `saveTemplate()` | 保存全文模板编辑后的 docx，并触发 `template-save` |
+| `reloadTemplate()` | 重新加载当前模板文件 |
 
 ## 数据安全建议
 

package/package.json

@@ -1,99 +1,58 @@
-{
-  "name": "f-docx-editor",
-  "version": "0.1.3",
-  "description": "Vue 3 Word docx preview, editable rich-text regions and docx export component.",
-  "keywords": [
-    "vue3",
-    "docx",
-    "docxtemplater",
-    "docx-preview",
-    "tiptap",
-    "word"
-  ],
-  "license": "MIT",
-  "main": "./dist/FDocxEditor.common.js",
-  "unpkg": "./dist/FDocxEditor.umd.min.js",
-  "jsdelivr": "./dist/FDocxEditor.umd.min.js",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "dev": "vue-cli-service serve",
-    "build": "vue-cli-service build",
-    "build:lib": "vue-cli-service build --target lib --name FDocxEditor --dest dist src/index.js && node scripts/prepare-package.mjs",
-    "lint": "vue-cli-service lint",
-    "prepublishOnly": "npm run build:lib"
-  },
-  "peerDependencies": {
-    "vue": "^3.2.13",
-    "element-plus": "^2.6.2"
-  },
-  "dependencies": {
-    "@element-plus/icons-vue": "^2.3.1",
-    "@tiptap/core": "3.23.5",
-    "@tiptap/extension-color": "3.23.5",
-    "@tiptap/extension-highlight": "3.23.5",
-    "@tiptap/extension-placeholder": "3.23.5",
-    "@tiptap/extension-table": "3.23.5",
-    "@tiptap/extension-table-cell": "3.23.5",
-    "@tiptap/extension-table-header": "3.23.5",
-    "@tiptap/extension-table-row": "3.23.5",
-    "@tiptap/extension-text-align": "3.23.5",
-    "@tiptap/extension-text-style": "3.23.5",
-    "@tiptap/pm": "3.23.5",
-    "@tiptap/starter-kit": "3.23.5",
-    "@tiptap/vue-3": "3.23.5",
-    "docx-preview": "^0.3.7",
-    "docxtemplater": "^3.68.7",
-    "docxtemplater-image-module-free": "^1.1.1",
-    "echarts": "^5.5.0",
-    "pizzip": "^3.2.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.12.16",
-    "@babel/eslint-parser": "^7.12.16",
-    "@vue/cli-plugin-babel": "~5.0.0",
-    "@vue/cli-plugin-eslint": "~5.0.0",
-    "@vue/cli-service": "~5.0.0",
-    "core-js": "^3.8.3",
-    "element-plus": "^2.6.2",
-    "eslint": "^7.32.0",
-    "eslint-plugin-vue": "^8.0.3",
-    "less": "^4.0.0",
-    "less-loader": "^8.0.0",
-    "vue": "^3.2.13"
-  },
-  "eslintConfig": {
-    "root": true,
-    "env": {
-      "node": true,
-      "browser": true
-    },
-    "extends": [
-      "plugin:vue/vue3-essential",
-      "eslint:recommended"
-    ],
-    "parserOptions": {
-      "parser": "@babel/eslint-parser",
-      "ecmaVersion": 2020,
-      "sourceType": "module"
-    },
-    "globals": {
-      "defineProps": "readonly",
-      "defineEmits": "readonly",
-      "defineExpose": "readonly"
-    },
-    "rules": {
-      "no-unused-vars": "error"
-    }
-  },
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not dead",
-    "not ie 11"
-  ],
-  "sideEffects": [
-    "*.css"
-  ]
-}
+{
+  "name": "f-docx-editor",
+  "version": "0.1.5",
+  "description": "Vue 3 Word docx preview, editable rich-text regions and docx export component.",
+  "keywords": [
+    "vue3",
+    "docx",
+    "docxtemplater",
+    "docx-preview",
+    "tiptap",
+    "word"
+  ],
+  "license": "MIT",
+  "main": "./FDocxEditor.common.js",
+  "module": "./FDocxEditor.common.js",
+  "style": "./FDocxEditor.css",
+  "unpkg": "./FDocxEditor.umd.min.js",
+  "jsdelivr": "./FDocxEditor.umd.min.js",
+  "files": [
+    "FDocxEditor.common.594.js",
+    "FDocxEditor.common.817.js",
+    "FDocxEditor.common.js",
+    "FDocxEditor.umd.828.js",
+    "FDocxEditor.umd.844.js",
+    "FDocxEditor.umd.js",
+    "FDocxEditor.umd.min.642.js",
+    "FDocxEditor.umd.min.947.js",
+    "FDocxEditor.umd.min.js",
+    "FDocxEditor.css",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@element-plus/icons-vue": "^2.3.1",
+    "@tiptap/core": "3.23.5",
+    "@tiptap/extension-color": "3.23.5",
+    "@tiptap/extension-highlight": "3.23.5",
+    "@tiptap/extension-placeholder": "3.23.5",
+    "@tiptap/extension-table": "3.23.5",
+    "@tiptap/extension-table-cell": "3.23.5",
+    "@tiptap/extension-table-header": "3.23.5",
+    "@tiptap/extension-table-row": "3.23.5",
+    "@tiptap/extension-text-align": "3.23.5",
+    "@tiptap/extension-text-style": "3.23.5",
+    "@tiptap/pm": "3.23.5",
+    "@tiptap/starter-kit": "3.23.5",
+    "@tiptap/vue-3": "3.23.5",
+    "docx-preview": "^0.3.7",
+    "docxtemplater": "^3.68.7",
+    "docxtemplater-image-module-free": "^1.1.1",
+    "echarts": "^5.5.0",
+    "element-plus": "2.6.2",
+    "pizzip": "^3.2.0",
+    "vue": "^3.2.13"
+  },
+  "sideEffects": [
+    "*.css"
+  ]
+}