# form-generator

**Repository Path**: imyongwang/form-generator

## Basic Information

- **Project Name**: form-generator
- **Description**: 表单设计器，功能包括：表单编辑、表单填报及已填报表单显示
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 15
- **Created**: 2024-07-15
- **Last Updated**: 2024-07-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# form-generator

表单设计器，功能包括：表单编辑、表单填报及已填报表单显示

![Alt text](src/images/show.gif)

## 安装
```
npm install @huliuyu/form-generator 
```

## 使用
### 完整引入
```
main.js 中
import FG from '@huliuyu/form-generator'
import '@huliuyu/form-generator/form-generator.css'
Vue.use(FG)
```

## 包含组件
### 编辑器
```
<template>
  <div style="height: 100%">
    <el-button type="primary" @click="handlePublish">发布</el-button>
    <el-button type="primary" @click="handleValidate">校验</el-button>
    <FGDesigner ref="FGDesigner"  v-model="formConf" />
  </div>
</template>
export default {
  data() {
    return {
      formConf: {},
    };
  },
  methods: {
    handleValidate() {
      this.$refs.FGDesigner.validate((valid, message) => {
        if (valid) {
        } else {
          this.$message.error(message);
        }
      });
    },
    handlePublish() {
      this.$refs.FGDesigner.submit((value) => {
        console.log(value);
      });
    },
  },
};
```
#### Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-------|-------|-------|-------|-------|
| value / v-model | 为包含表单属性及组件列表的对象 | Object | - | - |
| form | 为包含表单组件对应的key和value | Object | - | - |
| enabled | 编辑器控件是否可以点击操作 | Boolean | - | false |
| defaultComs | 表单编辑器组件库 | Object | - | - |

#### Methods
| 方法名 | 说明 | 参数 |
|-------|-------|-------|
| validate | 对整个表单进行校验的方法，参数为一个回调函数。该回调函数会在校验结束后被调用，并传入两个个参数：校验是否通过、校验提示语 | Function(callback: Function(Boolean,Array)) | 
| submit | 对整个表单进行提交的方法，参数为一个回调函数。传入一个参数：即为已修改的value值 | Function(callback: Function(object)) | 

#### Event
| 事件名称 | 说明 | 回调参数 |
|-------|-------|-------|
| save | 点击保存按钮触发 | 新状态的value值，新状态的组件列表，新状态的表单属性 | 
| change | 数据更改触发 | 新状态的value值 | 

### PC表单渲染
```
<template>
  <FGPcForm ref="FGPcForm" v-model="drawingDefalut" :form='form' @submit='handleSubmit'/>
  <el-button @click='submitForm'>提交</el-button>
</template>

<script>
export default {
  data() {
    return {
      drawingDefalut: '',
      form:{}
    };
  },

  methods: {
    submitForm() {
      this.$refs["FGPcForm"].validateForm((form) => {
        console.log("form", form);
      });
    },
    resetForm() {
      this.$refs["FGPcForm"].resetForm();
    },
    handleSubmit(form,list) {

    }
  },
};
</script>
```
#### Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-------|-------|-------|-------|-------|
| value / v-model | 为包含表单属性及组件列表的对象 | String | - | - |
| form | 为包含表单组件对应的key和value | Object | - | - |

#### Methods
| 方法名 | 说明 | 参数 |
|-------|-------|-------|
| validateForm | 对整个表单进行校验的方法，参数为一个回调函数。该回调函数会在校验结束后被调用，并传入一个参数：即为校验通过的value值 | Function(callback: Function(object)) | 
| submitForm | 对整个表单进行提交的方法，参数为一个回调函数。传入一个参数：即为已修改的value值 | Function(callback: Function(object)) | 
| resetForm | 对整个表单进行重置，将所有字段值重置为初始值并移除校验结果 | - | 


### phone表单渲染
```
<template>
  <FGPhoneForm ref="FGPhoneForm" v-model="drawingDefalut" />
</template>

<script>
export default {
  data() {
    return {
      drawingDefalut: '',
    };
  },

  methods: {
    submitForm() {
      this.$refs["FGPhoneForm"].validateForm((form) => {
        console.log("form", form);
      });
    },
    resetForm() {
      this.$refs["FGPhoneForm"].resetForm();
    },
  },
};
</script> 
```
#### Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-------|-------|-------|-------|-------|
| value / v-model | 为包含表单属性及组件列表的对象 | String | - | - |
| form | 为包含表单组件对应的key和value | Object | - | - |

#### Methods
| 方法名 | 说明 | 参数 |
|-------|-------|-------|
| validateForm | 对整个表单进行校验的方法，参数为一个回调函数。该回调函数会在校验结束后被调用，并传入一个参数：即为校验通过的value值 | Function(callback: Function(object)) | 
| submitForm | 对整个表单进行提交的方法，参数为一个回调函数。传入一个参数：即为已修改的value值 | Function(callback: Function(object)) | 
| resetForm | 对整个表单进行重置，将所有字段值重置为初始值并移除校验结果 | - | 


### phone表单详情
```
<template>
  <FGPhoneShow :value="drawingDefalut" />
</template>
<script>
export default {
  data() {
    return {
      drawingDefalut: '',
    };
  },
};
</script>
```
#### Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-------|-------|-------|-------|-------|
| value | 为包含表单属性及组件列表的对象 | String | - | - |
| form | 为包含表单组件对应的key和value | Object | - | - |


### PC表单详情
```
<template>
  <FGPcShow :value="drawingDefalut" />
</template>

<script>
export default {
  data() {
    return {
      drawingDefalut: '',
    };
  },
};
</script>
```
#### Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-------|-------|-------|-------|-------|
| value | 为包含表单属性及组件列表的对象 | String | - | - |
| form | 为包含表单组件对应的key和value | Object | - | - |