<p align="center">
    <a href="http://www.form-create.com">
        <img width="200" src="http://file.lotkk.com/form-create.png">
    </a>
</p>

# form-create-designer

[![MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/xaboy/form-create-designer)
[![github](https://img.shields.io/badge/Author-xaboy-blue.svg)](https://github.com/xaboy)

**form-create-designer 是基于 [@form-create/element-ui](https://github.com/xaboy/form-create) 实现的表单设计器组件。可以通过拖拽的方式快速创建表单，提高开发者对表单的开发效率，节省开发者的时间。**

**[文档](http://designer.form-create.com/guide/) | [在线演示](http://form-create.com/designer?fr=github)**

> 如果对您有帮助，您可以点右上角 "Star" 支持一下 谢谢！本项目还在不断开发完善中,如有任何建议或问题[请在这里提出](https://github.com/xaboy/form-create-designer/issues/new)

> 本项目 QQ 讨论群[28963712](https://jq.qq.com/?_wv=1027&k=54aKUVw)

![demo1](http://form-create.com/img/designer-review.png)

## 安装

```shell
npm install @form-create/designer
```

## 引入

**CDN:**

```html
<!-- import Vue.js -->
<script src="//vuejs.org/js/vue.min.js"></script>
<!-- import stylesheet -->
<link rel="stylesheet" href="https://unpkg.com/element-ui/lib/theme-chalk/index.css" />
<!-- import element -->
<script src="https://unpkg.com/element-ui/lib/index.js"></script>
<!-- import form-create/element -->
<script src="//unpkg.com/@form-create/element-ui/dist/form-create.min.js"></script>
<!-- import form-create/designer -->
<script src="//unpkg.com/@form-create/designer/dist/index.min.js"></script>
```

**NodeJs:**

请自行导入`ElementUI`并挂载

```js
import formCreate from '@form-create/element-ui';
import FcDesigner from '@form-create/designer';

Vue.use(formCreate);
Vue.use(FcDesigner);
```

## 使用

```html
<fc-designer ref="designer" />
```

## 组件`props`

- **menu**`MenuList` 重新配置拖拽的组件
- **height**`int|string` 设计器组件高度, 默认`100%`

## 组件方法

- 获取当前生成表单的生成规则

  ```ts
  type getRule = () => Rule[];
  ```

  **示例: `this.$refs.designer.getRule()`**

- 获取当前表单的全局配置

  ```ts
  type getOption = () => Object;
  ```

- 设置当前生成表单的规则

  ```ts
  type setRule = (rules: Rule[]) => void;
  ```

- 设置当前表单的全局配置

  ```ts
  type setOption = (option: Object) => void;
  ```

- 增加一组拖拽组件

  ```ts
  type addMenu = (menu: Menu) => void;
  ```

- 删除一组拖拽组件

  ```ts
  type removeMenu = (name: string) => void;
  ```

- 批量覆盖插入拖拽组件

  ```ts
  type setMenuItem = (name: string, items: MenuItem[]) => void;
  ```

- 插入一个拖拽组件到分组

  ```ts
  type appendMenuItem = (name: string, item: MenuItem) => void;
  ```

- 删除一个拖拽组件

  ```ts
  type removeMenuItem = (item: string | MenuItem) => void;
  ```

- 新增一个拖拽组件的生成规则

      ```ts
      type addComponent = (item: DragRule) => void;
      ```

  > **提示! 内置的三个组件分组`name`分别为: `main`,`aide`,`layout`**

## 捐赠

![donation.jpg](http://form-create.com/img/donation.jpg)

## 联系

##### email : xaboy2005@qq.com

## License

[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2021-present xaboy
