# grapesjs-script-editor

> Grapesjs Script Editor

Latest version **1.0.4** (published 2025-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install grapesjs-script-editor
pnpm add grapesjs-script-editor
yarn add grapesjs-script-editor
bun add grapesjs-script-editor
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2025-10-23 |
| First published | 2020-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 23.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 27 |
| Maintainers | ju99ernaut |
| Keywords | grapesjs, plugin |

## Links

- npm: https://www.npmjs.com/package/grapesjs-script-editor
- Repository: https://github.com/Ju99ernaut/grapesjs-script-editor
- Homepage: https://github.com/Ju99ernaut/grapesjs-script-editor#readme
- Issues: https://github.com/Ju99ernaut/grapesjs-script-editor/issues
- npm.io page: https://npm.io/package/grapesjs-script-editor

## Dependencies (1)

- [remeda](https://npm.io/package/remeda.md) ^2.32.0

## Recent versions

- 1.0.4 (latest) — 2025-10-23
- 1.0.3 — 2021-02-08
- 1.0.2 — 2020-08-27
- 1.0.1 — 2020-08-11

## README

# Grapesjs Script Editor

Attach script to selected component

> Try to add after all components.

<p align="center">
  <img src="screenshot.png" alt="screenshot.png">
</p>

[DEMO](https://codepen.io/ju99ernaut/pen/NWNEWpV)

### HTML
```html
<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet">
<script src="https://unpkg.com/grapesjs"></script>
<script src="https://unpkg.com/grapesjs-script-editor"></script>

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

### JS
```js
const editor = grapesjs.init({
	container: '#gjs',
  height: '100%',
  fromElement: true,
  storageManager: false,
  plugins: ['grapesjs-script-editor'],
});
```

### CSS
```css
body, html {
  margin: 0;
  height: 100%;
}
```


## Summary

* Plugin name: `grapesjs-script-editor`
* Commands
    * `edit-script`


## Options

| Option | Description | Default |
|-|-|-
| `starter` | Starter code | `let el = this` |
| `toolbarIcon` | Toolbar icon for opening script modal | `<i class="fa fa-puzzle-piece"></i>` | 
| `scriptTypesSupport` | Component types to allow script editing, `avoid components with predefined scripts or scripts set elsewhere` | `['default', 'wrapper', 'text', 'textnode', 'image', 'video', 'svg']` |
| `toolbarBtnCustomScript` | Options to pass when extending toolbar | `{}` |
| `onRun` | Logic to run if debug is successful | `() => console.log('valid syntax')` |
| `onError` | Logic to run if debug finds errors | `err => console.log('error:',err)` |
| `modalTitle` | Title for script modal | `Script` |
| `codeViewOptions` | Additional options for the code viewer | `{}` |
| `buttonLabel` | Label for the default save button | `save` |
| `commandAttachScript` | Object to extend the default `edit-script` command | `{}` |



## Download

* CDN
  * `https://unpkg.com/grapesjs-script-editor`
* NPM
  * `npm i grapesjs-script-editor`
* GIT
  * `git clone https://github.com/Ju99ernaut/grapesjs-script-editor.git`



## Usage

Directly in the browser
```html
<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-script-editor.min.js"></script>

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

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

Modern javascript
```js
import grapesjs from 'grapesjs';
import plugin from 'grapesjs-script-editor';
import 'grapesjs/dist/css/grapes.min.css';

const editor = grapesjs.init({
  container : '#gjs',
  // ...
  plugins: [plugin],
  pluginsOpts: {
    [plugin]: { /* options */ }
  }
  // or
  plugins: [
    editor => plugin(editor, { /* options */ }),
  ],
});
```



## Development

Clone the repository

```sh
$ git clone https://github.com/Ju99ernaut/grapesjs-script-editor.git
$ cd grapesjs-script-editor
```

Install dependencies

```sh
$ pnpm i
```

Start the dev server

```sh
$ pnpm start
```

Build the source

```sh
$ pnpm run build
```



## License

MIT

---
_Source: https://npm.io/package/grapesjs-script-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._