# @cdzhxx/customform_build

> Custom Form Designer

Latest version **0.0.9** (published 2023-09-13) · 0 weekly downloads

## Install

```sh
npm install @cdzhxx/customform_build
pnpm add @cdzhxx/customform_build
yarn add @cdzhxx/customform_build
bun add @cdzhxx/customform_build
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2023-09-13 |
| First published | 2023-09-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | zhxx_zhaoyin |
| Maintainers | sdp_zhaoyin, z.bo, chenyucong |
| Keywords | customform_build, vform, element-Plus, form-designer |

## Links

- npm: https://www.npmjs.com/package/@cdzhxx/customform_build
- npm.io page: https://npm.io/package/@cdzhxx/customform_build

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.9 (latest) — 2023-09-13
- 0.0.8 — 2023-09-13
- 0.0.7 — 2023-09-13
- 0.0.6 — 2023-09-13
- 0.0.5 — 2023-09-13
- 0.0.4 — 2023-09-13
- 0.0.3 — 2023-09-13
- 0.0.2 — 2023-09-13
- 0.0.1 — 2023-09-13

## README

# 基于vue3.2的自定义表单组件

#### 1. 引入并全局注册组件
```js
import { createApp } from 'vue'
import App from './App.vue'

import ElementPlus from 'element-plus'  //引入element-plus库
import 'element-plus/dist/index.css'  //引入element-plus样式

import CustomForm from '@cdzhxx/custom_form'  
import '@cdzhxx/custom_form/dist/designer.style.css'

const app = createApp(App)
app.use(ElementPlus)  //全局注册element-plus
app.use(CustomForm) 

app.mount('#app')
```

<br/>

#### 2. 在Vue 3.x模板中使用表单设计器组件
```html
<template>
<CustomFormDesigner ref="vfdRef"></CustomFormDesigner>
</template>

<script setup>
const vfdRef = ref(null)
</script>

<style lang="scss">
body {
margin: 0;  /* 如果页面出现垂直滚动条，则加入此行CSS以消除之 */
}
</style>
```

<br/>

#### 3. 在Vue 3.x模板中使用表单渲染器组件
```html
<template>
<div>
 <v-form-render :form-json="formJson" :form-data="formData" :option-data="optionData" ref="vFormRef">
 </v-form-render>
 <el-button type="primary" @click="submitForm">Submit</el-button>
</div>
</template>
<script setup>
import { ref, reactive } from 'vue'
import { ElMessage } from 'element-plus'

const formJson = reactive({"widgetList":[],"formConfig":{"modelName":"formData","refName":"vForm","rulesName":"rules","labelWidth":80,"labelPosition":"left","size":"","labelAlign":"label-left-align","cssCode":"","customClass":"","functions":"","layoutType":"PC","jsonVersion":3,"onFormCreated":"","onFormMounted":"","onFormDataChange":""}})
const formData = reactive({})
const optionData = reactive({})
const vFormRef = ref(null)

const submitForm = () => {
 vFormRef.value.getFormData().then(formData => {
   // Form Validation OK
   alert( JSON.stringify(formData) )
 }).catch(error => {
   // Form Validation failed
   ElMessage.error(error)
 })
}
</script>
```

---
_Source: https://npm.io/package/@cdzhxx/customform_build · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._