form-generator 自定义组件添加流程

image.png

1.添加的组件必须全局注册,此处以一个自定义封装的代码编辑器为demo

// 自定义代码编辑器组件
//src\components\monacoEditor\index.vue
<template>
  <div class="full flex flex-column">
    <div class="toolbar flex align-center">
      <el-tooltip class="item" effect="dark" content="格式化" placement="top-start">
        <span class="format" @click.stop="handleFormat"> { } </span>
      </el-tooltip>
      <el-tooltip class="item" effect="dark" content="全屏" placement="top-start">
        <span class="screen" @click.stop="handleScreen">
          <i class="el-icon-full-screen"></i>
        </span>
      </el-tooltip>
    </div>
    <div class="flex-1 mt10 main" ref="main"></div>
  </div>
</template>

<script>
import loadMonaco from '@/utils/edit/loadMonaco';
import beautify from 'js-beautify';

export default {
  model: {
    prop: 'value',
    event: 'onchange'
  },
  props: {
    value: {
      type: String,
      default: ''
    },
    config: [Object]
  },
  data() {
    return {
      code: '',
      monacoEditor: null,
      fullscreen: false,
      configType: {
        html: {
          indent_size: '2',
          indent_char: ' ',
          max_preserve_newlines: '-1',
          preserve_newlines: false,
          keep_array_indentation: false,
          break_chained_methods: false,
          indent_scripts: 'separate',
          brace_style: 'end-expand',
          space_before_conditional: true,
          unescape_strings: false,
          jslint_happy: false,
          end_with_newline: true,
          wrap_line_length: '110',
          indent_inner_html: true,
          comma_first: false,
          e4x: true,
          indent_empty_lines: true
        },
        css: {
          indent_size: '2',
          indent_char: ' ',
          max_preserve_newlines: '-1',
          preserve_newlines: false,
          keep_array_indentation: false,
          break_chained_methods: false,
          indent_scripts: 'separate',
          brace_style: 'end-expand',
          space_before_conditional: true,
          unescape_strings: false,
          jslint_happy: false,
          end_with_newline: true,
          wrap_line_length: '110',
          indent_inner_html: true,
          comma_first: false,
          e4x: true,
          indent_empty_lines: true
        },
        js: {
          indent_size: '2',
          indent_char: ' ',
          max_preserve_newlines: '-1',
          preserve_newlines: false,
          keep_array_indentation: false,
          break_chained_methods: false,
          indent_scripts: 'normal',
          brace_style: 'end-expand',
          space_before_conditional: true,
          unescape_strings: false,
          jslint_happy: true,
          end_with_newline: true,
          wrap_line_length: '110',
          indent_inner_html: true,
          comma_first: false,
          e4x: true,
          indent_empty_lines: true
        }
      }
    };
  },
  mounted() {
    this.init();
  },
  watch: {
    value(val) {
      if (this.monacoEditor.getValue() !== val) {
        this.monacoEditor.setValue(val);
      }
    }
  },
  methods: {
    init() {
      loadMonaco(monaco => {
        this.monacoEditor = monaco.editor.create(this.$refs.main, {
          theme: 'vs-dark', // 主题
          value: this.value, // 默认显示的值
          language: this.config.language,
          folding: true, // 是否折叠
          minimap: {
            enabled: false // 是否启用预览图
          }, // 预览图设置
          foldingHighlight: true, // 折叠等高线
          foldingStrategy: 'indentation', // 折叠方式  auto | indentation
          showFoldingControls: 'always', // 是否一直显示折叠 always | mouseover
          disableLayerHinting: true, // 等宽优化
          emptySelectionClipboard: false, // 空选择剪切板
          selectionClipboard: false, // 选择剪切板
          automaticLayout: true, // 自动布局
          codeLens: true, // 代码镜头
          scrollBeyondLastLine: false, // 滚动完最后一行后再滚动一屏幕
          colorDecorators: true, // 颜色装饰器
          accessibilitySupport: 'on', // 辅助功能支持  "auto" | "off" | "on"
          lineNumbers: 'on', // 行号 取值: "on" | "off" | "relative" | "interval" | function
          lineNumbersMinChars: 5, // 行号最小字符   number
          enableSplitViewResizing: false,
          overviewRulerBorder: false, // 是否应围绕概览标尺绘制边框
          renderLineHighlight: 'gutter', // 当前行突出显示方式
          readOnly: false //是否只读  取值 true | false
        });
        this.monacoEditor.onDidChangeModelContent(e => {
          let val = this.monacoEditor.getValue();
          this.$emit('onchange', val);
          this.$emit('getValue', val);
        });
      });
    },
    handleScreen() {
      let element = this.$refs.main;
      if (this.fullscreen) {
        if (document.exitFullscreen) {
          document.exitFullscreen();
        } else if (document.webkitCancelFullScreen) {
          document.webkitCancelFullScreen();
        } else if (document.mozCancelFullScreen) {
          document.mozCancelFullScreen();
        } else if (document.msExitFullscreen) {
          document.msExitFullscreen();
        }
      } else {
        if (element.requestFullscreen) {
          element.requestFullscreen();
        } else if (element.webkitRequestFullScreen) {
          element.webkitRequestFullScreen();
        } else if (element.mozRequestFullScreen) {
          element.mozRequestFullScreen();
        } else if (element.msRequestFullscreen) {
          element.msRequestFullscreen();
        }
      }
      this.fullscreen = !this.fullscreen;
    },
    handleFormat() {
      const code = this.monacoEditor.getValue();
      let type = undefined;
      let newCode = undefined;
      if (this.config.language === 'javascript') {
        type = this.configType.js;
        newCode = beautify.js(code, type);
      } else if (this.config.language === 'css') {
        type = this.configType.css;
        newCode = beautify.css(code, type);
      } else {
        type = this.configType.html;
        newCode = beautify.html(code, type);
      }
      this.monacoEditor.setValue(newCode);
    }
  },
  beforeDestroy() {
    this.monacoEditor?.dispose();
  }
};
</script>

<style lang="scss" scoped>
.full {
  width: 100%;
  height: 100%;
  overflow: hidden;
  position: relative;
}
.screen,
.format {
  display: inline-block;
  width: 20px;
  height: 20px;
  line-height: 20px;
  cursor: pointer;
  font-size: 20px;
}
.format {
  float: left;
  font-size: 18px;
  margin: 7px 10px 0;
}
.el-icon-full-screen {
  float: left;
  margin-top: 5px;
}

.main {
  min-height: 0;
  &::v-deep {
    .monaco-editor {
      height: 100% !important;
    }
  }
}

.toolbar {
  position: absolute;
  right: 15px;
  top: 10px;
  color: #fff;
  z-index: 2;
}
</style>
main.js
// 全局注册富文本组件
import monacoEditor from '@/components/monacoEditor';
Vue.component('monacoEditor', monacoEditor);

2.在表单生成器的组件config内添加这个组件

src\components\generator\config.js
{
    __config__: {
      label: '代码编辑器',
      showLabel: true,
      changeTag: true,
      labelWidth: null,
      tag: 'monacoEditor',
      tagIcon: 'button',
      span: 24,
      layout: 'colFormItem',
      document: '#'
    },
    __slot__: {
      default: ''
    },
    style: { height: '300px' },
    config: { language: "javascript"},
    on: {
      'getValue':'setEditorValue'
    }
  }

注意:这里添加了3个属性,style,config,on

  • style用于调整编辑器默认高度
  • config是组件的其余配置,详细选项见富文本编辑器文档,此处仅设置编辑器语言为js
  • on是该编辑器自定义事件的监听
    对比编辑器正常使用方式如下
<editor :config="editorConfig" :value="form.eventCode" @getValue="getValue" />

此处的value表单生成器会默认赋值

3.为表单生成器添加事件监听与处理。
正常开发流程我们组件输入的时候会触发组件内的 this.$emit('getValue', val);
引用组件的父组件需要响应子组件上的@getValue方法,调用自身的getValue方法处理里面的逻辑

转换成代码生成器内的流程就是
编辑器组件输入内容=>触发this.$emit('getValue', val)=> 子组件监听getValue事件=>父组件处理getValue事件setEditorValue

子组件监听getValue事件
//src\components\render\render.js
function emitEvents(confClone) {
  ['on', 'nativeOn'].forEach(attr => {
    const eventKeyList = Object.keys(confClone[attr] || {})

    eventKeyList.forEach(key => {
      const val = confClone[attr][key]

      if (typeof val === 'string') {
        // 代码编辑器自定义事件注册
        // 将getValue的事件指向我们定义的setEditorValue去
        // confClone['on']['getValue'] = event => this.$emit('setEditorValue', event)
        confClone[attr][key] = event => this.$emit(val, event)
      }
    })
  })
}
//src\views\tool\build\pageview\formParse\Parser.vue
function buildListeners(scheme) {
  const config = scheme.__config__;
  console.log('scheme', scheme);
  let listeners = {};
  // 自定义事件插入
  let column = this.compData.cols.find(item => item.columName === scheme.columName);
  let _event = null;

  if (column && column.__event__) {
    _event = deepClone(column.__event__);
    Object.keys(_event).forEach(key => {
      listeners[key] = event => _event[key].call(this, event);
    });
  }

  ['on', 'nativeOn'].forEach(attr => {
    const eventKeyList = Object.keys(scheme[attr] || {});

    eventKeyList.forEach(key => {
      const val = scheme[attr][key];
      if (typeof val === 'string') {
        // 代码编辑器自定义事件注册
        // listeners['setEditorValue'] = this['setEditorValue'].bind(this);
        listeners[val] = this[val].bind(this, scheme);
      }
    });
  });

  // 响应 render.js 中的 vModel $emit('input', val)
  listeners.input = event => {
    setValue.call(this, event, config, scheme);
    if (_event && _event.input) _event.input.call(this);
  };
  console.log('listeners', listeners);
  return listeners;
}
// 调用了这个自定义方法
 setEditorValue(conf,e) {
      console.log('getValue',conf, e, this);;
      this.formData[conf.__vModel__] = e
    }

//此时相当于渲染了了一个这样的组件
<editor :config="editorConfig"  @getValue="setEditorValue" />
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,542评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,822评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,912评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,449评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,500评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,370评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,193评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,074评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,505评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,722评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,841评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,569评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,168评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,783评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,918评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,962评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,781评论 2 354

推荐阅读更多精彩内容