Skip to content

openbnet/grapesjs-custom-code

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GrapesJS Custom Code

This plugin adds the possibility to embed custom code

GrapesJS Custom Code

Requires GrapesJS v0.14.25 or higher

Summary

  • Plugin name: grapesjs-custom-code
  • Components
    • custom-code
  • Blocks
    • custom-code
  • Commands
    • custom-code:open-modal

Options

Option Description Default
blockLabel Label of the custom code block Custom Code
blockCustomCode Object to extend the default custom code block, eg. { label: 'Custom Code', category: 'Extra', ... }. Pass a falsy value to avoid adding the block {}
propsCustomCode Object to extend the default custom code properties, eg. { name: 'Custom Code', droppable: false, ... } {}
placeholderContent Initial content of the custom code component <span>Insert here your custom code</span>
toolbarBtnCustomCode Object to extend the default component's toolbar button for the code, eg. { label: '</>', attributes: { title: 'Open custom code' } }. Pass a falsy value to avoid adding the button {}
placeholderScript Content to show when the custom code contains <script> Check the source
modalTitle Title for the modal Insert your code
codeViewOptions Additional options for the code viewer, eg. { theme: 'hopscotch', readOnly: 0 } {}
buttonLabel Label for the default save button Save
commandCustomCode Object to extend the default custom code command, eg. { getPreContent: () => '<div>Paste here</div>' } Check the source to see all available methods {}

Download

  • CDN
    • https://unpkg.com/grapesjs-custom-code
  • NPM
    • npm i grapesjs-custom-code
  • GIT
    • git clone https://github.com/artf/grapesjs-custom-code.git

Usage

<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-custom-code.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
      container : '#gjs',
      ...
      plugins: ['grapesjs-custom-code'],
      pluginsOpts: {
        'grapesjs-custom-code': {
          // options
        }
      }
  });
</script>

Development

Clone the repository

$ git clone https://github.com/artf/grapesjs-custom-code.git
$ cd grapesjs-custom-code

Install dependencies

$ npm i

The plugin relies on GrapesJS via peerDependencies so you have to install it manually (without adding it to package.json)

$ npm i grapesjs --no-save

Start the dev server

$ npm start

License

BSD 3-Clause

About

GrapesJS component for the embed of custom code

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 88.8%
  • HTML 11.2%