tsai
/
grapesjs
mirror of https://github.com/artf/grapesjs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

deploy docs

gh-pages
Artur Arseniev 5 years ago
parent
2c1268f043
commit
e30c4aaaba
118 changed files with 436 additions and 399 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 12
      docs/404.html
  2. 10
      docs/Home.html
  3. 16
      docs/api/assets.html
  4. 20
      docs/api/block_manager.html
  5. 17
      docs/api/canvas.html
  6. 14
      docs/api/commands.html
  7. 95
      docs/api/component.html
  8. 19
      docs/api/components.html
  9. 17
      docs/api/css_composer.html
  10. 14
      docs/api/device_manager.html
  11. 69
      docs/api/editor.html
  12. 20
      docs/api/i18n.html
  13. 12
      docs/api/index.html
  14. 14
      docs/api/keymaps.html
  15. 17
      docs/api/modal_dialog.html
  16. 52
      docs/api/page.html
  17. 18
      docs/api/pages.html
  18. 16
      docs/api/panels.html
  19. 14
      docs/api/rich_text_editor.html
  20. 17
      docs/api/selector_manager.html
  21. 17
      docs/api/storage_manager.html
  22. 27
      docs/api/style_manager.html
  23. 14
      docs/api/undo_manager.html
  24. 1
      docs/assets/css/0.styles.1858edcc.css
  25. 1
      docs/assets/css/0.styles.ac93482a.css
  26. 1
      docs/assets/js/10.66bafe27.js
  27. 2
      docs/assets/js/10.bc8d26ba.js
  28. 2
      docs/assets/js/11.e4a5286f.js
  29. 1
      docs/assets/js/12.05f31234.js
  30. 1
      docs/assets/js/12.8abc0790.js
  31. 2
      docs/assets/js/13.8130e741.js
  32. 2
      docs/assets/js/14.21fd784c.js
  33. 1
      docs/assets/js/15.8026aa70.js
  34. 1
      docs/assets/js/15.e1f63ebd.js
  35. 1
      docs/assets/js/16.50cb9f03.js
  36. 1
      docs/assets/js/16.5365d48a.js
  37. 2
      docs/assets/js/17.16a899b7.js
  38. 2
      docs/assets/js/18.2b682096.js
  39. 2
      docs/assets/js/19.c8bf26af.js
  40. 1
      docs/assets/js/2.15028157.js
  41. 1
      docs/assets/js/2.76987c6d.js
  42. 2
      docs/assets/js/20.7ee8a470.js
  43. 2
      docs/assets/js/21.80a868df.js
  44. 1
      docs/assets/js/22.b1817aaa.js
  45. 1
      docs/assets/js/22.c9db409a.js
  46. 1
      docs/assets/js/23.24b1a9f0.js
  47. 1
      docs/assets/js/23.eea06144.js
  48. 2
      docs/assets/js/24.0b14d393.js
  49. 2
      docs/assets/js/25.a736d8ee.js
  50. 1
      docs/assets/js/26.284071ba.js
  51. 1
      docs/assets/js/26.5a4f24ff.js
  52. 2
      docs/assets/js/27.f3b530ab.js
  53. 2
      docs/assets/js/28.f3e302a2.js
  54. 2
      docs/assets/js/29.0534d4fc.js
  55. 1
      docs/assets/js/3.9c33fa00.js
  56. 1
      docs/assets/js/3.ae005b76.js
  57. 1
      docs/assets/js/30.2f7bb3ab.js
  58. 1
      docs/assets/js/30.91585127.js
  59. 1
      docs/assets/js/31.58e6a8d0.js
  60. 1
      docs/assets/js/31.5b8e0e55.js
  61. 2
      docs/assets/js/32.9ea68a19.js
  62. 1
      docs/assets/js/33.4a67243d.js
  63. 1
      docs/assets/js/33.83a74dc0.js
  64. 1
      docs/assets/js/34.5195e151.js
  65. 2
      docs/assets/js/35.ee386620.js
  66. 2
      docs/assets/js/36.3c04f1d9.js
  67. 2
      docs/assets/js/37.29e16f9c.js
  68. 1
      docs/assets/js/37.9c426a13.js
  69. 1
      docs/assets/js/38.5d32b029.js
  70. 1
      docs/assets/js/38.b708d72a.js
  71. 1
      docs/assets/js/39.9a58de40.js
  72. 1
      docs/assets/js/39.b704c28a.js
  73. 1
      docs/assets/js/4.20f46c0c.js
  74. 1
      docs/assets/js/4.f31d6c5b.js
  75. 1
      docs/assets/js/40.8e6d589e.js
  76. 2
      docs/assets/js/41.3352d1b5.js
  77. 2
      docs/assets/js/42.57cce0c6.js
  78. 2
      docs/assets/js/43.a4256f15.js
  79. 2
      docs/assets/js/44.c05e59f9.js
  80. 2
      docs/assets/js/45.3e7d2ba2.js
  81. 1
      docs/assets/js/45.54999ce9.js
  82. 1
      docs/assets/js/46.c362554c.js
  83. 2
      docs/assets/js/47.a5e549f1.js
  84. 2
      docs/assets/js/48.2e375343.js
  85. 2
      docs/assets/js/49.88dd7cce.js
  86. 1
      docs/assets/js/5.5d310613.js
  87. 1
      docs/assets/js/5.a0dda975.js
  88. 2
      docs/assets/js/50.c459c2cb.js
  89. 2
      docs/assets/js/51.47c12f8d.js
  90. 2
      docs/assets/js/52.334fdb25.js
  91. 1
      docs/assets/js/52.c9e3636a.js
  92. 1
      docs/assets/js/53.ec424eac.js
  93. 2
      docs/assets/js/54.91803c3a.js
  94. 2
      docs/assets/js/55.266c6160.js
  95. 1
      docs/assets/js/6.08f4bcf8.js
  96. 1
      docs/assets/js/6.f7435f21.js
  97. 1
      docs/assets/js/7.cf6e89f4.js
  98. 1
      docs/assets/js/7.d040063a.js
  99. 1
      docs/assets/js/8.904f276f.js
  100. 1
      docs/assets/js/9.acf071b7.js

12
docs/404.html
View File

@ -4,19 +4,19 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/18.b7385ed2.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/11.00909638.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/2.76987c6d.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/18.2b682096.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/11.e4a5286f.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/2.15028157.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><div class="theme-default-content"><h1>404</h1> <blockquote>There's nothing here.</blockquote> <a href="/docs/" class="router-link-active">
<div id="app" data-server-rendered="true"><div class="theme-container"><div class="theme-default-content"><h1>404</h1> <blockquote>Looks like we've got some broken links.</blockquote> <a href="/docs/" class="router-link-active">
Take me home.
</a></div></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/18.b7385ed2.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/18.2b682096.js" defer></script>
</body>
</html>

10
docs/Home.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Getting started | GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/19.46b34bc8.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/19.c8bf26af.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -337,6 +337,6 @@ The default one is the localStorage which is pretty simple and all the data are
<span class="token punctuation">}</span>
<span class="token operator">...</span>
</code></pre></div><blockquote><p>Check <a href="API-Storage-Manager">Storage Manager API Reference</a></p></blockquote></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/Home.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">7/13/2018, 12:12:35 AM</span></div></footer> <!----> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/19.46b34bc8.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/19.c8bf26af.js" defer></script>
</body>
</html>

16
docs/api/assets.html
View File

File diff suppressed because one or more lines are too long

20
docs/api/block_manager.html
View File

File diff suppressed because one or more lines are too long

17
docs/api/canvas.html
View File

File diff suppressed because one or more lines are too long

14
docs/api/commands.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/25.9769e6e3.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/25.a736d8ee.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" aria-current="page" class="active sidebar-link">Commands</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/commands.html#commands" class="sidebar-link">Commands</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#extend" class="sidebar-link">extend</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#has" class="sidebar-link">has</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#run" class="sidebar-link">run</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#stop" class="sidebar-link">stop</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#isactive" class="sidebar-link">isActive</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#getactive" class="sidebar-link">getActive</a></li></ul></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="commands"><a href="#commands" class="header-anchor">#</a> Commands</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/commands/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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><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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" aria-current="page" class="active sidebar-link">Commands</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/commands.html#commands" class="sidebar-link">Commands</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#extend" class="sidebar-link">extend</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#has" class="sidebar-link">has</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#run" class="sidebar-link">run</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#stop" class="sidebar-link">stop</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#isactive" class="sidebar-link">isActive</a></li><li class="sidebar-sub-header"><a href="/docs/api/commands.html#getactive" class="sidebar-link">getActive</a></li></ul></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="commands"><a href="#commands" class="header-anchor">#</a> Commands</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/commands/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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>
commands<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// options</span>
<span class="token punctuation">}</span>
@ -71,7 +71,7 @@ commands<span class="token punctuation">.</span><span class="token function">isA
<span class="token comment">// -&gt; false</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank" rel="noopener noreferrer">Boolean<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></strong></p> <h2 id="getactive"><a href="#getactive" class="header-anchor">#</a> getActive</h2> <p>Get all active commands</p> <h3 id="examples-7"><a href="#examples-7" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>commands<span class="token punctuation">.</span><span class="token function">getActive</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// -&gt; { someCommand: itsLastReturn, anotherOne: ... };</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/commands.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">5/2/2019, 1:28:33 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/commands.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/block_manager.html" class="prev">
Block Manager
@ -80,6 +80,6 @@ commands<span class="token punctuation">.</span><span class="token function">isA
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/25.9769e6e3.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/25.a736d8ee.js" defer></script>
</body>
</html>

95
docs/api/component.html
View File

File diff suppressed because one or more lines are too long

19
docs/api/components.html
View File

File diff suppressed because one or more lines are too long

17
docs/api/css_composer.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/28.cc45d02f.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/28.f3e302a2.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" aria-current="page" class="active sidebar-link">CSS Composer</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#csscomposer" class="sidebar-link">CssComposer</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#load" class="sidebar-link">load</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#store" class="sidebar-link">store</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#clear" class="sidebar-link">clear</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#setrule" class="sidebar-link">setRule</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#getrule" class="sidebar-link">getRule</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#getrules" class="sidebar-link">getRules</a></li></ul></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="csscomposer"><a href="#csscomposer" class="header-anchor">#</a> CssComposer</h2> <p>This module contains and manage CSS rules for the template inside the canvas.
<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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" aria-current="page" class="active sidebar-link">CSS Composer</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#csscomposer" class="sidebar-link">CssComposer</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#load" class="sidebar-link">load</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#store" class="sidebar-link">store</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#clear" class="sidebar-link">clear</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#setrule" class="sidebar-link">setRule</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#getrule" class="sidebar-link">getRule</a></li><li class="sidebar-sub-header"><a href="/docs/api/css_composer.html#getrules" class="sidebar-link">getRules</a></li></ul></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="csscomposer"><a href="#csscomposer" class="header-anchor">#</a> CssComposer</h2> <p>This module contains and manage CSS rules for the template inside the canvas.
You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/css_composer/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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>
cssComposer<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// options</span>
@ -60,8 +60,7 @@ rule<span class="token punctuation">.</span><span class="token function">set</sp
width<span class="token operator">:</span> <span class="token string">'300px'</span><span class="token punctuation">,</span>
color<span class="token operator">:</span> <span class="token string">'#000'</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>Returns <strong>(Model | null)</strong></p> <h2 id="getall"><a href="#getall" class="header-anchor">#</a> getAll</h2> <p>Get the collection of rules</p> <p>Returns <strong>Collection</strong></p> <h2 id="clear"><a href="#clear" class="header-anchor">#</a> clear</h2> <p>Remove all rules</p> <h3 id="parameters-5"><a href="#parameters-5" class="header-anchor">#</a> Parameters</h3> <ul><li><code>opts</code> (optional, default <code>{}</code>)</li></ul> <p>Returns <strong>this</strong></p> <h2 id="setrule"><a href="#setrule" class="header-anchor">#</a> setRule</h2> <p>Add/update the CSS rule with a generic selector</p> <h3 id="parameters-6"><a href="#parameters-6" class="header-anchor">#</a> Parameters</h3> <ul><li><code>selectors</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">string<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></strong> Selector, eg. '.myclass'</li> <li><code>style</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Style properties and values</li> <li><code>opts</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Additional properties (optional, default <code>{}</code>)
<ul><li><code>opts.atRuleType</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> At-rule type, eg. 'media' (optional, default <code>''</code>)</li> <li><code>opts.atRuleParams</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> At-rule parameters, eg. '(min-width: 500px)' (optional, default <code>''</code>)</li></ul></li></ul> <h3 id="examples-3"><a href="#examples-3" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// Simple class-based rule</span>
</code></pre></div><p>Returns <strong>(Model | null)</strong></p> <h2 id="getall"><a href="#getall" class="header-anchor">#</a> getAll</h2> <p>Get the collection of rules</p> <p>Returns <strong>Collection</strong></p> <h2 id="clear"><a href="#clear" class="header-anchor">#</a> clear</h2> <p>Remove all rules</p> <h3 id="parameters-5"><a href="#parameters-5" class="header-anchor">#</a> Parameters</h3> <ul><li><code>opts</code> (optional, default <code>{}</code>)</li></ul> <p>Returns <strong>this</strong></p> <h2 id="setrule"><a href="#setrule" class="header-anchor">#</a> setRule</h2> <p>Add/update the CSS rule with a generic selector</p> <h3 id="parameters-6"><a href="#parameters-6" class="header-anchor">#</a> Parameters</h3> <ul><li><p><code>selectors</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">string<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></strong> Selector, eg. '.myclass'</p></li> <li><p><code>style</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Style properties and values</p></li> <li><p><code>opts</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Additional properties (optional, default <code>{}</code>)</p> <ul><li><code>opts.atRuleType</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> At-rule type, eg. 'media' (optional, default <code>''</code>)</li> <li><code>opts.atRuleParams</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> At-rule parameters, eg. '(min-width: 500px)' (optional, default <code>''</code>)</li></ul></li></ul> <h3 id="examples-3"><a href="#examples-3" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// Simple class-based rule</span>
<span class="token keyword">const</span> rule <span class="token operator">=</span> cc<span class="token punctuation">.</span><span class="token function">setRule</span><span class="token punctuation">(</span><span class="token string">'.class1.class2'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> color<span class="token operator">:</span> <span class="token string">'red'</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>rule<span class="token punctuation">.</span><span class="token function">toCSS</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token comment">// output: .class1.class2 { color: red }</span>
<span class="token comment">// With state and other mixed selector</span>
@ -83,7 +82,7 @@ console<span class="token punctuation">.</span><span class="token function">log<
<span class="token keyword">const</span> id <span class="token operator">=</span> someComponent<span class="token punctuation">.</span><span class="token function">getId</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token keyword">const</span> rules <span class="token operator">=</span> cc<span class="token punctuation">.</span><span class="token function">getRules</span><span class="token punctuation">(</span><span class="token template-string"><span class="token template-punctuation string">`</span><span class="token string">#</span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>id<span class="token interpolation-punctuation punctuation">}</span></span><span class="token template-punctuation string">`</span></span><span class="token punctuation">)</span><span class="token punctuation">;</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>rules<span class="token punctuation">.</span><span class="token function">map</span><span class="token punctuation">(</span><span class="token parameter">rule</span> <span class="token operator">=&gt;</span> rule<span class="token punctuation">.</span><span class="token function">toCSS</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>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" target="_blank" rel="noopener noreferrer">Array<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>&lt;CssRule&gt;</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/css_composer.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">4/20/2021, 11:36:21 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" target="_blank" rel="noopener noreferrer">Array<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>&lt;CssRule&gt;</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/css_composer.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/selector_manager.html" class="prev">
Selector Manager
@ -92,6 +91,6 @@ console<span class="token punctuation">.</span><span class="token function">log<
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/28.cc45d02f.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/28.f3e302a2.js" defer></script>
</body>
</html>

14
docs/api/device_manager.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/29.4c939d39.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/29.0534d4fc.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" aria-current="page" class="active sidebar-link">Device Manager</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#devicemanager" class="sidebar-link">DeviceManager</a></li><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#getall" class="sidebar-link">getAll</a></li></ul></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="devicemanager"><a href="#devicemanager" class="header-anchor">#</a> DeviceManager</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/device_manager/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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><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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" aria-current="page" class="active sidebar-link">Device Manager</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#devicemanager" class="sidebar-link">DeviceManager</a></li><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/device_manager.html#getall" class="sidebar-link">getAll</a></li></ul></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="devicemanager"><a href="#devicemanager" class="header-anchor">#</a> DeviceManager</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/device_manager/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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>
deviceManager<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// options</span>
<span class="token punctuation">}</span>
@ -54,7 +54,7 @@ console<span class="token punctuation">.</span><span class="token function">log<
</code></pre></div><h2 id="getall"><a href="#getall" class="header-anchor">#</a> getAll</h2> <p>Return all devices</p> <h3 id="examples-3"><a href="#examples-3" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">var</span> devices <span class="token operator">=</span> deviceManager<span class="token punctuation">.</span><span class="token function">getAll</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span>devices<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// [{name: 'Desktop', width: ''}, ...]</span>
</code></pre></div><p>Returns <strong>Collection</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/device_manager.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/4/2019, 12:14:53 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong>Collection</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/device_manager.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/storage_manager.html" class="prev">
Storage Manager
@ -63,6 +63,6 @@ console<span class="token punctuation">.</span><span class="token function">log<
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/29.4c939d39.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/29.0534d4fc.js" defer></script>
</body>
</html>

69
docs/api/editor.html
View File

File diff suppressed because one or more lines are too long

20
docs/api/i18n.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/31.5b8e0e55.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/31.58e6a8d0.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" aria-current="page" class="active sidebar-link">I18n</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#i18n" class="sidebar-link">I18n</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#getconfig" class="sidebar-link">getConfig</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#setlocale" class="sidebar-link">setLocale</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#getlocale" class="sidebar-link">getLocale</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#getmessages" class="sidebar-link">getMessages</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#setmessages" class="sidebar-link">setMessages</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#addmessages" class="sidebar-link">addMessages</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#t" class="sidebar-link">t</a></li></ul></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="i18n"><a href="#i18n" class="header-anchor">#</a> I18n</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/i18n/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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><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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" aria-current="page" class="active sidebar-link">I18n</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#i18n" class="sidebar-link">I18n</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#getconfig" class="sidebar-link">getConfig</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#setlocale" class="sidebar-link">setLocale</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#getlocale" class="sidebar-link">getLocale</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#getmessages" class="sidebar-link">getMessages</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#setmessages" class="sidebar-link">setMessages</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#addmessages" class="sidebar-link">addMessages</a></li><li class="sidebar-sub-header"><a href="/docs/api/i18n.html#t" class="sidebar-link">t</a></li></ul></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="i18n"><a href="#i18n" class="header-anchor">#</a> I18n</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/i18n/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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>
i18n<span class="token operator">:</span> <span class="token punctuation">{</span>
locale<span class="token operator">:</span> <span class="token string">'en'</span><span class="token punctuation">,</span>
localeFallback<span class="token operator">:</span> <span class="token string">'en'</span><span class="token punctuation">,</span>
@ -46,8 +46,7 @@
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre></div><p>Once the editor is instantiated you can use its API. Before using these methods you should get the module from the instance</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</span> i18n <span class="token operator">=</span> editor<span class="token punctuation">.</span>I18n<span class="token punctuation">;</span>
</code></pre></div><h3 id="events"><a href="#events" class="header-anchor">#</a> Events</h3> <ul><li><code>i18n:add</code> - New set of messages is added</li> <li><code>i18n:update</code> - The set of messages is updated</li> <li><code>i18n:locale</code> - Locale changed</li></ul> <h2 id="getconfig"><a href="#getconfig" class="header-anchor">#</a> getConfig</h2> <p>Get module configurations</p> <p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Configuration object</p> <h2 id="setlocale"><a href="#setlocale" class="header-anchor">#</a> setLocale</h2> <p>Update current locale</p> <h3 id="parameters"><a href="#parameters" class="header-anchor">#</a> Parameters</h3> <ul><li><code>locale</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> Locale value</li></ul> <h3 id="examples"><a href="#examples" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>i18n<span class="token punctuation">.</span><span class="token function">setLocale</span><span class="token punctuation">(</span><span class="token string">'it'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>this</strong></p> <h2 id="getlocale"><a href="#getlocale" class="header-anchor">#</a> getLocale</h2> <p>Get current locale</p> <p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> Current locale value</p> <h2 id="getmessages"><a href="#getmessages" class="header-anchor">#</a> getMessages</h2> <p>Get all messages</p> <h3 id="parameters-2"><a href="#parameters-2" class="header-anchor">#</a> Parameters</h3> <ul><li><code>lang</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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>?</strong> Specify the language of messages to return</li> <li><code>opts</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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>?</strong> Options (optional, default <code>{}</code>)
<ul><li><code>opts.debug</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank" rel="noopener noreferrer">Boolean<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>?</strong> Show warnings in case of missing language</li></ul></li></ul> <h3 id="examples-2"><a href="#examples-2" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>i18n<span class="token punctuation">.</span><span class="token function">getMessages</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>this</strong></p> <h2 id="getlocale"><a href="#getlocale" class="header-anchor">#</a> getLocale</h2> <p>Get current locale</p> <p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> Current locale value</p> <h2 id="getmessages"><a href="#getmessages" class="header-anchor">#</a> getMessages</h2> <p>Get all messages</p> <h3 id="parameters-2"><a href="#parameters-2" class="header-anchor">#</a> Parameters</h3> <ul><li><p><code>lang</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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>?</strong> Specify the language of messages to return</p></li> <li><p><code>opts</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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>?</strong> Options (optional, default <code>{}</code>)</p> <ul><li><code>opts.debug</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank" rel="noopener noreferrer">Boolean<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>?</strong> Show warnings in case of missing language</li></ul></li></ul> <h3 id="examples-2"><a href="#examples-2" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>i18n<span class="token punctuation">.</span><span class="token function">getMessages</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// -&gt; { en: { hello: '...' }, ... }</span>
i18n<span class="token punctuation">.</span><span class="token function">getMessages</span><span class="token punctuation">(</span><span class="token string">'en'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// -&gt; { hello: '...' }</span>
@ -63,8 +62,7 @@ i18n<span class="token punctuation">.</span><span class="token function">addMess
<span class="token comment">// Set updated</span>
i18n<span class="token punctuation">.</span><span class="token function">getMessages</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// -&gt; { en: { msg1: 'Msg 1', msg2: 'Msg 2 up', msg3: 'Msg 3', } }</span>
</code></pre></div><p>Returns <strong>this</strong></p> <h2 id="t"><a href="#t" class="header-anchor">#</a> t</h2> <p>Translate the locale message</p> <h3 id="parameters-5"><a href="#parameters-5" class="header-anchor">#</a> Parameters</h3> <ul><li><code>key</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> Label to translate</li> <li><code>opts</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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>?</strong> Options for the translation (optional, default <code>{}</code>)
<ul><li><code>opts.params</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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>?</strong> Params for the translation</li> <li><code>opts.debug</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank" rel="noopener noreferrer">Boolean<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>?</strong> Show warnings in case of missing resources</li></ul></li></ul> <h3 id="examples-5"><a href="#examples-5" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>obj<span class="token punctuation">.</span><span class="token function">setMessages</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
</code></pre></div><p>Returns <strong>this</strong></p> <h2 id="t"><a href="#t" class="header-anchor">#</a> t</h2> <p>Translate the locale message</p> <h3 id="parameters-5"><a href="#parameters-5" class="header-anchor">#</a> Parameters</h3> <ul><li><p><code>key</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong> Label to translate</p></li> <li><p><code>opts</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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>?</strong> Options for the translation (optional, default <code>{}</code>)</p> <ul><li><code>opts.params</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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>?</strong> Params for the translation</li> <li><code>opts.debug</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank" rel="noopener noreferrer">Boolean<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>?</strong> Show warnings in case of missing resources</li></ul></li></ul> <h3 id="examples-5"><a href="#examples-5" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>obj<span class="token punctuation">.</span><span class="token function">setMessages</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
en<span class="token operator">:</span> <span class="token punctuation">{</span> msg<span class="token operator">:</span> <span class="token string">'Msg'</span><span class="token punctuation">,</span> msg2<span class="token operator">:</span> <span class="token string">'Msg {test}'</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
it<span class="token operator">:</span> <span class="token punctuation">{</span> msg2<span class="token operator">:</span> <span class="token string">'Msg {test} it'</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>
@ -74,7 +72,7 @@ obj<span class="token punctuation">.</span><span class="token function">t</span>
<span class="token comment">// -&gt; outputs `Msg hello`</span>
obj<span class="token punctuation">.</span><span class="token function">t</span><span class="token punctuation">(</span><span class="token string">'msg2'</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> l<span class="token operator">:</span> <span class="token string">'it'</span><span class="token punctuation">,</span> params<span class="token operator">:</span> <span class="token punctuation">{</span> test<span class="token operator">:</span> <span class="token string">'hello'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// custom local</span>
<span class="token comment">// -&gt; outputs `Msg hello it`</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/i18n.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/6/2019, 10:01:26 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">String<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></strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/i18n.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/editor.html" class="prev">
Editor
@ -83,6 +81,6 @@ obj<span class="token punctuation">.</span><span class="token function">t</span>
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/31.5b8e0e55.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/31.58e6a8d0.js" defer></script>
</body>
</html>

12
docs/api/index.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>API Reference | GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/21.5fbfcbfa.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/21.80a868df.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container page__apis"><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">
@ -34,11 +34,11 @@
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/api/" aria-current="page" class="active sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="api-reference"><a href="#api-reference" class="header-anchor">#</a> API Reference</h1> <p>Here you can find the documentation about GrapesJS' APIs. Mainly, you would use them for your editor to extend the basic functionality of the framework or you could also <a href="/docs/modules/Plugins.html">create a plugin</a> and make those extensions reusable and available to others.</p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/README.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">7/9/2018, 1:03:59 AM</span></div></footer> <div class="page-nav"><p class="inner"><!----> <span class="next"><a href="/docs/api/editor.html">
<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/api/" aria-current="page" class="active sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="api-reference"><a href="#api-reference" class="header-anchor">#</a> API Reference</h1> <p>Here you can find the documentation about GrapesJS' APIs. Mainly, you would use them for your editor to extend the basic functionality of the framework or you could also <a href="/docs/modules/Plugins.html">create a plugin</a> and make those extensions reusable and available to others.</p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/README.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">7/9/2018, 1:03:59 AM</span></div></footer> <div class="page-nav"><p class="inner"><!----> <span class="next"><a href="/docs/api/editor.html">
Editor
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/21.5fbfcbfa.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/21.80a868df.js" defer></script>
</body>
</html>

14
docs/api/keymaps.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/32.120a63a8.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/32.9ea68a19.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" aria-current="page" class="active sidebar-link">Keymaps</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#keymaps" class="sidebar-link">Keymaps</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#getconfig" class="sidebar-link">getConfig</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#removeall" class="sidebar-link">removeAll</a></li></ul></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="keymaps"><a href="#keymaps" class="header-anchor">#</a> Keymaps</h2> <p>You can customize the initial state of the module from the editor initialization</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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><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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" aria-current="page" class="active sidebar-link">Keymaps</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#keymaps" class="sidebar-link">Keymaps</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#getconfig" class="sidebar-link">getConfig</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/keymaps.html#removeall" class="sidebar-link">removeAll</a></li></ul></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="keymaps"><a href="#keymaps" class="header-anchor">#</a> Keymaps</h2> <p>You can customize the initial state of the module from the editor initialization</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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>
keymaps<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// Object of keymaps</span>
defaults<span class="token operator">:</span> <span class="token punctuation">{</span>
@ -65,7 +65,7 @@ or just a command id as a string</p> <h2 id="get"><a href="#get" class="header-a
<span class="token comment">// -&gt; {id1: {}, id2: {}};</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong></p> <h2 id="remove"><a href="#remove" class="header-anchor">#</a> remove</h2> <p>Remove the keymap by id</p> <h3 id="parameters-3"><a href="#parameters-3" class="header-anchor">#</a> Parameters</h3> <ul><li><code>id</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">string<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></strong> Keymap id</li></ul> <h3 id="examples-4"><a href="#examples-4" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>keymaps<span class="token punctuation">.</span><span class="token function">remove</span><span class="token punctuation">(</span><span class="token string">'ns:my-keymap'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// -&gt; {keys, handler};</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Removed keymap</p> <h2 id="removeall"><a href="#removeall" class="header-anchor">#</a> removeAll</h2> <p>Remove all binded keymaps</p> <p>Returns <strong>this</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/keymaps.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">3/11/2019, 6:17:19 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Removed keymap</p> <h2 id="removeall"><a href="#removeall" class="header-anchor">#</a> removeAll</h2> <p>Remove all binded keymaps</p> <p>Returns <strong>this</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/keymaps.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/rich_text_editor.html" class="prev">
Rich Text Editor
@ -74,6 +74,6 @@ or just a command id as a string</p> <h2 id="get"><a href="#get" class="header-a
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/32.120a63a8.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/32.9ea68a19.js" defer></script>
</body>
</html>

17
docs/api/modal_dialog.html
View File

File diff suppressed because one or more lines are too long

52
docs/api/page.html
View File

@ -0,0 +1,52 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/34.5195e151.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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 router-link-active">
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 router-link-active">
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" aria-current="page" class="active sidebar-link"> ‍ ‍ ‍ Page</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/page.html#getallframes" class="sidebar-link">getAllFrames</a></li><li class="sidebar-sub-header"><a href="/docs/api/page.html#getmainframe" class="sidebar-link">getMainFrame</a></li><li class="sidebar-sub-header"><a href="/docs/api/page.html#getmaincomponent" class="sidebar-link">getMainComponent</a></li></ul></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="getallframes"><a href="#getallframes" class="header-anchor">#</a> getAllFrames</h2> <p>Get all frames</p> <h3 id="examples"><a href="#examples" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> arrayOfFrames <span class="token operator">=</span> page<span class="token punctuation">.</span><span class="token function">getAllFrames</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" target="_blank" rel="noopener noreferrer">Array<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>&lt;Frame&gt;</strong></p> <h2 id="getmainframe"><a href="#getmainframe" class="header-anchor">#</a> getMainFrame</h2> <p>Get the first frame of the page (identified always as the main one)</p> <h3 id="examples-2"><a href="#examples-2" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> mainFrame <span class="token operator">=</span> page<span class="token punctuation">.</span><span class="token function">getMainFrame</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>Frame</strong></p> <h2 id="getmaincomponent"><a href="#getmaincomponent" class="header-anchor">#</a> getMainComponent</h2> <p>Get the root component (usually is the <code>wrapper</code> component) from the main frame</p> <h3 id="examples-3"><a href="#examples-3" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> rootComponent <span class="token operator">=</span> page<span class="token punctuation">.</span><span class="token function">getMainComponent</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>rootComponent<span class="token punctuation">.</span><span class="token function">toHTML</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>Returns <strong>Component</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/page.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">7/21/2021, 12:49:29 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/pages.html" class="prev">
Pages
</a></span> <span class="next"><a href="/docs/api/style_manager.html">
Style Manager
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/34.5195e151.js" defer></script>
</body>
</html>

18
docs/api/pages.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/34.991371c4.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/35.ee386620.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" aria-current="page" class="active sidebar-link">Pages</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/pages.html#pages" class="sidebar-link">Pages</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#available-events" class="sidebar-link">Available Events</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#methods" class="sidebar-link">Methods</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#getmain" class="sidebar-link">getMain</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#select" class="sidebar-link">select</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#getselected" class="sidebar-link">getSelected</a></li></ul></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="pages"><a href="#pages" class="header-anchor">#</a> Pages</h2> <p>You can customize the initial state of the module from the editor initialization</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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><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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" aria-current="page" class="active sidebar-link">Pages</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/pages.html#pages" class="sidebar-link">Pages</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#available-events" class="sidebar-link">Available Events</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#methods" class="sidebar-link">Methods</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#getmain" class="sidebar-link">getMain</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#select" class="sidebar-link">select</a></li><li class="sidebar-sub-header"><a href="/docs/api/pages.html#getselected" class="sidebar-link">getSelected</a></li></ul></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="pages"><a href="#pages" class="header-anchor">#</a> Pages</h2> <p>You can customize the initial state of the module from the editor initialization</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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 operator">...</span><span class="token punctuation">.</span>
pageManager<span class="token operator">:</span> <span class="token punctuation">{</span>
pages<span class="token operator">:</span> <span class="token punctuation">[</span>
@ -64,15 +64,15 @@ pageManager<span class="token punctuation">.</span><span class="token function">
<span class="token keyword">const</span> somePage <span class="token operator">=</span> pageManager<span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token string">'page-id'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
pageManager<span class="token punctuation">.</span><span class="token function">select</span><span class="token punctuation">(</span>somePage<span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>this</strong></p> <h2 id="getselected"><a href="#getselected" class="header-anchor">#</a> getSelected</h2> <p>Get the selected page</p> <h3 id="examples-7"><a href="#examples-7" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> selectedPage <span class="token operator">=</span> pageManager<span class="token punctuation">.</span><span class="token function">getSelected</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>Page</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/pages.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">4/21/2021, 8:08:58 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong>Page</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/pages.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/panels.html" class="prev">
Panels
</a></span> <span class="next"><a href="/docs/api/style_manager.html">
Style Manager
</a></span> <span class="next"><a href="/docs/api/page.html">
‍ ‍ ‍ Page
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/34.991371c4.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/35.ee386620.js" defer></script>
</body>
</html>

16
docs/api/panels.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/35.62067c34.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/36.3c04f1d9.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" aria-current="page" class="active sidebar-link">Panels</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/panels.html#panels" class="sidebar-link">Panels</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getpanels" class="sidebar-link">getPanels</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getpanelsel" class="sidebar-link">getPanelsEl</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#addpanel" class="sidebar-link">addPanel</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#removepanel" class="sidebar-link">removePanel</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getpanel" class="sidebar-link">getPanel</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#addbutton" class="sidebar-link">addButton</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#removebutton" class="sidebar-link">removeButton</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getbutton" class="sidebar-link">getButton</a></li></ul></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="panels"><a href="#panels" class="header-anchor">#</a> Panels</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/panels/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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><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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" aria-current="page" class="active sidebar-link">Panels</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/panels.html#panels" class="sidebar-link">Panels</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getpanels" class="sidebar-link">getPanels</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getpanelsel" class="sidebar-link">getPanelsEl</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#addpanel" class="sidebar-link">addPanel</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#removepanel" class="sidebar-link">removePanel</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getpanel" class="sidebar-link">getPanel</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#addbutton" class="sidebar-link">addButton</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#removebutton" class="sidebar-link">removeButton</a></li><li class="sidebar-sub-header"><a href="/docs/api/panels.html#getbutton" class="sidebar-link">getButton</a></li></ul></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="panels"><a href="#panels" class="header-anchor">#</a> Panels</h2> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/panels/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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>
panels<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// options</span>
<span class="token punctuation">}</span>
@ -86,15 +86,15 @@ command<span class="token operator">:</span> <span class="token punctuation">{</
<span class="token keyword">const</span> removedButton <span class="token operator">=</span> panelManager<span class="token punctuation">.</span><span class="token function">removeButton</span><span class="token punctuation">(</span><span class="token string">'myNewPanel'</span><span class="token punctuation">,</span> <span class="token string">'myNewButton'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>(Button | null)</strong> Removed button.</p> <h2 id="getbutton"><a href="#getbutton" class="header-anchor">#</a> getButton</h2> <p>Get button from the panel</p> <h3 id="parameters-6"><a href="#parameters-6" class="header-anchor">#</a> Parameters</h3> <ul><li><code>panelId</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">string<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></strong> Panel's ID</li> <li><code>id</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">string<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></strong> Button's ID</li></ul> <h3 id="examples-6"><a href="#examples-6" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">var</span> button <span class="token operator">=</span> panelManager<span class="token punctuation">.</span><span class="token function">getButton</span><span class="token punctuation">(</span><span class="token string">'myPanel'</span><span class="token punctuation">,</span><span class="token string">'myButton'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>(Button | null)</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/panels.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/22/2018, 7:37:29 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong>(Button | null)</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/panels.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/component.html" class="prev">
- Component
‍ ‍ ‍ Component
</a></span> <span class="next"><a href="/docs/api/pages.html">
Pages
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/35.62067c34.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/36.3c04f1d9.js" defer></script>
</body>
</html>

14
docs/api/rich_text_editor.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/36.2b20b664.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/40.615e6955.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/37.29e16f9c.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/41.3352d1b5.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" aria-current="page" class="active sidebar-link">Rich Text Editor</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#richtexteditor" class="sidebar-link">RichTextEditor</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#gettoolbarel" class="sidebar-link">getToolbarEl</a></li></ul></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="richtexteditor"><a href="#richtexteditor" class="header-anchor">#</a> RichTextEditor</h2> <p>This module allows to customize the built-in toolbar of the Rich Text Editor and use commands from the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/execCommand" target="_blank" rel="noopener noreferrer">HTML Editing APIs<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>.
<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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" aria-current="page" class="active sidebar-link">Rich Text Editor</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#richtexteditor" class="sidebar-link">RichTextEditor</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#get" class="sidebar-link">get</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#getall" class="sidebar-link">getAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/rich_text_editor.html#gettoolbarel" class="sidebar-link">getToolbarEl</a></li></ul></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" class="sidebar-link">Undo Manager</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="richtexteditor"><a href="#richtexteditor" class="header-anchor">#</a> RichTextEditor</h2> <p>This module allows to customize the built-in toolbar of the Rich Text Editor and use commands from the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Document/execCommand" target="_blank" rel="noopener noreferrer">HTML Editing APIs<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>.
It's highly recommended to keep this toolbar as small as possible, especially from styling commands (eg. 'fontSize') and leave this task to the Style Manager</p> <p>You can customize the initial state of the module from the editor initialization, by passing the following <a href="https://github.com/artf/grapesjs/blob/master/src/rich_text_editor/config/config.js" target="_blank" rel="noopener noreferrer">Configuration Object<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></p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</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>
richTextEditor<span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token comment">// options</span>
@ -100,7 +100,7 @@ rte<span class="token punctuation">.</span><span class="token function">add</spa
<span class="token comment">// {name: 'bold', ...}</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong></p> <h2 id="getall"><a href="#getall" class="header-anchor">#</a> getAll</h2> <p>Get all actions</p> <p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" target="_blank" rel="noopener noreferrer">Array<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></strong></p> <h2 id="remove"><a href="#remove" class="header-anchor">#</a> remove</h2> <p>Remove the action from the toolbar</p> <h3 id="parameters-3"><a href="#parameters-3" class="header-anchor">#</a> Parameters</h3> <ul><li><code>name</code> <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank" rel="noopener noreferrer">string<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></strong></li></ul> <h3 id="examples-3"><a href="#examples-3" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> action <span class="token operator">=</span> rte<span class="token punctuation">.</span><span class="token function">remove</span><span class="token punctuation">(</span><span class="token string">'bold'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// {name: 'bold', ...}</span>
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Removed action</p> <h2 id="gettoolbarel"><a href="#gettoolbarel" class="header-anchor">#</a> getToolbarEl</h2> <p>Get the toolbar element</p> <p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/HTML/Element" target="_blank" rel="noopener noreferrer">HTMLElement<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></strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/rich_text_editor.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">4/23/2020, 1:46:38 AM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank" rel="noopener noreferrer">Object<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></strong> Removed action</p> <h2 id="gettoolbarel"><a href="#gettoolbarel" class="header-anchor">#</a> getToolbarEl</h2> <p>Get the toolbar element</p> <p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/HTML/Element" target="_blank" rel="noopener noreferrer">HTMLElement<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></strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/rich_text_editor.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/modal_dialog.html" class="prev">
Modal
@ -109,6 +109,6 @@ rte<span class="token punctuation">.</span><span class="token function">add</spa
</a>
→
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/36.2b20b664.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/37.29e16f9c.js" defer></script>
</body>
</html>

17
docs/api/selector_manager.html
View File

File diff suppressed because one or more lines are too long

17
docs/api/storage_manager.html
View File

File diff suppressed because one or more lines are too long

27
docs/api/style_manager.html
View File

File diff suppressed because one or more lines are too long

14
docs/api/undo_manager.html
View File

@ -4,14 +4,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GrapesJS</title>
<meta name="generator" content="VuePress 1.7.1">
<meta name="generator" content="VuePress 1.8.2">
<link rel="icon" href="/docs/logo-icon.png">
<link rel="stylesheet" href="../stylesheets/grapes.min.css?v0.17.22">
<script src="../js/grapes.min.js?v0.17.22"></script>
<meta name="description" content="GrapesJS documentation">
<link rel="preload" href="/docs/assets/css/0.styles.ac93482a.css" as="style"><link rel="preload" href="/docs/assets/js/app.b919db98.js" as="script"><link rel="preload" href="/docs/assets/js/11.00909638.js" as="script"><link rel="preload" href="/docs/assets/js/2.76987c6d.js" as="script"><link rel="preload" href="/docs/assets/js/40.615e6955.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.66bafe27.js"><link rel="prefetch" href="/docs/assets/js/12.8abc0790.js"><link rel="prefetch" href="/docs/assets/js/13.a938815d.js"><link rel="prefetch" href="/docs/assets/js/14.f6679dbc.js"><link rel="prefetch" href="/docs/assets/js/15.e1f63ebd.js"><link rel="prefetch" href="/docs/assets/js/16.50cb9f03.js"><link rel="prefetch" href="/docs/assets/js/17.1b60a777.js"><link rel="prefetch" href="/docs/assets/js/18.b7385ed2.js"><link rel="prefetch" href="/docs/assets/js/19.46b34bc8.js"><link rel="prefetch" href="/docs/assets/js/20.f6e656e9.js"><link rel="prefetch" href="/docs/assets/js/21.5fbfcbfa.js"><link rel="prefetch" href="/docs/assets/js/22.c9db409a.js"><link rel="prefetch" href="/docs/assets/js/23.eea06144.js"><link rel="prefetch" href="/docs/assets/js/24.a568d17b.js"><link rel="prefetch" href="/docs/assets/js/25.9769e6e3.js"><link rel="prefetch" href="/docs/assets/js/26.284071ba.js"><link rel="prefetch" href="/docs/assets/js/27.4266ca40.js"><link rel="prefetch" href="/docs/assets/js/28.cc45d02f.js"><link rel="prefetch" href="/docs/assets/js/29.4c939d39.js"><link rel="prefetch" href="/docs/assets/js/3.ae005b76.js"><link rel="prefetch" href="/docs/assets/js/30.2f7bb3ab.js"><link rel="prefetch" href="/docs/assets/js/31.5b8e0e55.js"><link rel="prefetch" href="/docs/assets/js/32.120a63a8.js"><link rel="prefetch" href="/docs/assets/js/33.4a67243d.js"><link rel="prefetch" href="/docs/assets/js/34.991371c4.js"><link rel="prefetch" href="/docs/assets/js/35.62067c34.js"><link rel="prefetch" href="/docs/assets/js/36.2b20b664.js"><link rel="prefetch" href="/docs/assets/js/37.9c426a13.js"><link rel="prefetch" href="/docs/assets/js/38.b708d72a.js"><link rel="prefetch" href="/docs/assets/js/39.b704c28a.js"><link rel="prefetch" href="/docs/assets/js/4.20f46c0c.js"><link rel="prefetch" href="/docs/assets/js/41.27038fe0.js"><link rel="prefetch" href="/docs/assets/js/42.5d0fecb4.js"><link rel="prefetch" href="/docs/assets/js/43.f83108fe.js"><link rel="prefetch" href="/docs/assets/js/44.10a1c9ff.js"><link rel="prefetch" href="/docs/assets/js/45.54999ce9.js"><link rel="prefetch" href="/docs/assets/js/46.d0dbaadb.js"><link rel="prefetch" href="/docs/assets/js/47.2ce8943d.js"><link rel="prefetch" href="/docs/assets/js/48.a7241afb.js"><link rel="prefetch" href="/docs/assets/js/49.95672b90.js"><link rel="prefetch" href="/docs/assets/js/5.5d310613.js"><link rel="prefetch" href="/docs/assets/js/50.bddbb88f.js"><link rel="prefetch" href="/docs/assets/js/51.02d3928a.js"><link rel="prefetch" href="/docs/assets/js/52.c9e3636a.js"><link rel="prefetch" href="/docs/assets/js/53.144b5e27.js"><link rel="prefetch" href="/docs/assets/js/54.e7d62a93.js"><link rel="prefetch" href="/docs/assets/js/6.08f4bcf8.js"><link rel="prefetch" href="/docs/assets/js/7.d040063a.js"><link rel="prefetch" href="/docs/assets/js/8.7a2feb85.js"><link rel="prefetch" href="/docs/assets/js/9.d8edaab6.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.ac93482a.css">
<link rel="preload" href="/docs/assets/css/0.styles.1858edcc.css" as="style"><link rel="preload" href="/docs/assets/js/app.36495a81.js" as="script"><link rel="preload" href="/docs/assets/js/11.e4a5286f.js" as="script"><link rel="preload" href="/docs/assets/js/2.15028157.js" as="script"><link rel="preload" href="/docs/assets/js/41.3352d1b5.js" as="script"><link rel="prefetch" href="/docs/assets/js/10.bc8d26ba.js"><link rel="prefetch" href="/docs/assets/js/12.05f31234.js"><link rel="prefetch" href="/docs/assets/js/13.8130e741.js"><link rel="prefetch" href="/docs/assets/js/14.21fd784c.js"><link rel="prefetch" href="/docs/assets/js/15.8026aa70.js"><link rel="prefetch" href="/docs/assets/js/16.5365d48a.js"><link rel="prefetch" href="/docs/assets/js/17.16a899b7.js"><link rel="prefetch" href="/docs/assets/js/18.2b682096.js"><link rel="prefetch" href="/docs/assets/js/19.c8bf26af.js"><link rel="prefetch" href="/docs/assets/js/20.7ee8a470.js"><link rel="prefetch" href="/docs/assets/js/21.80a868df.js"><link rel="prefetch" href="/docs/assets/js/22.b1817aaa.js"><link rel="prefetch" href="/docs/assets/js/23.24b1a9f0.js"><link rel="prefetch" href="/docs/assets/js/24.0b14d393.js"><link rel="prefetch" href="/docs/assets/js/25.a736d8ee.js"><link rel="prefetch" href="/docs/assets/js/26.5a4f24ff.js"><link rel="prefetch" href="/docs/assets/js/27.f3b530ab.js"><link rel="prefetch" href="/docs/assets/js/28.f3e302a2.js"><link rel="prefetch" href="/docs/assets/js/29.0534d4fc.js"><link rel="prefetch" href="/docs/assets/js/3.9c33fa00.js"><link rel="prefetch" href="/docs/assets/js/30.91585127.js"><link rel="prefetch" href="/docs/assets/js/31.58e6a8d0.js"><link rel="prefetch" href="/docs/assets/js/32.9ea68a19.js"><link rel="prefetch" href="/docs/assets/js/33.83a74dc0.js"><link rel="prefetch" href="/docs/assets/js/34.5195e151.js"><link rel="prefetch" href="/docs/assets/js/35.ee386620.js"><link rel="prefetch" href="/docs/assets/js/36.3c04f1d9.js"><link rel="prefetch" href="/docs/assets/js/37.29e16f9c.js"><link rel="prefetch" href="/docs/assets/js/38.5d32b029.js"><link rel="prefetch" href="/docs/assets/js/39.9a58de40.js"><link rel="prefetch" href="/docs/assets/js/4.f31d6c5b.js"><link rel="prefetch" href="/docs/assets/js/40.8e6d589e.js"><link rel="prefetch" href="/docs/assets/js/42.57cce0c6.js"><link rel="prefetch" href="/docs/assets/js/43.a4256f15.js"><link rel="prefetch" href="/docs/assets/js/44.c05e59f9.js"><link rel="prefetch" href="/docs/assets/js/45.3e7d2ba2.js"><link rel="prefetch" href="/docs/assets/js/46.c362554c.js"><link rel="prefetch" href="/docs/assets/js/47.a5e549f1.js"><link rel="prefetch" href="/docs/assets/js/48.2e375343.js"><link rel="prefetch" href="/docs/assets/js/49.88dd7cce.js"><link rel="prefetch" href="/docs/assets/js/5.a0dda975.js"><link rel="prefetch" href="/docs/assets/js/50.c459c2cb.js"><link rel="prefetch" href="/docs/assets/js/51.47c12f8d.js"><link rel="prefetch" href="/docs/assets/js/52.334fdb25.js"><link rel="prefetch" href="/docs/assets/js/53.ec424eac.js"><link rel="prefetch" href="/docs/assets/js/54.91803c3a.js"><link rel="prefetch" href="/docs/assets/js/55.266c6160.js"><link rel="prefetch" href="/docs/assets/js/6.f7435f21.js"><link rel="prefetch" href="/docs/assets/js/7.cf6e89f4.js"><link rel="prefetch" href="/docs/assets/js/8.904f276f.js"><link rel="prefetch" href="/docs/assets/js/9.acf071b7.js">
<link rel="stylesheet" href="/docs/assets/css/0.styles.1858edcc.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">
@ -34,7 +34,7 @@
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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> - Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" aria-current="page" class="active sidebar-link">Undo Manager</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#undomanager" class="sidebar-link">UndoManager</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#getconfig" class="sidebar-link">getConfig</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#removeall" class="sidebar-link">removeAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#start" class="sidebar-link">start</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#stop" class="sidebar-link">stop</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#undo" class="sidebar-link">undo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#undoall" class="sidebar-link">undoAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#redo" class="sidebar-link">redo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#redoall" class="sidebar-link">redoAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#hasundo" class="sidebar-link">hasUndo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#hasredo" class="sidebar-link">hasRedo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#isregistered" class="sidebar-link">isRegistered</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#getstack" class="sidebar-link">getStack</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#getstackgroup" class="sidebar-link">getStackGroup</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#clear" class="sidebar-link">clear</a></li></ul></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="undomanager"><a href="#undomanager" class="header-anchor">#</a> UndoManager</h2> <p>This module allows to manage the stack of changes applied in canvas.
<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/api/" aria-current="page" class="sidebar-link">API Reference</a></li><li><a href="/docs/api/editor.html" class="sidebar-link">Editor</a></li><li><a href="/docs/api/i18n.html" class="sidebar-link">I18n</a></li><li><a href="/docs/api/canvas.html" class="sidebar-link">Canvas</a></li><li><a href="/docs/api/assets.html" class="sidebar-link">Asset Manager</a></li><li><a href="/docs/api/block_manager.html" class="sidebar-link">Block Manager</a></li><li><a href="/docs/api/commands.html" class="sidebar-link">Commands</a></li><li><a href="/docs/api/components.html" class="sidebar-link">DOM Components</a></li><li><a href="/docs/api/component.html" class="sidebar-link"> ‍ ‍ ‍ Component</a></li><li><a href="/docs/api/panels.html" class="sidebar-link">Panels</a></li><li><a href="/docs/api/pages.html" class="sidebar-link">Pages</a></li><li><a href="/docs/api/page.html" class="sidebar-link"> ‍ ‍ ‍ Page</a></li><li><a href="/docs/api/style_manager.html" class="sidebar-link">Style Manager</a></li><li><a href="/docs/api/storage_manager.html" class="sidebar-link">Storage Manager</a></li><li><a href="/docs/api/device_manager.html" class="sidebar-link">Device Manager</a></li><li><a href="/docs/api/selector_manager.html" class="sidebar-link">Selector Manager</a></li><li><a href="/docs/api/css_composer.html" class="sidebar-link">CSS Composer</a></li><li><a href="/docs/api/modal_dialog.html" class="sidebar-link">Modal</a></li><li><a href="/docs/api/rich_text_editor.html" class="sidebar-link">Rich Text Editor</a></li><li><a href="/docs/api/keymaps.html" class="sidebar-link">Keymaps</a></li><li><a href="/docs/api/undo_manager.html" aria-current="page" class="active sidebar-link">Undo Manager</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#undomanager" class="sidebar-link">UndoManager</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#getconfig" class="sidebar-link">getConfig</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#add" class="sidebar-link">add</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#remove" class="sidebar-link">remove</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#removeall" class="sidebar-link">removeAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#start" class="sidebar-link">start</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#stop" class="sidebar-link">stop</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#undo" class="sidebar-link">undo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#undoall" class="sidebar-link">undoAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#redo" class="sidebar-link">redo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#redoall" class="sidebar-link">redoAll</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#hasundo" class="sidebar-link">hasUndo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#hasredo" class="sidebar-link">hasRedo</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#isregistered" class="sidebar-link">isRegistered</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#getstack" class="sidebar-link">getStack</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#getstackgroup" class="sidebar-link">getStackGroup</a></li><li class="sidebar-sub-header"><a href="/docs/api/undo_manager.html#clear" class="sidebar-link">clear</a></li></ul></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="undomanager"><a href="#undomanager" class="header-anchor">#</a> UndoManager</h2> <p>This module allows to manage the stack of changes applied in canvas.
Once the editor is instantiated you can use its API. Before using these methods you should get the module from the instance</p> <div class="language-js extra-class"><pre class="language-js"><code><span class="token keyword">const</span> um <span class="token operator">=</span> editor<span class="token punctuation">.</span>UndoManager<span class="token punctuation">;</span>
</code></pre></div><ul><li><a href="#getconfig">getConfig</a></li> <li><a href="#add">add</a></li> <li><a href="#remove">remove</a></li> <li><a href="#removeall">removeAll</a></li> <li><a href="#start">start</a></li> <li><a href="#stop">stop</a></li> <li><a href="#undo">undo</a></li> <li><a href="#undoall">undoAll</a></li> <li><a href="#redo">redo</a></li> <li><a href="#redoall">redoAll</a></li> <li><a href="#hasundo">hasUndo</a></li> <li><a href="#hasredo">hasRedo</a></li> <li><a href="#getstack">getStack</a></li> <li><a href="#clear">clear</a></li></ul> <h2 id="getconfig"><a href="#getconfig" class="header-anchor">#</a> getConfig</h2> <p>Get module configurations</p> <h3 id="examples"><a href="#examples" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> config <span class="token operator">=</span> um<span class="token punctuation">.</span><span class="token function">getConfig</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// { ... }</span>
@ -59,11 +59,11 @@ like appending multiple components:
<code>editor.getWrapper().append(</code></p><div>C1</div><div>C2</div><code>);</code> <code>getStack</code> will return a collection length of 2.
<code>getStackGroup</code> instead will group them as a single operation (the first
inserted component will be returned in the list) by returning an array length of 1.<p></p> <p>Returns <strong><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" target="_blank" rel="noopener noreferrer">Array<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></strong></p> <h2 id="clear"><a href="#clear" class="header-anchor">#</a> clear</h2> <p>Clear the stack</p> <h3 id="examples-14"><a href="#examples-14" class="header-anchor">#</a> Examples</h3> <div class="language-javascript extra-class"><pre class="language-javascript"><code>um<span class="token punctuation">.</span><span class="token function">clear</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><p>Returns <strong>this</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/undo_manager.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">4/20/2021, 11:36:21 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
</code></pre></div><p>Returns <strong>this</strong></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/artf/grapesjs/edit/dev/docs/api/undo_manager.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">6/18/2021, 7:20:54 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/docs/api/keymaps.html" class="prev">
Keymaps
</a></span> <!----></p></div> </main></div><div class="global-ui"></div></div>
<script src="/docs/assets/js/app.b919db98.js" defer></script><script src="/docs/assets/js/11.00909638.js" defer></script><script src="/docs/assets/js/2.76987c6d.js" defer></script><script src="/docs/assets/js/40.615e6955.js" defer></script>
<script src="/docs/assets/js/app.36495a81.js" defer></script><script src="/docs/assets/js/11.e4a5286f.js" defer></script><script src="/docs/assets/js/2.15028157.js" defer></script><script src="/docs/assets/js/41.3352d1b5.js" defer></script>
</body>
</html>

1
docs/assets/css/0.styles.1858edcc.css
View File

File diff suppressed because one or more lines are too long

1
docs/assets/css/0.styles.ac93482a.css
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/10.66bafe27.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/8.7a2feb85.js → docs/assets/js/10.bc8d26ba.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/11.00909638.js → docs/assets/js/11.e4a5286f.js
View File

@ -1 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[11,13],{381:function(t,n,e){},384:function(t,n,e){"use strict";e(381)},417:function(t,n,e){"use strict";e.r(n);var a={render:function(t){return t("div",{class:"carbon-ads",attrs:{id:"native-carbon"}})},mounted:function(){window.BSANativeCallback=function(t){if(!t.ads.length){var n=document.createElement("script");n.src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=grapesjscom",n.setAttribute("id","_carbonads_js");var e=document.getElementById("native-carbon");e&&e.appendChild(n)}},this.load()},watch:{$route:function(t,n){t.path!==n.path&&this.$el.querySelector("#carbonads")&&(this.$el.innerHTML="",this.load())}},methods:{initCarbon:function(){var t=window._bsa;void 0!==t&&t&&t.init("default","CK7I62QJ","placement:grapesjscomdocs",{target:"#native-carbon"})},load:function(){var t=this,n=document.createElement("script");n.src="//m.servedby-buysellads.com/monetization.js",n.onload=function(){return t.initCarbon()},this.$el.appendChild(n)}}},o=(e(384),e(52)),i=Object(o.a)(a,void 0,void 0,!1,null,null,null);n.default=i.exports},494:function(t,n,e){"use strict";e.r(n);var a=e(455),o=e(417),i={components:{Layout:a.a,CarbonAds:o.default}},r=e(52),s=Object(r.a)(i,(function(){var t=this.$createElement,n=this._self._c||t;return n("Layout",[n("CarbonAds",{attrs:{slot:"sidebar-top"},slot:"sidebar-top"})],1)}),[],!1,null,null,null);n.default=s.exports}}]);
(window.webpackJsonp=window.webpackJsonp||[]).push([[11,13],{310:function(t,n,e){},313:function(t,n,e){"use strict";e(310)},347:function(t,n,e){"use strict";e.r(n);var a={render:function(t){return t("div",{class:"carbon-ads",attrs:{id:"native-carbon"}})},mounted:function(){window.BSANativeCallback=function(t){if(!t.ads.length){var n=document.createElement("script");n.src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=grapesjscom",n.setAttribute("id","_carbonads_js");var e=document.getElementById("native-carbon");e&&e.appendChild(n)}},this.load()},watch:{$route:function(t,n){t.path!==n.path&&this.$el.querySelector("#carbonads")&&(this.$el.innerHTML="",this.load())}},methods:{initCarbon:function(){var t=window._bsa;void 0!==t&&t&&t.init("default","CK7I62QJ","placement:grapesjscomdocs",{target:"#native-carbon"})},load:function(){var t=this,n=document.createElement("script");n.src="//m.servedby-buysellads.com/monetization.js",n.onload=function(){return t.initCarbon()},this.$el.appendChild(n)}}},o=(e(313),e(44)),i=Object(o.a)(a,void 0,void 0,!1,null,null,null);n.default=i.exports},428:function(t,n,e){"use strict";e.r(n);var a=e(383),o=e(347),i={components:{Layout:a.a,CarbonAds:o.default}},r=e(44),s=Object(r.a)(i,(function(){var t=this.$createElement,n=this._self._c||t;return n("Layout",[n("CarbonAds",{attrs:{slot:"sidebar-top"},slot:"sidebar-top"})],1)}),[],!1,null,null,null);n.default=s.exports}}]);

1
docs/assets/js/12.05f31234.js
View File

@ -0,0 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{333:function(t,n,e){},371:function(t,n,e){"use strict";e(333)},435:function(t,n,e){"use strict";e.r(n);e(371);var s=e(44),i=Object(s.a)({},(function(){var t=this.$createElement;return(this._self._c||t)("div",{staticClass:"demo-container"},[this._t("default")],2)}),[],!1,null,"b3715568",null);n.default=i.exports}}]);

1
docs/assets/js/12.8abc0790.js
View File

@ -1 +0,0 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{403:function(t,n,e){},443:function(t,n,e){"use strict";e(403)},506:function(t,n,e){"use strict";e.r(n);e(443);var s=e(52),i=Object(s.a)({},(function(){var t=this.$createElement;return(this._self._c||t)("div",{staticClass:"demo-container"},[this._t("default")],2)}),[],!1,null,"b3715568",null);n.default=i.exports}}]);

2
docs/assets/js/13.a938815d.js → docs/assets/js/13.8130e741.js
View File

@ -1 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{381:function(n,t,e){},384:function(n,t,e){"use strict";e(381)},417:function(n,t,e){"use strict";e.r(t);var a={render:function(n){return n("div",{class:"carbon-ads",attrs:{id:"native-carbon"}})},mounted:function(){window.BSANativeCallback=function(n){if(!n.ads.length){var t=document.createElement("script");t.src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=grapesjscom",t.setAttribute("id","_carbonads_js");var e=document.getElementById("native-carbon");e&&e.appendChild(t)}},this.load()},watch:{$route:function(n,t){n.path!==t.path&&this.$el.querySelector("#carbonads")&&(this.$el.innerHTML="",this.load())}},methods:{initCarbon:function(){var n=window._bsa;void 0!==n&&n&&n.init("default","CK7I62QJ","placement:grapesjscomdocs",{target:"#native-carbon"})},load:function(){var n=this,t=document.createElement("script");t.src="//m.servedby-buysellads.com/monetization.js",t.onload=function(){return n.initCarbon()},this.$el.appendChild(t)}}},o=(e(384),e(52)),i=Object(o.a)(a,void 0,void 0,!1,null,null,null);t.default=i.exports}}]);
(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{310:function(n,t,e){},313:function(n,t,e){"use strict";e(310)},347:function(n,t,e){"use strict";e.r(t);var a={render:function(n){return n("div",{class:"carbon-ads",attrs:{id:"native-carbon"}})},mounted:function(){window.BSANativeCallback=function(n){if(!n.ads.length){var t=document.createElement("script");t.src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=grapesjscom",t.setAttribute("id","_carbonads_js");var e=document.getElementById("native-carbon");e&&e.appendChild(t)}},this.load()},watch:{$route:function(n,t){n.path!==t.path&&this.$el.querySelector("#carbonads")&&(this.$el.innerHTML="",this.load())}},methods:{initCarbon:function(){var n=window._bsa;void 0!==n&&n&&n.init("default","CK7I62QJ","placement:grapesjscomdocs",{target:"#native-carbon"})},load:function(){var n=this,t=document.createElement("script");t.src="//m.servedby-buysellads.com/monetization.js",t.onload=function(){return n.initCarbon()},this.$el.appendChild(t)}}},o=(e(313),e(44)),i=Object(o.a)(a,void 0,void 0,!1,null,null,null);t.default=i.exports}}]);

2
docs/assets/js/14.f6679dbc.js → docs/assets/js/14.21fd784c.js
View File

@ -1 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{412:function(t,e,n){},452:function(t,e,n){"use strict";n(412)},507:function(t,e,n){"use strict";n.r(e);var i={functional:!0,props:{type:{type:String,default:"tip"},text:String,vertical:{type:String,default:"top"}},render:function(t,e){var n=e.props,i=e.slots;return t("span",{class:["badge",n.type],style:{verticalAlign:n.vertical}},n.text||i().default)}},r=(n(452),n(52)),p=Object(r.a)(i,void 0,void 0,!1,null,"15b7b770",null);e.default=p.exports}}]);
(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{342:function(t,e,n){},380:function(t,e,n){"use strict";n(342)},436:function(t,e,n){"use strict";n.r(e);var i={functional:!0,props:{type:{type:String,default:"tip"},text:String,vertical:{type:String,default:"top"}},render:function(t,e){var n=e.props,i=e.slots;return t("span",{class:["badge",n.type],style:{verticalAlign:n.vertical}},n.text||i().default)}},r=(n(380),n(44)),p=Object(r.a)(i,void 0,void 0,!1,null,"15b7b770",null);e.default=p.exports}}]);

1
docs/assets/js/15.8026aa70.js
View File

@ -0,0 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{343:function(t,e,a){},381:function(t,e,a){"use strict";a(343)},422:function(t,e,a){"use strict";a.r(e);var n={name:"CodeBlock",props:{title:{type:String,required:!0},active:{type:Boolean,default:!1}},mounted:function(){this.$parent&&this.$parent.loadTabs&&this.$parent.loadTabs()}},i=(a(381),a(44)),s=Object(i.a)(n,(function(){var t=this.$createElement;return(this._self._c||t)("div",{staticClass:"theme-code-block",class:{"theme-code-block__active":this.active}},[this._t("default")],2)}),[],!1,null,"759a7d02",null);e.default=s.exports}}]);

1
docs/assets/js/15.e1f63ebd.js
View File

@ -1 +0,0 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{413:function(e,t,c){},453:function(e,t,c){"use strict";c(413)},503:function(e,t,c){"use strict";c.r(t);var i={name:"CodeBlock",props:{title:{type:String,required:!0},active:{type:Boolean,default:!1}}},n=(c(453),c(52)),s=Object(n.a)(i,(function(){var e=this.$createElement;return(this._self._c||e)("div",{staticClass:"theme-code-block",class:{"theme-code-block__active":this.active}},[this._t("default")],2)}),[],!1,null,"6d04095e",null);t.default=s.exports}}]);

1
docs/assets/js/16.50cb9f03.js
View File

@ -1 +0,0 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{414:function(e,t,o){},454:function(e,t,o){"use strict";o(414)},504:function(e,t,o){"use strict";o.r(t);o(27),o(116),o(76),o(118);var a={name:"CodeGroup",data:function(){return{codeTabs:[],activeCodeTabIndex:-1}},watch:{activeCodeTabIndex:function(e){this.codeTabs.forEach((function(e){e.elm.classList.remove("theme-code-block__active")})),this.codeTabs[e].elm.classList.add("theme-code-block__active")}},mounted:function(){var e=this;this.codeTabs=(this.$slots.default||[]).filter((function(e){return Boolean(e.componentOptions)})).map((function(t,o){return""===t.componentOptions.propsData.active&&(e.activeCodeTabIndex=o),{title:t.componentOptions.propsData.title,elm:t.elm}})),-1===this.activeCodeTabIndex&&this.codeTabs.length>0&&(this.activeCodeTabIndex=0)},methods:{changeCodeTab:function(e){this.activeCodeTabIndex=e}}},c=(o(454),o(52)),n=Object(c.a)(a,(function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("div",{staticClass:"theme-code-group"},[o("div",{staticClass:"theme-code-group__nav"},[o("ul",{staticClass:"theme-code-group__ul"},e._l(e.codeTabs,(function(t,a){return o("li",{key:t.title,staticClass:"theme-code-group__li"},[o("button",{staticClass:"theme-code-group__nav-tab",class:{"theme-code-group__nav-tab-active":a===e.activeCodeTabIndex},on:{click:function(t){return e.changeCodeTab(a)}}},[e._v("\n "+e._s(t.title)+"\n ")])])})),0)]),e._v(" "),e._t("default"),e._v(" "),e.codeTabs.length<1?o("pre",{staticClass:"pre-blank"},[e._v("// Make sure to add code blocks to your code group")]):e._e()],2)}),[],!1,null,"32c2d7ed",null);t.default=n.exports}}]);

1
docs/assets/js/16.5365d48a.js
View File

@ -0,0 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{344:function(e,t,a){},382:function(e,t,a){"use strict";a(344)},423:function(e,t,a){"use strict";a.r(t);a(66),a(27),a(95),a(96);var o={name:"CodeGroup",data:function(){return{codeTabs:[],activeCodeTabIndex:-1}},watch:{activeCodeTabIndex:function(e){this.activateCodeTab(e)}},mounted:function(){this.loadTabs()},methods:{changeCodeTab:function(e){this.activeCodeTabIndex=e},loadTabs:function(){var e=this;this.codeTabs=(this.$slots.default||[]).filter((function(e){return Boolean(e.componentOptions)})).map((function(t,a){return""===t.componentOptions.propsData.active&&(e.activeCodeTabIndex=a),{title:t.componentOptions.propsData.title,elm:t.elm}})),-1===this.activeCodeTabIndex&&this.codeTabs.length>0&&(this.activeCodeTabIndex=0),this.activateCodeTab(0)},activateCodeTab:function(e){this.codeTabs.forEach((function(e){e.elm&&e.elm.classList.remove("theme-code-block__active")})),this.codeTabs[e].elm&&this.codeTabs[e].elm.classList.add("theme-code-block__active")}}},n=(a(382),a(44)),c=Object(n.a)(o,(function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ClientOnly",[a("div",{staticClass:"theme-code-group"},[a("div",{staticClass:"theme-code-group__nav"},[a("ul",{staticClass:"theme-code-group__ul"},e._l(e.codeTabs,(function(t,o){return a("li",{key:t.title,staticClass:"theme-code-group__li"},[a("button",{staticClass:"theme-code-group__nav-tab",class:{"theme-code-group__nav-tab-active":o===e.activeCodeTabIndex},on:{click:function(t){return e.changeCodeTab(o)}}},[e._v("\n "+e._s(t.title)+"\n ")])])})),0)]),e._v(" "),e._t("default"),e._v(" "),e.codeTabs.length<1?a("pre",{staticClass:"pre-blank"},[e._v("// Make sure to add code blocks to your code group")]):e._e()],2)])}),[],!1,null,"deefee04",null);t.default=c.exports}}]);

2
docs/assets/js/17.1b60a777.js → docs/assets/js/17.16a899b7.js
View File

@ -1 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{502:function(e,t,r){"use strict";r.r(t);r(214);var s={name:"DemoViewer",props:{value:{type:String,default:""},user:{type:String,default:"artur_arseniev"},width:{type:String,default:"100%"},height:{type:String,default:"300"}},computed:{src:function(){var e=this.value,t=this.user;return"//jsfiddle.net/".concat(t,"/").concat(e,"/embedded/js,html,css,result")}}},i=r(52),n=Object(i.a)(s,(function(){var e=this.$createElement;return(this._self._c||e)("iframe",{attrs:{width:this.width,height:this.height,src:this.src,allowfullscreen:"allowfullscreen",frameborder:"0"}})}),[],!1,null,null,null);t.default=n.exports}}]);
(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{424:function(e,t,r){"use strict";r.r(t);r(173);var s={name:"DemoViewer",props:{value:{type:String,default:""},user:{type:String,default:"artur_arseniev"},width:{type:String,default:"100%"},height:{type:String,default:"300"}},computed:{src:function(){var e=this.value,t=this.user;return"//jsfiddle.net/".concat(t,"/").concat(e,"/embedded/js,html,css,result")}}},i=r(44),n=Object(i.a)(s,(function(){var e=this.$createElement;return(this._self._c||e)("iframe",{attrs:{width:this.width,height:this.height,src:this.src,allowfullscreen:"allowfullscreen",frameborder:"0"}})}),[],!1,null,null,null);t.default=n.exports}}]);

2
docs/assets/js/18.b7385ed2.js → docs/assets/js/18.2b682096.js
View File

@ -1 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{493:function(t,e,s){"use strict";s.r(e);var n=["There's nothing here.","How did we get here?","That's a Four-Oh-Four.","Looks like we've got some broken links."],o={methods:{getMsg:function(){return n[Math.floor(Math.random()*n.length)]}}},i=s(52),h=Object(i.a)(o,(function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"theme-container"},[e("div",{staticClass:"theme-default-content"},[e("h1",[this._v("404")]),this._v(" "),e("blockquote",[this._v(this._s(this.getMsg()))]),this._v(" "),e("RouterLink",{attrs:{to:"/"}},[this._v("\n Take me home.\n ")])],1)])}),[],!1,null,null,null);e.default=h.exports}}]);
(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{431:function(t,e,s){"use strict";s.r(e);var n=["There's nothing here.","How did we get here?","That's a Four-Oh-Four.","Looks like we've got some broken links."],o={methods:{getMsg:function(){return n[Math.floor(Math.random()*n.length)]}}},i=s(44),h=Object(i.a)(o,(function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"theme-container"},[e("div",{staticClass:"theme-default-content"},[e("h1",[this._v("404")]),this._v(" "),e("blockquote",[this._v(this._s(this.getMsg()))]),this._v(" "),e("RouterLink",{attrs:{to:"/"}},[this._v("\n Take me home.\n ")])],1)])}),[],!1,null,null,null);e.default=h.exports}}]);

2
docs/assets/js/19.46b34bc8.js → docs/assets/js/19.c8bf26af.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/2.15028157.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/2.76987c6d.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/20.f6e656e9.js → docs/assets/js/20.7ee8a470.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/21.5fbfcbfa.js → docs/assets/js/21.80a868df.js
View File

@ -1 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{513:function(t,e,s){"use strict";s.r(e);var a=s(52),o=Object(a.a)({},(function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"api-reference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#api-reference"}},[this._v("#")]),this._v(" API Reference")]),this._v(" "),e("p",[this._v("Here you can find the documentation about GrapesJS' APIs. Mainly, you would use them for your editor to extend the basic functionality of the framework or you could also "),e("RouterLink",{attrs:{to:"/modules/Plugins.html"}},[this._v("create a plugin")]),this._v(" and make those extensions reusable and available to others.")],1)])}),[],!1,null,null,null);e.default=o.exports}}]);
(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{447:function(t,e,s){"use strict";s.r(e);var a=s(44),o=Object(a.a)({},(function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("h1",{attrs:{id:"api-reference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#api-reference"}},[this._v("#")]),this._v(" API Reference")]),this._v(" "),e("p",[this._v("Here you can find the documentation about GrapesJS' APIs. Mainly, you would use them for your editor to extend the basic functionality of the framework or you could also "),e("RouterLink",{attrs:{to:"/modules/Plugins.html"}},[this._v("create a plugin")]),this._v(" and make those extensions reusable and available to others.")],1)])}),[],!1,null,null,null);e.default=o.exports}}]);

1
docs/assets/js/22.b1817aaa.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/22.c9db409a.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/23.24b1a9f0.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/23.eea06144.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/24.a568d17b.js → docs/assets/js/24.0b14d393.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/25.9769e6e3.js → docs/assets/js/25.a736d8ee.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/26.284071ba.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/26.5a4f24ff.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/27.4266ca40.js → docs/assets/js/27.f3b530ab.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/28.cc45d02f.js → docs/assets/js/28.f3e302a2.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/29.4c939d39.js → docs/assets/js/29.0534d4fc.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/3.9c33fa00.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/3.ae005b76.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/30.2f7bb3ab.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/30.91585127.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/31.58e6a8d0.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/31.5b8e0e55.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/32.120a63a8.js → docs/assets/js/32.9ea68a19.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/33.4a67243d.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/33.83a74dc0.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/34.5195e151.js
View File

@ -0,0 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{439:function(t,a,s){"use strict";s.r(a);var e=s(44),n=Object(e.a)({},(function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h2",{attrs:{id:"getallframes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallframes"}},[t._v("#")]),t._v(" getAllFrames")]),t._v(" "),s("p",[t._v("Get all frames")]),t._v(" "),s("h3",{attrs:{id:"examples"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" arrayOfFrames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" page"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllFrames")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Returns "),s("strong",[s("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array",target:"_blank",rel:"noopener noreferrer"}},[t._v("Array"),s("OutboundLink")],1),t._v("<Frame>")])]),t._v(" "),s("h2",{attrs:{id:"getmainframe"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getmainframe"}},[t._v("#")]),t._v(" getMainFrame")]),t._v(" "),s("p",[t._v("Get the first frame of the page (identified always as the main one)")]),t._v(" "),s("h3",{attrs:{id:"examples-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#examples-2"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" mainFrame "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" page"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMainFrame")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Returns "),s("strong",[t._v("Frame")])]),t._v(" "),s("h2",{attrs:{id:"getmaincomponent"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getmaincomponent"}},[t._v("#")]),t._v(" getMainComponent")]),t._v(" "),s("p",[t._v("Get the root component (usually is the "),s("code",[t._v("wrapper")]),t._v(" component) from the main frame")]),t._v(" "),s("h3",{attrs:{id:"examples-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#examples-3"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rootComponent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" page"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMainComponent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("rootComponent"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHTML")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Returns "),s("strong",[t._v("Component")])])])}),[],!1,null,null,null);a.default=n.exports}}]);

2
docs/assets/js/34.991371c4.js → docs/assets/js/35.ee386620.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/35.62067c34.js → docs/assets/js/36.3c04f1d9.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/36.2b20b664.js → docs/assets/js/37.29e16f9c.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/37.9c426a13.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/38.5d32b029.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/38.b708d72a.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/39.9a58de40.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/39.b704c28a.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/4.20f46c0c.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/4.f31d6c5b.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/40.8e6d589e.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/40.615e6955.js → docs/assets/js/41.3352d1b5.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/41.27038fe0.js → docs/assets/js/42.57cce0c6.js
View File

@ -1 +1 @@
(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{529:function(t,s,e){"use strict";e.r(s);var n=e(52),a=Object(n.a)({},(function(){var t=this.$createElement,s=this._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[s("h1",{attrs:{id:"faq"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#faq"}},[this._v("#")]),this._v(" FAQ")]),this._v(" "),s("p",[this._v("Coming soon")])])}),[],!1,null,null,null);s.default=a.exports}}]);
(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{462:function(t,s,e){"use strict";e.r(s);var n=e(44),a=Object(n.a)({},(function(){var t=this.$createElement,s=this._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[s("h1",{attrs:{id:"faq"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#faq"}},[this._v("#")]),this._v(" FAQ")]),this._v(" "),s("p",[this._v("Coming soon")])])}),[],!1,null,null,null);s.default=a.exports}}]);

2
docs/assets/js/42.5d0fecb4.js → docs/assets/js/43.a4256f15.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/43.f83108fe.js → docs/assets/js/44.c05e59f9.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/44.10a1c9ff.js → docs/assets/js/45.3e7d2ba2.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/45.54999ce9.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/46.c362554c.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/46.d0dbaadb.js → docs/assets/js/47.a5e549f1.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/47.2ce8943d.js → docs/assets/js/48.2e375343.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/48.a7241afb.js → docs/assets/js/49.88dd7cce.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/5.5d310613.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/5.a0dda975.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/49.95672b90.js → docs/assets/js/50.c459c2cb.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/50.bddbb88f.js → docs/assets/js/51.47c12f8d.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/51.02d3928a.js → docs/assets/js/52.334fdb25.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/52.c9e3636a.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/53.ec424eac.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/53.144b5e27.js → docs/assets/js/54.91803c3a.js
View File

File diff suppressed because one or more lines are too long

2
docs/assets/js/54.e7d62a93.js → docs/assets/js/55.266c6160.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/6.08f4bcf8.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/6.f7435f21.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/7.cf6e89f4.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/7.d040063a.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/8.904f276f.js
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/9.acf071b7.js
View File

File diff suppressed because one or more lines are too long

Some files were not shown because too many files changed in this diff

Write Preview
Loading…
Cancel
Save