ckeditor5 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b14779f0c4c2e4358c77ed004b6c5ef191b2ff766fc95ba6c8f0245f7314f206
-  data.tar.gz: 0a47a7b166356002ef4b25879e420b42693bc1851596da4b4db1382d704fc875
+  metadata.gz: 0aee8586159157d2581cefe62cc87ea58d822db618c0f0dd9ceee5c0d3fdba46
+  data.tar.gz: 550633bd1bb74e54909f19447f7ced3bff0f6bd10324b44c9076641eb65e08e7
 SHA512:
-  metadata.gz: c7d8727f46f14c759f181dc77e19d4778efdb34e19327667922df06a7dcaa65d2512a4106d9dc0cf2f8810c7cb03b51e8cf440bda521f2cd237f7535447ac644
-  data.tar.gz: f6b08e3fa6292af226cdc2e29867ec5ffaa52cdba2a3ca6843735e4672e6d9411a7a30520b007a4cd267fa7dc69e380de8135831767d396674b4f768efc19737
+  metadata.gz: ba63dc4631e0703b8d719b7b2c21efc97183455550e6eb6406f96f8e789baaf1ed7dd202d0711ca100f39e906b386c026ef8515042d6441bce465baf6de8b10a
+  data.tar.gz: 15a0df8fd18291bc5d47e9a15df2d0192316512b38a85ec07c4bc047895d1111a6bd92afa2c09bdab639f31485a039538d7390048e39d66ea22bf51373e22e38

data/README.md

@@ -138,6 +138,13 @@ In order to override existing presets, you can use the `config.presets.override`
 CKEditor5::Rails::Engine.configure do |config|
   config.presets.override :default do
     menubar visible: false
+
+    toolbar do
+      remove :underline, :heading
+
+      # prepend :underline
+      # append :heading
+    end
   end
 end
 ```
@@ -305,6 +312,20 @@ config.presets.override :default do
 end
 ```
 
+If you want to remove items from the toolbar, you can use the `remove` method:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+config.presets.override :default do
+  # ... other configuration
+
+  toolbar do
+    remove :selectAll, :heading #, ...
+  end
+end
+```
+
 #### `menubar(visible: true)` method
 
 Defines the visibility of the menubar. By default, it's set to `true`.
@@ -783,12 +804,26 @@ This section covers frequent questions and scenarios when working with CKEditor
 
 ### Setting Initial Content 📝
 
+You can set the initial content of the editor using the `initial_data` keyword argument or by passing the content directly to the `ckeditor5_editor` helper block.
+
+The example below shows how to set the initial content of the editor using the `initial_data` keyword argument:
+
 ```erb
 <%= ckeditor5_editor initial_data: "<p>Initial content</p>" %>
 ```
 
+The example below shows how to set the initial content of the editor using the `ckeditor5_editor` helper block.
+
+```erb
+<%= ckeditor5_editor do %>
+  <p>Initial content</p>
+<% end %>
+```
+
 ### Setting Editor Language 🌐
 
+You can set the language of the editor using the `language` method in the `config/initializers/ckeditor5.rb` file. The `translations` method fetches the translations files, while the `language` method sets the default language of the editor.
+
 ```rb
 config.presets.override :default do
   translations :pl, :es
@@ -798,6 +833,8 @@ end
 
 ### Integrating with Forms 📋
 
+You can integrate CKEditor 5 with Rails form builders like `form_for` or `simple_form`. The example below shows how to integrate CKEditor 5 with a Rails form using the `form_for` helper:
+
 #### Rails form builder integration
 
 ```erb

data/lib/ckeditor5/rails/assets/webcomponent.mjs

@@ -51,12 +51,17 @@ class CKEditorComponent extends HTMLElement {
   /** @type {Record<string, HTMLElement>} Map of editable elements by name */
   editables = {};
 
+  /** @type {String} Initial HTML passed to component */
+  #initialHTML = '';
+
   /**
    * Lifecycle callback when element is connected to DOM
    * Initializes the editor when DOM is ready
    * @protected
    */
   connectedCallback() {
+    this.#initialHTML = this.innerHTML;
+
     try {
       execIfDOMReady(() => this.#reinitializeEditor());
     } catch (error) {
@@ -179,7 +184,7 @@ class CKEditorComponent extends HTMLElement {
     this.style.display = 'block';
 
     if (!this.isMultiroot() && !this.isDecoupled()) {
-      this.innerHTML = `<${this.#editorElementTag}></${this.#editorElementTag}>`;
+      this.innerHTML = `<${this.#editorElementTag}>${this.#initialHTML}</${this.#editorElementTag}>`;
       this.#assignInputAttributes();
     }
 

data/lib/ckeditor5/rails/editor/helpers.rb

@@ -24,14 +24,15 @@ module CKEditor5::Rails
       config = config.deep_merge(extra_config)
       config[:initialData] = initial_data if initial_data
 
+      raise ArgumentError, 'Cannot pass initial data and block at the same time.' if initial_data && block
+
       editor_props = build_editor_props(
         config: config,
         type: type,
         context: context
       )
 
-      render_editor_component(editor_props, html_attributes,
-                              &(%i[multiroot decoupled].include?(type) ? block : nil))
+      render_editor_component(editor_props, html_attributes, &block)
     end
 
     def ckeditor5_editable(name = nil, **kwargs, &block)

data/lib/ckeditor5/rails/presets.rb

@@ -187,29 +187,33 @@ module CKEditor5::Rails
       @toolbar_config = toolbar_config
     end
 
-    def prepend(*items, before: nil)
-      toolbar_items = @toolbar_config[:items]
+    def items
+      @toolbar_config[:items]
+    end
+
+    def remove(*removed_items)
+      removed_items.each { |item| items.delete(item) }
+    end
 
+    def prepend(*prepended_items, before: nil)
       if before
-        index = toolbar_items.index(before)
+        index = items.index(before)
         raise ArgumentError, "Item '#{before}' not found in toolbar" unless index
 
-        toolbar_items.insert(index, *items)
+        items.insert(index, *prepended_items)
       else
-        toolbar_items.insert(0, *items)
+        items.insert(0, *prepended_items)
       end
     end
 
-    def append(*items, after: nil)
-      toolbar_items = @toolbar_config[:items]
-
+    def append(*appended_items, after: nil)
       if after
-        index = toolbar_items.index(after)
+        index = items.index(after)
         raise ArgumentError, "Item '#{after}' not found in toolbar" unless index
 
-        toolbar_items.insert(index + 1, *items)
+        items.insert(index + 1, *appended_items)
       else
-        toolbar_items.push(*items)
+        items.push(*appended_items)
       end
     end
   end

data/lib/ckeditor5/rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CKEditor5::Rails
-  VERSION = '1.1.0'
+  VERSION = '1.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Mateusz Bagiński