ckeditor5 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0babe5c17bf5e8492ad7e372a23d0c5c3bc900552d18c22f14702d1b1ef27cb4
-  data.tar.gz: b4a3eb8f291deb3584dcce52cd3e404c97311321b4d7ccf6767c26face6dcb37
+  metadata.gz: ffcf4f20d7134eefdd8ed70322d880862886c260c5b68295154e5932eb7aed8f
+  data.tar.gz: 63c20e49867be66eee43e90a0b473e13971648216675927408d82265f483d8b8
 SHA512:
-  metadata.gz: 629844431fc4c4eedf849b65d90a05f7df0591c90a24cb44f22c80c348ae84afbaae2428902f0eb47e56bfaaaf6057365f1256a5330d62b759300159dd6c7855
-  data.tar.gz: fa122e9c537fd3d17eba7a9c98e39e3d24f15377a03be2cf72df07e85220e9fdbb72ee1dc8c9942ba23216e3b58334e874d2c7d334a2a21fa8ceccc4f3c7f8c9
+  metadata.gz: f5d9f8eb254a1210c9792ddfea0885f58b4c11c9d049a14ee9e269f753204f7a10e3eacade18f502497becb02544f7440641414f6dd1495798428ef10fa40c47
+  data.tar.gz: 88fb52bde4a26017c7e122ac71dcaad9568ccbd1a4163f41a55cbf5d9f67ee19a2acdc8f7a37edfde92444fbbc230a34f20bfde005630d95cd7f29b52085b16b

data/README.md

@@ -20,7 +20,7 @@ Add this line to your application's Gemfile:
 gem 'ckeditor5'
 ```
 
-In your config:
+In your config (the default config is defined [here](https://github.com/Mati365/ckeditor5-rails/blob/main/lib/ckeditor5/rails/presets/manager.rb)):
 
 ```rb
 # config/initializers/ckeditor5.rb
@@ -67,6 +67,10 @@ Voilà! You have CKEditor 5 integrated with your Rails application. 🎉
       - [`plugins(*names, **kwargs)` method](#pluginsnames-kwargs-method)
       - [`inline_plugin(name, code)` method](#inline_pluginname-code-method)
   - [Including CKEditor 5 assets 📦](#including-ckeditor-5-assets-)
+    - [Format 📝](#format-)
+      - [Using default preset](#using-default-preset)
+      - [Custom preset](#custom-preset)
+      - [Inline preset definition](#inline-preset-definition)
     - [Lazy loading 🚀](#lazy-loading-)
     - [GPL usage 🆓](#gpl-usage-)
     - [Commercial usage 💰](#commercial-usage-)
@@ -141,16 +145,18 @@ CKEditor5::Rails.configure do
 end
 ```
 
-In order to override existing presets, you can use the `config.presets.override` method. The method takes the name of the preset you want to override and a block with the old configuration. The example below shows how to hide the menubar in the default preset:
+In order to override existing presets, you can use the `presets.override` method. The method takes the name of the preset you want to override and a block with the old configuration. The example below shows how to hide the menubar in the default preset:
 
 ```rb
 # config/initializers/ckeditor5.rb
 
 CKEditor5::Rails.configure do
-  menubar visible: false
+  presets.override :custom do
+    menubar visible: false
 
-  toolbar do
-    remove :underline, :heading
+    toolbar do
+      remove :underline, :heading
+    end
   end
 end
 ```
@@ -169,7 +175,7 @@ Defines the CDN to be used for CKEditor 5 assets. The example below shows how to
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   cdn :jsdelivr
@@ -181,7 +187,7 @@ It also allows you to define a custom CDN by passing a block with the bundle, ve
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   cdn do |bundle, version, path|
@@ -199,7 +205,7 @@ Defines the version of CKEditor 5 to be used. The example below shows how to set
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   version '43.2.0'
@@ -213,7 +219,7 @@ Defines the license of CKEditor 5. The example below shows how to set the licens
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   gpl
@@ -227,7 +233,7 @@ Defines the license key of CKEditor 5. It calls `premium` method internally. The
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   license_key 'your-license-key'
@@ -241,7 +247,7 @@ Defines if premium package should be included in JS assets. The example below sh
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   premium
@@ -255,7 +261,7 @@ Defines the translations of CKEditor 5. You can pass the language codes as argum
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   translations :pl, :es
@@ -267,9 +273,10 @@ end
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
-  translations :pl
+CKEditor5::Rails.configure do
+  # ... other configuration
 
+  translations :pl
   language :pl
 end
 ```
@@ -281,7 +288,7 @@ Defines the CKBox plugin to be included in the editor. The example below shows h
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   ckbox '2.5.4', theme: :lark
@@ -303,7 +310,7 @@ The example below sets the editor type to `multiroot` in the custom preset:
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   type :multiroot
@@ -322,7 +329,7 @@ The `should_group_when_full` keyword argument determines whether the toolbar sho
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
@@ -338,7 +345,7 @@ If you want to add or prepend items to the existing toolbar, you can use the blo
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.override :default do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar do
@@ -353,7 +360,7 @@ 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
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar do
@@ -369,7 +376,7 @@ Defines the visibility of the menubar. By default, it's set to `true`.
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
@@ -385,7 +392,7 @@ Defines the language of the editor. You can pass the language code as an argumen
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   language :pl
@@ -397,7 +404,7 @@ In order to set the language for the content, you can pass the `content` keyword
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   language :en, content: :pl
@@ -411,7 +418,7 @@ Allows you to set custom configuration options. You can pass the name of the opt
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   configure :link, {
@@ -429,7 +436,7 @@ The example below show how to import Bold plugin from the `ckeditor5` npm packag
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugin :Bold
@@ -441,7 +448,7 @@ In order to import a plugin from a custom ESM package, you can pass the `import_
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugin :YourPlugin, import_name: 'your-package'
@@ -453,7 +460,7 @@ In order to import a plugin from a custom Window entry, you can pass the `window
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugin :YourPlugin, window_name: 'YourPlugin'
@@ -467,7 +474,7 @@ Defines the plugins to be included in the editor. You can specify multiple plugi
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   plugins :Bold, :Italic, :Underline, :Link
@@ -481,7 +488,7 @@ Use with caution as this is an inline definition of the plugin code, and you can
 ```rb
 # config/initializers/ckeditor5.rb
 
-config.presets.define :custom do
+CKEditor5::Rails.configure do
   # ... other configuration
 
   inline_plugin :MyCustomPlugin, <<~JS
@@ -507,32 +514,88 @@ To include CKEditor 5 assets in your application, you can use the `ckeditor5_ass
 
 Keep in mind that you need to include the helper result in the `head` section of your layout. In examples below, we use `content_for` helper to include the assets in the `head` section of the view.
 
-### Lazy loading 🚀
+### Format 📝
 
-<details>
-  <summary>Loading JS and CSS Assets</summary>
+#### Using default preset
 
-All JS assets defined by the `ckeditor5_assets` helper method are loaded **asynchronously**. It means that the assets are loaded in the background without blocking the rendering of the page. However, the CSS assets are loaded **synchronously** to prevent the flash of unstyled content and ensure that the editor is styled correctly.
+The example below users the default preset defined [here](https://github.com/Mati365/ckeditor5-rails/blob/main/lib/ckeditor5/rails/presets/manager.rb).
 
-It has been achieved by using web components, together with import maps, which are supported by modern browsers. The web components are used to define the editor and its plugins, while the import maps are used to define the dependencies between the assets.
+```erb
+<!-- app/views/demos/index.html.erb -->
 
-</details>
+<% content_for :head do %>
+  <%= ckeditor5_assets %>
+<% end %>
+```
 
-### GPL usage 🆓
+If you want to fetch some additional translations, you can extend your initializer with the following configuration:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... rest of the configuration
+
+  translations :pl, :es
+end
+```
 
-If you want to use CKEditor 5 under the GPL license, you can include the assets using the `ckeditor5_assets` without passing any arguments. However you can pass the `version` keyword argument with the version of CKEditor 5 you want to use:
+#### Custom preset
+
+To specify a custom preset, you need to pass the `preset` keyword argument with the name of the preset. The example below shows how to include the assets for the custom preset:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
 
 <% content_for :head do %>
-  <%= ckeditor5_assets version: '43.3.0' %>
+  <%= ckeditor5_assets preset: :custom %>
 <% end %>
 ```
 
-It'll include the necessary assets for the GPL license from one of the most popular CDNs. In our scenario, we use the `jsdelivr` CDN which is the default one.
+In order to define such preset, you can use the following configuration:
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails.configure do
+  # ... rest of the configuration
+
+  presets.define :custom do
+    # ... your preset configuration
+
+    translations :pl, :es
+  end
+end
+```
+
+#### Inline preset definition
+
+It's possible to define the preset directly in the `ckeditor5_assets` helper method. It allows you to dynamically specify version, cdn provider or even translations in the view. The example below inherits the default preset and adds Polish translations and other options:
+
+```erb
+<!-- app/views/demos/index.html.erb -->
+
+<% content_for :head do %>
+  <%= ckeditor5_assets version: '43.3.0', cdn: :jsdelivr, translations: [:pl], license_key: '<YOUR KEY> OR GPL' %>
+<% end %>
+```
+
+### Lazy loading 🚀
+
+<details>
+  <summary>Loading JS and CSS Assets</summary>
+
+All JS assets defined by the `ckeditor5_assets` helper method are loaded **asynchronously**. It means that the assets are loaded in the background without blocking the rendering of the page. However, the CSS assets are loaded **synchronously** to prevent the flash of unstyled content and ensure that the editor is styled correctly.
+
+It has been achieved by using web components, together with import maps, which are supported by modern browsers. The web components are used to define the editor and its plugins, while the import maps are used to define the dependencies between the assets.
+
+</details>
+
+### GPL usage 🆓
 
-Version is optional as long as you defined it in the `config/initializers/ckeditor5.rb` file. If you want to use the default version, you can omit the `version` keyword argument:
+If you want to use CKEditor 5 under the GPL license, you can include the assets using the `ckeditor5_assets` without passing any arguments. It'll include the necessary assets for the GPL license from one of the most popular CDNs. In our scenario, we use the `jsdelivr` CDN which is the default one.
+
+Example:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
@@ -542,7 +605,7 @@ Version is optional as long as you defined it in the `config/initializers/ckedit
 <% end %>
 ```
 
-Set the version in the `config/initializers/ckeditor5.rb` file:
+In that scenario it's recommended to add `gpl` method to the initializer along with the version:
 
 ```rb
 # config/initializers/ckeditor5.rb
@@ -553,49 +616,59 @@ CKEditor5::Rails.configure do
 end
 ```
 
-In order to use `unpkg` CDN, you can pass the `cdn` keyword argument with the value `:unpkg`:
+In order to use `unpkg` CDN, you can extend your initializer with the following configuration:
 
-```erb
-<!-- app/views/demos/index.html.erb -->
+```rb
+# config/initializers/ckeditor5.rb
 
-<% content_for :head do %>
-  <%= ckeditor5_assets cdn: :unpkg %>
-<% end %>
+CKEditor5::Rails.configure do
+  # ... rest of the configuration
+
+  cdn :unpkg
+end
 ```
 
-or using helper function:
+However, you can also specify the CDN directly in the view:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
 
 <% content_for :head do %>
-  <%= ckeditor5_jsdelivr_assets %>
+  <%= ckeditor5_assets cdn: :unpkg %>
 <% end %>
 ```
 
-Translating CKEditor 5 is possible by passing the `translations` keyword argument with the languages codes array. The example below shows how to include the Polish translations:
+or using helper function:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->
 
 <% content_for :head do %>
-  <%= ckeditor5_assets translations: [:pl] %>
+  <%= ckeditor5_jsdelivr_assets %>
 <% end %>
 ```
 
-Keep in mind, that you need to include the translations in the `config/initializers/ckeditor5.rb` file:
+### Commercial usage 💰
+
+If you want to use CKEditor 5 under a commercial license, you have to specify license key. It can be done in the initializer:
 
 ```rb
 # config/initializers/ckeditor5.rb
 
 CKEditor5::Rails.configure do
-  language :pl
+  license_key 'your-license-key'
 end
 ```
 
-### Commercial usage 💰
+```erb
+<!-- app/views/demos/index.html.erb -->
+
+<% content_for :head do %>
+  <%= ckeditor5_assets %>
+<% end %>
+```
 
-If you want to use CKEditor 5 under a commercial license, you can include the assets using the `ckeditor5_assets` helper method with the `license_key` keyword argument. The example below shows how to include the assets for the commercial license:
+or directly in the view:
 
 ```erb
 <!-- app/views/demos/index.html.erb -->

data/lib/ckeditor5/rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ckeditor5
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Mateusz Bagiński
@@ -9,28 +9,28 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-04 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description:
 email: cziken58@gmail.com
 executables: []