package.json 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. {
  2. "name": "@zmjs/form-design",
  3. "version": "0.1.16",
  4. "description": "表单设计器",
  5. "packageManager": "pnpm@6.32.3",
  6. "keywords": [
  7. "form-design"
  8. ],
  9. "homepage": "https://github.com/zhiyuanzmj/form-design#readme",
  10. "bugs": {
  11. "url": "https://github.com/zhiyuanzmj/form-design/issues"
  12. },
  13. "license": "MIT",
  14. "author": "zhiyuanzmj <260480378@qq.com>",
  15. "repository": {
  16. "type": "git",
  17. "url": "git+https://github.com/zhiyuanzmj/form-design.git"
  18. },
  19. "funding": "https://github.com/sponsors/zhiyuanzmj",
  20. "main": "dist/index.umd.js",
  21. "module": "dist/index.es.js",
  22. "types": "dist/index.d.ts",
  23. "files": [
  24. "dist"
  25. ],
  26. "dependencies": {
  27. "@vueuse/core": "^8.2.3",
  28. "ace-builds": "^1.4.14",
  29. "element-plus": "^2.1.10",
  30. "lodash-es": "^4.17.21",
  31. "prismjs": "^1.28.0",
  32. "vue": "^3.2.31",
  33. "vue-prism-editor": "^2.0.0-alpha.2",
  34. "vuedraggable": "^4.1.0"
  35. },
  36. "devDependencies": {
  37. "@antfu/eslint-config": "^0.18.9",
  38. "@iconify/json": "^2.1.31",
  39. "@iconify/utils": "^1.0.32",
  40. "@types/lodash-es": "^4.17.6",
  41. "@types/node": "^17.0.23",
  42. "@types/prismjs": "^1.26.0",
  43. "@vitejs/plugin-vue": "^2.3.1",
  44. "@vitejs/plugin-vue-jsx": "^1.3.9",
  45. "eslint": "^8.12.0",
  46. "postcss": "^8.4.12",
  47. "postcss-html": "^1.3.0",
  48. "postcss-scss": "^4.0.3",
  49. "rollup": "^2.70.1",
  50. "sass": "^1.49.11",
  51. "stylelint": "^14.6.1",
  52. "stylelint-config-recess-order": "^3.0.0",
  53. "stylelint-config-standard-scss": "^3.0.0",
  54. "stylelint-config-standard-vue": "^1.0.0",
  55. "typescript": "^4.6.3",
  56. "unocss": "^0.30.11",
  57. "unplugin-auto-import": "^0.6.9",
  58. "unplugin-vue-components": "^0.18.5",
  59. "unplugin-vue-define-options": "^0.5.0",
  60. "vite": "^2.9.1",
  61. "vite-plugin-libcss": "^1.0.5",
  62. "vue-tsc": "^0.34.7"
  63. },
  64. "engines": {
  65. "node": ">=14"
  66. },
  67. "scripts": {
  68. "dev": "vue-tsc & vite build -w",
  69. "build": "vite build && vue-tsc",
  70. "play": "vite playground --open",
  71. "play:build": "vite build playground",
  72. "release": "npx bumpp --commit --tag --push"
  73. },
  74. "readme": "# @zmjs/form-create\n\n基于 Vue3.0 + vite + element-plus + TS 的自定义表单生成器。\n\n![预览](https://user-images.githubusercontent.com/32807958/163714729-de4ce227-0651-4637-8cd0-b0491179c449.png)\n\n### 支持功能\n\n- 远端数据获取\n- 图片上传\n- 栅格布局\n- 生成 JSON\n\n### 演示地址\n\n[https://zmjs-form-design.netlify.app/](https://zmjs-form-design.netlify.app/)\n\n### npm\n\n[https://www.npmjs.com/package/@zmjs/form-design](https://www.npmjs.com/package/@zmjs/form-design)\n\n## 1 安装\n\n```shell\n$ pnpm install @zmjs/form-design\n```\n\n```shell\n$ yarn add @zmjs/form-design\n```\n### 示例\n\n**npm 引入**\n\n```javascript\nimport { createApp } from 'vue'\nimport App from './App.vue'\nimport {DesignForm} from '@zmjs/form-design'\n\ncreateApp(App)\n .use(DesignForm)\n .mount('#app')\n```\n## 2 组件说明\n\n### 表单设计器(DesignForm)\n\n#### 示例\n\n```html\n<template>\n <DesignForm ref=\"designForm\" />\n</template>\n```\n\n#### API\n\n##### Props\n\n| 参数 | 说明 | 类型 | 默认值 |\n| :-----------: | :--------------------: | :-----: | :----: |\n| preview | 设计器预览操作按钮 | boolean | true |\n| generateJson | 设计器生成 Json 按钮 | boolean | true |\n| uploadJson | 设计器导入 JSON 按钮 | boolean | true |\n| clearable | 设计器清空按钮 | boolean | true |\n| basicFields | 设计器左侧基础字段配置 | array | - |\n| advanceFields | 设计器左侧高级字段配置 | array | - |\n| layoutFields | 设计器左侧布局字段配置 | array | - |\n\n##### 方法\n\n通过 ref 可以获取到实例并调用实例方法\n\n| 方法名 | 说明 | 参数 |\n| :---------------: | :--------------------------------: | :---------------------------: |\n| getJson() | 获取设计器配置的 JSON 数据 | - |\n| setJson(value) | 设置设计器的配置信息 | 通过 getJson 获取的数据 |\n| clear() | 清空设计器 | |\n\n### 表单生成器(GenerateForm)\n\n#### 示例\n\n```html\n<template>\n <GenerateForm ref=\"generateForm\" />\n</template>\n```\n\n#### API\n\n##### Props\n\n| 参数 | 说明 | 类型 | 默认值 |\n| :------: | :-------------------------------------------: | :-----: | :----: |\n| data | 表单 json 配置数据(从表单设计器获取的 json) | object | - |\n| value | 表单数据(从表单生成器获取的 value) | object | - |\n| disabled | 是否禁用 | boolean | false |\n\n##### 方法\n\n通过 ref 可以获取到实例并调用实例方法\n\n| 方法名 | 说明 | 参数 |\n| :-------: | :--------------------------: | :---------------------: |\n| getData() | 获取表单数据(返回 Promise) | - |\n| reset() | 重置表单数据 | 通过 getJson 获取的数据 |\n\n## 3 功能说明\n\n### 远端数据\n\n单选框,多选框,下拉选择框、级联选择器等选择项需要通过数据生成,这时可以配置远端数据。\n\n设置远端方法地址与返回值。\n\n![](https://ftp.bmp.ovh/imgs/2021/04/63b3a638b9a9d251.png)\n\n### 文件上传\n\n填写服务器上传地址、参数名等配置信息。\n\n![](https://ftp.bmp.ovh/imgs/2021/04/91624bc0a32bad63.png)"
  75. }