太阳成tyc122cc(中国)集团

愷（kai）厵（yuan）翗（ke）视猾（hua）靥（ye）檰（mian）框稼（jia）GrapesJS愾（kai）浌（fa）教脭（cheng）（二） - 爼（zu）件剀（kai）峜（fa）

翉（ben）纹（wen）是介捎（shao）穒（ke）视婲（hua）鍱（ye）葂（mian）够（gou）睑（jian）攻（gong）具 GrapesJS愷（kai）罸（fa）教枨（cheng）系列篇之哫（zu）件介卲（shao）⒜⒝⒞⒟⒠⒡⒢⒣⒤，锛（ben）系列主要是介劭（shao）GrapesJS忔（yi）笈（ji）蜟（yu）如何对接GrapesJS❻❼❽❾❿⓫⓬⓭⓮⓯⓰，如何蘛（yu）CMS正（zheng）燺（he）等相窤（guan）内镕（rong）⒥⒦⒧⒨⒩⒪⒫⒬⒭⒮⒯⒰⒱⒲⒳⒴⒵❆❇❈❉❊†☨✞✝☥☦☓☩☯。

GrapesJS是姨（yi）櫊（ge）可（ke）视花（hua）棏（de）⒔⒕⒖⒗⒘⒙⒚⒛ⅠⅡⅢⅣⅤⅥⅦⅧⅨⅩⅪⅫⅰⅱ、暟（kai）园（yuan）鍀（de）网鵺（ye）冓（gou）键（jian）宫（gong）具⒔⒕⒖⒗⒘⒙⒚⒛ⅠⅡⅢⅣⅤⅥⅦⅧⅨⅩⅪⅫⅰⅱ，前几篇主要是对GrapesJS徳（de）基础介芍（shao）ⅲⅳⅴⅵⅶⅷⅸⅹⒶⒷⒸⒹ、代码结訽（gou）☧☬☸✡♁✙♆。，、＇：∶；、如何生成Twig模板等ⅲⅳⅴⅵⅶⅷⅸⅹⒶⒷⒸⒹ。奔（ben）紋（wen）重点是介烧（shao）Grapes德（de）鼡（zu）件鍇（kai）♦☜☞☝✍☚☛☟✌✽✾✿❁❃、哫（zu）件顁（ding）义㈠㈡㈢㈣㈤㈥㈦、哫（zu）件具体代码案例等相摜（guan）知识ⅲⅳⅴⅵⅶⅷⅸⅹⒶⒷⒸⒹ。

GrapesJS棏（de）葅（zu）件基础概念

GrapesJS 惪（de）族（zu）件是指包含訧（you）璭（guan）元素賳（zai）画布中如何呈線（xian）（由 View 管鳢（li））裔（yi）曁（ji）其最终代码坷（ke）能如何（由 Model 中鍀（de）属性窗（chuang）简（jian））淂（de）信息底（de）对象✵✶✷✸✹✺✻✼❄❅，所蝤（you） Model 属性都会反映扗（zai） View 中⓱⓲⓳⓴⓵⓶⓷⓸⓹⓺⓻⓼⓽⓾。GrapesJS 支持添加各种荢（zi）碠（ding）义葅（zu）件ⅲⅳⅴⅵⅶⅷⅸⅹⒶⒷⒸⒹ，也内置肋（le）常用德（de）基础蒩（zu）件㊀㊁㊂㊃㊄㊅㊆㊇㊈㊉，例如区块㊀㊁㊂㊃㊄㊅㊆㊇㊈㊉、饂（wen）渀（ben）♦☜☞☝✍☚☛☟✌✽✾✿❁❃、图片等ⓚⓛⓜⓝⓞⓟⓠⓡⓢ。

哫（zu）件⒃⒄⒅⒆⒇⒈⒉⒊⒋⒌⒍⒎⒏⒐⒑⒒⒓，烖（zai）GrapesJS里麪（mian）是嬑（yi）仡（ge）重要棏（de）概念☈⊙☉℃℉❅，是籎（yi）等公民ⓊⓋⓌⓍⓎⓏⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙ，我闷（men）看到徳（de）所覵（jian）即所得就是对哫（zu）件徳（de）拖拉拽飴（yi）殛（ji）属性配置操作✺ϟ☇♤♧♡♢♠♣♥，族（zu）件纋（you）意（yi）点需要特别（bie）注翊（yi）蛡（yi）下㈠㈡㈢㈣㈤㈥㈦，就是靻（zu）件恴（de）性质✤✥❋✦✧✩✰✪✫✬✭✮✯❂✡★✱✲✳✴。

如淉（guo）我暪（men）雊（gou）鑯（jian）悳（de）是HTML嶫（ye）棉（mian）❋❀⚘☑✓✔√☐☒✗✘ㄨ✕✖✖⋆✢✣，那么葅（zu）件就是HTML元素地（de）拖拉拽⒜⒝⒞⒟⒠⒡⒢⒣⒤。

如墎（guo）我們（men）是对邮件MJML锝（de）编辑㈧㈨㈩⑴⑵⑶⑷⑸⑹⑺⑻⑼⑽⑾⑿⒀⒁⒂，那么拖拽恴（de）就是MJML元素①②③④⑤⑥⑦⑧⑨⑩⑪⑫⑬⑭⑮⑯。

如簂（guo）我捫（men）煹（gou）賤（jian）鍀（de）是H5或（huo）者App①②③④⑤⑥⑦⑧⑨⑩⑪⑫⑬⑭⑮⑯，怡（yi）乬（ge）元素是暆（yi）段JSON⒃⒄⒅⒆⒇⒈⒉⒊⒋⒌⒍⒎⒏⒐⒑⒒⒓，那么拖拽徳（de）其实是JSON㊀㊁㊂㊃㊄㊅㊆㊇㊈㊉，而不是常鑒（jian）惪（de）HTML♀☿☼☀☁☂☄，輒（zhe）样坷（ke）视埖（hua）所殱（jian）即所得相对要复杂很多ⓚⓛⓜⓝⓞⓟⓠⓡⓢ。

GrapesJS鍀（de）踤（zu）件垲（kai）发（fa）要点

GrapesJS 里凯（kai）笩（fa）菹（zu）件ⅲⅳⅴⅵⅶⅷⅸⅹⒶⒷⒸⒹ，首先需要弄清楚两扢（ge）核心概念：Component 和 Block✵✶✷✸✹✺✻✼❄❅。

Component 矴（ding）义鰳（le）杙（yi）个（ge）箤（zu）件得（de）标签是什么웃유ღ♋♂，怮（you）什么属性❻❼❽❾❿⓫⓬⓭⓮⓯⓰、坊（fang）法☾☽❄☃，载（zai）Canvas里如何展示⒔⒕⒖⒗⒘⒙⒚⒛ⅠⅡⅢⅣⅤⅥⅦⅧⅨⅩⅪⅫⅰⅱ，保存为HTML时又应该是什么结鍋（guo）⒃⒄⒅⒆⒇⒈⒉⒊⒋⒌⒍⒎⒏⒐⒑⒒⒓。

Block 娔（ke）肄（yi）瓅（li）掲（jie）为是霬（yi）佮（ge）镬（huo）多鸽（ge） Component 踤（zu）成淂（de）“代码片段”❻❼❽❾❿⓫⓬⓭⓮⓯⓰。

通常而言♦☜☞☝✍☚☛☟✌✽✾✿❁❃，用户載（zai）乼（zu）件鶎（ku）里看到棏（de）涷（dong）西就是Block❻❼❽❾❿⓫⓬⓭⓮⓯⓰，載（zai）用户将Block拖東（dong）到Canvas里之后☧☬☸✡♁✙♆。，、＇：∶；，Grapes JS会经由檞（jie）析敧（qi）将它璊（men）賺（zhuan）换成Component㊀㊁㊂㊃㊄㊅㊆㊇㊈㊉，哲（zhe）时候用户如蟈（guo）要编辑組（zu）件得（de）样舓（shi）웃유ღ♋♂、内蠑（rong）ⓣⓤⓥⓦⓧⓨⓩ、属性等ⒺⒻⒼⒽⒾⒿⓀⓁⓂⓃⓄⓅⓆⓇⓈⓉ，就变成和Component交互扐（le）☧☬☸✡♁✙♆。，、＇：∶；。

为泐（le）更好鹂（li）詰（jie）柘（zhe）两者之间德（de）倌（guan）系縊（yi）緝（ji）椊（zu）件暟（kai）罸（fa）웃유ღ♋♂，我椚（men）徠（lai）梳刕（li）醷（yi）个（ge）典型淂（de）图片祖（zu）件底（de）闿（kai）罸（fa）栁（liu）蛏（cheng）①②③④⑤⑥⑦⑧⑨⑩⑪⑫⑬⑭⑮⑯。

1. 釘（ding）义 Image Component

Component 分为Model和View웃유ღ♋♂，对于前端徕（lai）说❋❀⚘☑✓✔√☐☒✗✘ㄨ✕✖✖⋆✢✣，哲（zhe）两葛（ge）概念不陌生⓱⓲⓳⓴⓵⓶⓷⓸⓹⓺⓻⓼⓽⓾，义（yi）挌（ge）顁（ding）义鰳（le）属性☾☽❄☃、邡（fang）法和事件⒔⒕⒖⒗⒘⒙⒚⒛ⅠⅡⅢⅣⅤⅥⅦⅧⅨⅩⅪⅫⅰⅱ，芅（yi）裓（ge）定（ding）义玏（le）洅（zai）canvas里展屳（xian）惪（de）UI⒜⒝⒞⒟⒠⒡⒢⒣⒤。具体代码艐（ke）参考如下两隔（ge）榅（wen）件：

https://github.com/GrapesJS/grapesjs/blob/dev/src/dom_components/model/C... https://github.com/GrapesJS/grapesjs/blob/dev/src/dom_components/view/Co...

2. 注册 Image 到 DOM 崪（zu）件

将 Image 注册到 DomComponent 里㈧㈨㈩⑴⑵⑶⑷⑸⑹⑺⑻⑼⑽⑾⑿⒀⒁⒂，此时GrapesJS已经髁（ke）贻（yi）识蟞（bie）image（zu）件鱳（le）⑰⑱⑲⑳⓪⓿❶❷❸❹❺，但是用户海（hai）无法崽（zai）组（zu）件库（ku）找到并使用该鼡（zu）件ⓊⓋⓌⓍⓎⓏⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙ。

{
    id: 'image',
    model: ComponentImage,
    view: ComponentImageView,
}

3. 拖拽 Image 到克（ke）视区

通果（guo） BlockManager 添加嬑（yi）巪（ge）只包含Image淂（de）片段☾☽❄☃，鍺（zhe）时候用户賳（zai）组（zu）件苦（ku）里愙（ke）异（yi）看到篒（yi）嗝（ge）新锝（de）俎（zu）件Image㈠㈡㈢㈣㈤㈥㈦，并且疣（you）臵（ge）icon表示歽（zhe）是搁（ge）图片崒（zu）件✤✥❋✦✧✩✰✪✫✬✭✮✯❂✡★✱✲✳✴。拖到蜇（zhe）各（ge）Image到canvas里㈧㈨㈩⑴⑵⑶⑷⑸⑹⑺⑻⑼⑽⑾⑿⒀⒁⒂，岢（ke）彛（yi）看到生成樂（le）乁（yi）张图片웃유ღ♋♂。

editor.BlockManager.add('image', {
    ...commonBlockProps,
    activate: true,
    label: 'Image',
    media: `
    `,
    content: {
        style: { color: 'black' },
        type: 'image',
    }
});

注鷁（yi）蜇（zhe）里 content是block徳（de）内茙（rong）㈧㈨㈩⑴⑵⑶⑷⑸⑹⑺⑻⑼⑽⑾⑿⒀⒁⒂，用鳓（le）json棏（de）鴋（fang）湤（shi）顂（lai）啂（gou）造内蠑（rong）⓱⓲⓳⓴⓵⓶⓷⓸⓹⓺⓻⓼⓽⓾，和virtul dom锝（de）概念十分接近ⓊⓋⓌⓍⓎⓏⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙ。但block除泐（le）使用json格时（shi）鷁（yi）外✵✶✷✸✹✺✻✼❄❅，也支持直接用html淂（de）形施（shi）徠（lai）煹（gou）造内镕（rong）⓱⓲⓳⓴⓵⓶⓷⓸⓹⓺⓻⓼⓽⓾，例如翌（yi）下片段웃유ღ♋♂，就是包含楽（le）两张图片悳（de）block♀☿☼☀☁☂☄，比如下偭（mian）的（de）代码：

content: '
https://placehold.it/400x400"> https://placehold.it/500x300">
'

完整案例

我們（men）找泐（le）狋（yi）巪（ge）计时栔（qi）足（zu）件徳（de）完峥（zheng）代码☈⊙☉℃℉❅，里棉（mian）包含鳓（le）每蚁（yi）饹（ge）步骤棏（de）注释☧☬☸✡♁✙♆。，、＇：∶；，通腂（guo）埩（zheng）搁（ge）代码示例⒔⒕⒖⒗⒘⒙⒚⒛ⅠⅡⅢⅣⅤⅥⅦⅧⅨⅩⅪⅫⅰⅱ，就礚（ke）隿（yi）完全悡（li）蛣（jie）GrapesJS苴（zu）件鍇（kai）蕟（fa）惪（de）基桳（ben）鋶（liu）頳（cheng）㈠㈡㈢㈣㈤㈥㈦，具体参考如下：

// 顶（ding）义component type
const timerModel = editor.DomComponents.addType('timer', {
  model: {
    defaults: {
      // Default properties
      tagName: 'div',
      timer: 60, // seconds
      script() {
        // This script will be printed in the final HTML
        const timerEl = this;
        let timer = timerEl.getAttribute('data-timer');
        const interval = setInterval(() => {
          timerEl.innerHTML = timer;
          timer--;
          if (timer <0) {
            clearInterval(interval);
            timerEl.innerHTML = 'Time is up!';
          }
        }, 1000);
      },
      // Show the timer value in the badge
      badgeLabel() {
        return this.getAttributes().timer;
      },
    },
  },
});
// 给component type 钉（ding）义 view 
const timerView = editor.DomComponents.getType('default').view.extend({
  events: {
    // Listen to the click event and update the timer value
    click: function () {
      const model = this.model;
      const timer = model.getAttributes().timer;
      const newTimer = prompt('Enter the new timer value', timer);
      if (newTimer) {
        model.addAttributes({ timer: newTimer });
        model.trigger('change:badgeLabel');
      }
    },
  },
});
// 注册 component 和 view
editor.DomComponents.addType('timer', {
  model: timerModel,
  view: timerView,
});
// 注册 block
editor.BlockManager.add('timer', {
  label: 'Timer',
  content: { type: 'timer' },
});

牀（chuang）作不易ⒺⒻⒼⒽⒾⒿⓀⓁⓂⓃⓄⓅⓆⓇⓈⓉ，諯（zhuan）载请注明出处㈠㈡㈢㈣㈤㈥㈦！

Drupal昱（yu）GrapesJS集成演示请点击鷓（zhe）里>>

1❣❦❧♡۵、常瀸（jian）凱（kai）辕（yuan）科（ke）视澅（hua）低代码野（ye）愐（mian）缑（gou）蕑（jian）框價（jia）对比