Free and Open source Web Builder Framework. Next generation tool for building templates without coding
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

114 lines
31 KiB

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Plugins | GrapesJS</title>
<meta name="generator" content="VuePress 1.9.7">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="https://grapesjs.com/stylesheets/grapes.min.css?v0.20.2">
<script src="https://grapesjs.com/js/grapes.min.js?v0.20.2"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.6349c0a4.css" as="style"><link rel="preload" href="/docs/assets/js/app.80738b64.js" as="script"><link rel="preload" href="/docs/assets/js/11.905ee507.js" as="script"><link rel="preload" href="/docs/assets/js/2.789685b7.js" as="script"><link rel="preload" href="/docs/assets/js/70.b895ef5d.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.b611ebf8.js"><link rel="prefetch" href="/docs/assets/js/12.7e617b34.js"><link rel="prefetch" href="/docs/assets/js/13.ea89d421.js"><link rel="prefetch" href="/docs/assets/js/14.3fe95cca.js"><link rel="prefetch" href="/docs/assets/js/15.12da73ac.js"><link rel="prefetch" href="/docs/assets/js/16.28089c68.js"><link rel="prefetch" href="/docs/assets/js/17.aba1b0c9.js"><link rel="prefetch" href="/docs/assets/js/18.59b405cc.js"><link rel="prefetch" href="/docs/assets/js/19.762bed57.js"><link rel="prefetch" href="/docs/assets/js/20.ce4f0990.js"><link rel="prefetch" href="/docs/assets/js/21.8428e67f.js"><link rel="prefetch" href="/docs/assets/js/22.e67f98fb.js"><link rel="prefetch" href="/docs/assets/js/23.3478a255.js"><link rel="prefetch" href="/docs/assets/js/24.4acb3e17.js"><link rel="prefetch" href="/docs/assets/js/25.000470f4.js"><link rel="prefetch" href="/docs/assets/js/26.34dd40e9.js"><link rel="prefetch" href="/docs/assets/js/27.590efc91.js"><link rel="prefetch" href="/docs/assets/js/28.4a546827.js"><link rel="prefetch" href="/docs/assets/js/29.06fa0e4b.js"><link rel="prefetch" href="/docs/assets/js/3.6d46cbb4.js"><link rel="prefetch" href="/docs/assets/js/30.90c84634.js"><link rel="prefetch" href="/docs/assets/js/31.107894dd.js"><link rel="prefetch" href="/docs/assets/js/32.bd8b1f7a.js"><link rel="prefetch" href="/docs/assets/js/33.bf80ccde.js"><link rel="prefetch" href="/docs/assets/js/34.6f9e211e.js"><link rel="prefetch" href="/docs/assets/js/35.dae21f45.js"><link rel="prefetch" href="/docs/assets/js/36.7637f557.js"><link rel="prefetch" href="/docs/assets/js/37.45c55c02.js"><link rel="prefetch" href="/docs/assets/js/38.de4a4691.js"><link rel="prefetch" href="/docs/assets/js/39.1173d4bd.js"><link rel="prefetch" href="/docs/assets/js/4.a96caa0e.js"><link rel="prefetch" href="/docs/assets/js/40.9fd75f1f.js"><link rel="prefetch" href="/docs/assets/js/41.61db9d6a.js"><link rel="prefetch" href="/docs/assets/js/42.f6fc35c7.js"><link rel="prefetch" href="/docs/assets/js/43.35d956da.js"><link rel="prefetch" href="/docs/assets/js/44.5e30b5f4.js"><link rel="prefetch" href="/docs/assets/js/45.b45ec64b.js"><link rel="prefetch" href="/docs/assets/js/46.84c4f007.js"><link rel="prefetch" href="/docs/assets/js/47.97691474.js"><link rel="prefetch" href="/docs/assets/js/48.de45fade.js"><link rel="prefetch" href="/docs/assets/js/49.c2b472b1.js"><link rel="prefetch" href="/docs/assets/js/5.09e23246.js"><link rel="prefetch" href="/docs/assets/js/50.2f95ea4d.js"><link rel="prefetch" href="/docs/assets/js/51.368d59fe.js"><link rel="prefetch" href="/docs/assets/js/52.07f761da.js"><link rel="prefetch" href="/docs/assets/js/53.133a17a4.js"><link rel="prefetch" href="/docs/assets/js/54.00f25b20.js"><link rel="prefetch" href="/docs/assets/js/55.6455a425.js"><link rel="prefetch" href="/docs/assets/js/56.ecabfa1f.js"><link rel="prefetch" href="/docs/assets/js/57.220b8cb9.js"><link rel="prefetch" href="/docs/assets/js/58.33d5b6d2.js"><link rel="prefetch" href="/docs/assets/js/59.50639267.js"><link rel="prefetch" href="/docs/assets/js/6.65ea4bd5.js"><link rel="prefetch" href="/docs/assets/js/60.682e1f97.js"><link rel="prefetch" href="/docs/assets/js/61.3c04beb2.js"><link rel="prefetch" href="/docs/assets/js/62.cf4b6d51.js"><link rel="prefetch" href="/docs/assets/js/63.20b964c9.js"><link rel="prefetch" href="/docs/assets/js/64.3e63ea36.js"><link rel="prefetch" href="/docs/assets/js/65.f6cfc03c.js"><link rel="prefetch" href="/docs/assets/js/66.aafbde31.js"><link rel="prefetch" href="/docs/assets/js/67.512c1bce.js"><link rel="prefetch" href="/docs/assets/js/68.5d0fd73e.js"><link rel="prefetch" href="/docs/assets/js/69.336907b8.js"><link rel="prefetch" href="/docs/assets/js/7.ad94be7a.js"><link rel="prefetch" href="/docs/assets/js/71.936899d0.js"><link rel="prefetch" href="/docs/assets/js/72.9103d3d6.js"><link rel="prefetch" href="/docs/assets/js/73.b49fb166.js"><link rel="prefetch" href="/docs/assets/js/74.064778f4.js"><link rel="prefetch" href="/docs/assets/js/8.9f6d8a0a.js"><link rel="prefetch" href="/docs/assets/js/9.31b45411.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.6349c0a4.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/docs/" class="home-link router-link-active"><img src="/docs/logo.png" alt="GrapesJS" class="logo"> <span class="site-name can-hide">GrapesJS</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/docs/" class="nav-link">
Docs
</a></div><div class="nav-item"><a href="/docs/api/" class="nav-link">
API Reference
</a></div><div class="nav-item"><a href="https://opencollective.com/grapesjs" target="_blank" rel="noopener noreferrer" class="nav-link external">
Support Us
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div><div class="nav-item"><a href="https://twitter.com/grapesjs" target="_blank" rel="noopener noreferrer" class="nav-link external">
Twitter
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div> <a href="https://github.com/artf/grapesjs" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/docs/" class="nav-link">
Docs
</a></div><div class="nav-item"><a href="/docs/api/" class="nav-link">
API Reference
</a></div><div class="nav-item"><a href="https://opencollective.com/grapesjs" target="_blank" rel="noopener noreferrer" class="nav-link external">
Support Us
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div><div class="nav-item"><a href="https://twitter.com/grapesjs" target="_blank" rel="noopener noreferrer" class="nav-link external">
Twitter
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></div> <a href="https://github.com/artf/grapesjs" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav> <div id="native-carbon" class="carbon-ads"></div> <ul class="sidebar-links"><li><a href="/docs/" aria-current="page" class="sidebar-link">Introduction</a></li><li><a href="/docs/getting-started.html" class="sidebar-link">Getting Started</a></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Modules</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/modules/Components.html" class="sidebar-link">Components</a></li><li><a href="/docs/modules/Components-js.html" class="sidebar-link">Components &amp; JS</a></li><li><a href="/docs/modules/Traits.html" class="sidebar-link">Traits</a></li><li><a href="/docs/modules/Blocks.html" class="sidebar-link">Blocks</a></li><li><a href="/docs/modules/Assets.html" class="sidebar-link">Assets</a></li><li><a href="/docs/modules/Commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/modules/I18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/modules/Selectors.html" class="sidebar-link">Selectors</a></li><li><a href="/docs/modules/Layers.html" class="sidebar-link">Layers</a></li><li><a href="/docs/modules/Style-manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/modules/Storage.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/modules/Modal.html" class="sidebar-link">Modal</a></li><li><a href="/docs/modules/Plugins.html" aria-current="page" class="active sidebar-link">Plugins</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/modules/Plugins.html#basic-plugin" class="sidebar-link">Basic plugin</a></li><li class="sidebar-sub-header"><a href="/docs/modules/Plugins.html#named-plugin" class="sidebar-link">Named plugin</a></li><li class="sidebar-sub-header"><a href="/docs/modules/Plugins.html#plugins-with-options" class="sidebar-link">Plugins with options</a></li><li class="sidebar-sub-header"><a href="/docs/modules/Plugins.html#named-plugins-vs-non-named-plugins" class="sidebar-link">Named Plugins vs Non-Named Plugins</a></li><li class="sidebar-sub-header"><a href="/docs/modules/Plugins.html#boilerplate" class="sidebar-link">Boilerplate</a></li><li class="sidebar-sub-header"><a href="/docs/modules/Plugins.html#popular-plugins" class="sidebar-link">Popular Plugins</a></li></ul></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Guides</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/docs/guides/Replace-Rich-Text-Editor.html" class="sidebar-link">Replace Rich Text Editor</a></li><li><a href="/docs/guides/Custom-CSS-parser.html" class="sidebar-link">Use Custom CSS Parser</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="plugins"><a href="#plugins" class="header-anchor">#</a> Plugins</h1> <p>Creating plugins in GrapesJS is pretty straightforward and here you'll get how to achieve it.</p> <p></p><div class="table-of-contents"><ul><li><a href="#basic-plugin">Basic plugin</a></li><li><a href="#named-plugin">Named plugin</a></li><li><a href="#plugins-with-options">Plugins with options</a></li><li><a href="#named-plugins-vs-non-named-plugins">Named Plugins vs Non-Named Plugins</a></li><li><a href="#boilerplate">Boilerplate</a></li><li><a href="#popular-plugins">Popular Plugins</a></li></ul></div><p></p> <h2 id="basic-plugin"><a href="#basic-plugin" class="header-anchor">#</a> Basic plugin</h2> <p>The most simple plugins are just functions that are run when the editor is being built.</p> <div class="language-js extra-class"><pre class="language-js"><code> <span class="token keyword">function</span> <span class="token function">myPlugin</span><span class="token punctuation">(</span><span class="token parameter">editor</span><span class="token punctuation">)</span><span class="token punctuation">{</span>
editor<span class="token punctuation">.</span>BlockManager<span class="token punctuation">.</span><span class="token function">add</span><span class="token punctuation">(</span><span class="token string">'my-first-block'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>
<span class="token literal-property property">label</span><span class="token operator">:</span> <span class="token string">'Simple block'</span><span class="token punctuation">,</span>
<span class="token literal-property property">content</span><span class="token operator">:</span> <span class="token string">'&lt;div class=&quot;my-block&quot;&gt;This is a simple block&lt;/div&gt;'</span><span class="token punctuation">,</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
<span class="token keyword">var</span> editor <span class="token operator">=</span> grapesjs<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token literal-property property">container</span> <span class="token operator">:</span> <span class="token string">'#gjs'</span><span class="token punctuation">,</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span>myPlugin<span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>This means that plugins can be moved to separate folders to keep thing cleaner or imported from NPM.</p> <div class="language-js extra-class"><pre class="language-js"><code> <span class="token keyword">import</span> myPlugin <span class="token keyword">from</span> <span class="token string">'./plugins/myPlugin'</span>
<span class="token keyword">import</span> npmPackage <span class="token keyword">from</span> <span class="token string">'@npm/package'</span>
<span class="token keyword">var</span> editor <span class="token operator">=</span> grapesjs<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token literal-property property">container</span> <span class="token operator">:</span> <span class="token string">'#gjs'</span><span class="token punctuation">,</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span>myPlugin<span class="token punctuation">,</span> npmPackage<span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="named-plugin"><a href="#named-plugin" class="header-anchor">#</a> Named plugin</h2> <p>If you're distributing your plugin globally, you may want to make a named plugin. To keep thing cleaner, so you'll probably get a similar structure:</p> <div class="language- extra-class"><pre class="language-text"><code>/your/path/to/grapesjs.min.js
/your/path/to/grapesjs-plugin.js
</code></pre></div><p><strong>Important:</strong> The order that you load files matters. GrapesJS has to be loaded before the plugin. This sets up the <code>grapejs</code> global variable.</p> <p>So, in your <code>grapesjs-plugin.js</code> file:</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">export</span> <span class="token keyword">default</span> grapesjs<span class="token punctuation">.</span>plugins<span class="token punctuation">.</span><span class="token function">add</span><span class="token punctuation">(</span><span class="token string">'my-plugin-name'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">editor<span class="token punctuation">,</span> options</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
<span class="token comment">/*
* Here you should rely on GrapesJS APIs, so check 'API Reference' for more info
* For example, you could do something like this to add some new command:
*
* editor.Commands.add(...);
*/</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre></div><p>The name <code>my-plugin-name</code> is an ID of your plugin and you'll use it to tell your editor to grab it.</p> <p>Here is a complete generic example:</p> <div class="language-html extra-class"><pre class="language-html"><code><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">src</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>http://code.jquery.com/jquery-2.2.0.min.js<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span><span class="token script"></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>link</span> <span class="token attr-name">rel</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>stylesheet<span class="token punctuation">&quot;</span></span> <span class="token attr-name">href</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>path/to/grapes.min.css<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">src</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>path/to/grapes.min.js<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span><span class="token script"></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">src</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>path/to/grapesjs-plugin.js<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span><span class="token script"></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>div</span> <span class="token attr-name">id</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>gjs<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>div</span><span class="token punctuation">&gt;</span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>script</span> <span class="token attr-name">type</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">&quot;</span>text/javascript<span class="token punctuation">&quot;</span></span><span class="token punctuation">&gt;</span></span><span class="token script"><span class="token language-javascript">
<span class="token keyword">var</span> editor <span class="token operator">=</span> grapesjs<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token literal-property property">container</span> <span class="token operator">:</span> <span class="token string">'#gjs'</span><span class="token punctuation">,</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">'my-plugin-name'</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</span></span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>script</span><span class="token punctuation">&gt;</span></span>
</code></pre></div><h2 id="plugins-with-options"><a href="#plugins-with-options" class="header-anchor">#</a> Plugins with options</h2> <p>It's also possible to pass custom parameters to plugins in to make them more flexible.</p> <div class="language-js extra-class"><pre class="language-js"><code> <span class="token keyword">var</span> editor <span class="token operator">=</span> grapesjs<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token literal-property property">container</span> <span class="token operator">:</span> <span class="token string">'#gjs'</span><span class="token punctuation">,</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">'my-plugin-name'</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token literal-property property">pluginsOpts</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token string-property property">'my-plugin-name'</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">customField</span><span class="token operator">:</span> <span class="token string">'customValue'</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Inside you plugin you'll get those options via <code>options</code> argument</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">export</span> <span class="token keyword">default</span> grapesjs<span class="token punctuation">.</span>plugins<span class="token punctuation">.</span><span class="token function">add</span><span class="token punctuation">(</span><span class="token string">'my-plugin-name'</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token parameter">editor<span class="token punctuation">,</span> options</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>options<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">//{ customField: 'customValue' }</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre></div><p>This also works with plugins that aren't named.</p> <div class="language-js extra-class"><pre class="language-js"><code> <span class="token keyword">import</span> myPlugin <span class="token keyword">from</span> <span class="token string">'../plugin'</span>
<span class="token keyword">var</span> editor <span class="token operator">=</span> grapesjs<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token literal-property property">container</span> <span class="token operator">:</span> <span class="token string">'#gjs'</span><span class="token punctuation">,</span>
<span class="token literal-property property">plugins</span><span class="token operator">:</span> <span class="token punctuation">[</span>myPlugin<span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token literal-property property">pluginsOpts</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token punctuation">[</span>myPlugin<span class="token punctuation">]</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token literal-property property">customField</span><span class="token operator">:</span> <span class="token string">'customValue'</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="named-plugins-vs-non-named-plugins"><a href="#named-plugins-vs-non-named-plugins" class="header-anchor">#</a> Named Plugins vs Non-Named Plugins</h2> <p>When you use a named plugin, then that name must be unique across all other plugins.</p> <div class="language-js extra-class"><pre class="language-js"><code>grapesjs<span class="token punctuation">.</span>plugins<span class="token punctuation">.</span><span class="token function">add</span><span class="token punctuation">(</span><span class="token string">'my-plugin-name'</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>In this example, the plugin name is <code>my-plugin-name</code> and can't be used by other plugins. To avoid namespace restrictions use basic plugins that are purely functional.</p> <h2 id="boilerplate"><a href="#boilerplate" class="header-anchor">#</a> Boilerplate</h2> <p>For fast plugin development, we highly recommend using <a href="https://github.com/artf/grapesjs-cli" target="_blank" rel="noopener noreferrer">grapesjs-cli<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> which helps to avoid the hassle of setting up all the dependencies and configurations for development and building (no need to touch Webpack o Babel configurations). For more information check the repository</p> <h2 id="popular-plugins"><a href="#popular-plugins" class="header-anchor">#</a> Popular Plugins</h2> <ul><li>https://github.com/artf/grapesjs-preset-webpage</li> <li>https://github.com/artf/grapesjs-preset-newsletter</li></ul></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/modules/Plugins.md" target="_blank" rel="noopener noreferrer">Edit this page on GitHub</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">11/7/2019, 1:06:32 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/modules/Modal.html" class="prev">
Modal
</a></span> <span class="next"><a href="/docs/guides/Replace-Rich-Text-Editor.html">
Replace Rich Text Editor
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.80738b64.js" defer></script><script src="/docs/assets/js/11.905ee507.js" defer></script><script src="/docs/assets/js/2.789685b7.js" defer></script><script src="/docs/assets/js/70.b895ef5d.js" defer></script>
</body>
</html>