ckeditor5 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11255f34bfbd4ad2c1657efc1e5df34390d2adefb67a0e39a02ffc5be814ae84
-  data.tar.gz: 7fb31aa484581713750c55c6c0d0dce21d71a13063b4b77687f9663403b1c35d
+  metadata.gz: 23e478e9988398f0612c2831798b5cd7a2abb9e6f21a8777e22964fe97974041
+  data.tar.gz: 817dfd3d0a94ef227c8e5845636468cf2aec54dbd19127f09feccd2c65d818cd
 SHA512:
-  metadata.gz: a52319bf5229236fbb4bb9f0d7515aa0cd68717c2b483cb2f2dd132f580600c7009d1fbe26e5fad1b356708b743839cd2a8d3998a8476ae24d1b7f3ae7d3f640
-  data.tar.gz: 960c18eecd8ae02b5caa418b47cbdaff3fd618382f53e630fe83bb310322622f19832e728f9d86ee11ff866da0d2abe8efd37ced1c7a1f8f05103c0f0dba43c5
+  metadata.gz: 00d576237488fcf65f5ceb1df860f1a2c6a31beccfc4361d57253ae014998072f083f282f66d4d0114e5eb8f50f3c838c56e172ded14bd559dbfe2b6d7c0abf4
+  data.tar.gz: a76c84be02f3c76acd8c4a39505264677ab34e3b4536887e1309da41417846346cee2f86718fef8e64f897acd4f5488f373def7c2299a49ca5ac8397ae296cf9

data/README.md

@@ -16,29 +16,19 @@ Add this line to your application's Gemfile:
 gem 'ckeditor5'
 ```
 
-## Basic Usage
+## Presets
 
-### Presets
+Presets are predefined configurations of CKEditor 5, allowing quick setup with specific features. The gem includes a `:default` preset with common features like bold, italic, underline, and link for the classic editor.
 
-Override default preset configuration:
+You can override the default preset or create your own by defining a new preset in the `config/initializers/ckeditor5.rb` file using the `config.presets.define` method.
 
-```rb
-# config/initializers/ckeditor5.rb
-
-CKEditor5::Rails::Engine.configure do |config|
-  config.presets.override :default do |preset|
-    preset.menubar visible: false
-  end
-end
-```
-
-Create new preset:
+The example below shows how to define a custom preset with a classic editor and a custom toolbar:
 
 ```rb
 # config/initializers/ckeditor5.rb
 
 CKEditor5::Rails::Engine.configure do |config|
-  config.presets.define :custom do |preset|
+  config.presets.define :custom
     shape :classic
 
     menubar
@@ -59,58 +49,151 @@ CKEditor5::Rails::Engine.configure do |config|
             :TextTransformation, :TodoList, :Underline, :Undo, :Base64UploadAdapter
   end
 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 new configuration. In example below, we override the `:default` preset to hide the menubar.
+
+```rb
+# config/initializers/ckeditor5.rb
+
+CKEditor5::Rails::Engine.configure do |config|
+  config.presets.override :default do
+    menubar visible: false
+  end
+end
+```
+
+You can generate your preset using the CKEditor 5 [online builder](https://ckeditor.com/ckeditor-5/online-builder/). After generating the configuration, you can copy it to the `config/initializers/ckeditor5.rb` file.
+
+### Available Configuration Methods
+
+#### `shape(type)` method
+
+Defines the type of editor. Available options:
+
+- `:classic` - standard editor
+- `:inline` - inline editor
+- `:balloon` - balloon editor
+- `:multiroot` - editor with multiple editing areas
+
+The example below shows how to define a multiroot editor:
+
+```rb
+config.presets.define :custom do
+  shape :multiroot
+end
+```
+
+#### `plugins(*names)` method
+
+Defines the plugins to be included in the editor. You can specify multiple plugins by passing their names as arguments.
+
+```rb
+config.presets.define :custom do
+  plugins :Bold, :Italic, :Underline, :Link
+end
+```
+
+#### `toolbar(*items, should_group_when_full: true)` method
+
+Defines the toolbar items. You can use predefined items like `:undo`, `:redo`, `:|` or specify custom items. There are a few special items:
 
-# Somewhere in your view
+- `:_` - breakpoint
+- `:|` - separator
 
-= ckeditor5_editor preset: :custom
+The `should_group_when_full` keyword argument determines whether the toolbar should group items when there is not enough space. It's set to `true` by default.
+
+```rb
+config.presets.define :custom do
+  # ... other configuration
+
+  toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
+          :link, :insertImage, :ckbox, :mediaEmbed, :insertTable, :blockQuote, :|,
+          :bulletedList, :numberedList, :todoList, :outdent, :indent
+end
 ```
 
-### CDN Configuration
+Keep in mind that the order of items is important, and you should install the corresponding plugins. You can find the list of available plugins in the [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/framework/architecture/plugins.html).
 
-#### jsDelivr (Default)
+Defines the toolbar items. You can use predefined items like `:undo`, `:redo`, `:|` or specify custom items. There are few special items:
 
-```slim
-- content_for :head
-  = ckeditor5_assets version: '43.2.0'
+- `:_` - breakpoint
+- `:|` - separator
+
+```rb
+config.presets.define :custom do
+  # ... other configuration
+
+  toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
+          :link, :insertImage, :ckbox, :mediaEmbed, :insertTable, :blockQuote, :|,
+          :bulletedList, :numberedList, :todoList, :outdent, :indent
+end
 ```
 
-#### unpkg
+Keep in mind that the order of items is important, and you should install the corresponding plugins. You can find the list of available plugins in the [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/framework/architecture/plugins.html).
+
+#### `menubar(visible: true)` method
+
+Defines the visibility of the menubar. By default, it's set to `true`.
 
-```slim
-- content_for :head
-  = ckeditor5_unpkg_assets version: '43.2.0'
+```rb
+config.presets.define :custom do
+  # ... other configuration
+
+  toolbar :undo, :redo, :|, :heading, :|, :bold, :italic, :underline, :|,
+          :link, :insertImage, :ckbox, :mediaEmbed, :insertTable, :blockQuote, :|,
+          :bulletedList, :numberedList, :todoList, :outdent, :indent
+end
 ```
 
-#### CKEditor Cloud
+#### `language(ui, content:)` method
 
-It's available only for licensed users.
+Defines the language of the editor. You can pass the language code as an argument. Keep in mind that the UI and content language can be different. The example below shows how to set the Polish language for the UI and content:
 
-```slim
-- content_for :head
-  = ckeditor5_assets version: '43.2.0', license_key: 'YOUR-LICENSE-KEY'
+```rb
+config.presets.define :custom do
+  language :pl
+end
+```
+
+In order to set the language for the content, you can pass the `content` keyword argument:
+
+```rb
+config.presets.define :custom do
+  language :en, content: :pl
+end
+```
+
+#### `configure(name, value)` method
+
+Allows you to set custom configuration options. You can pass the name of the option and its value as arguments. The example below show how to set the default protocol for the link plugin to `https://`:
+
+```rb
+config.presets.define :custom do
+  configure :link, {
+    defaultProtocol: 'https://'
+  }
+end
 ```
 
-### Editor type
+#### `plugin(name, premium:, import_name:)` method
 
-#### Classic Editor
+Defines a plugin to be included in the editor. You can pass the name of the plugin as an argument. The `premium` keyword argument determines whether the plugin is premium. The `import_name` keyword argument specifies the name of the package to import the plugin from.
 
-```slim
-- content_for :head
-  = ckeditor5_assets version: '43.2.0' # Optional: translations: [ :pl, :es ]
+The example below show how to import Bold plugin from the `ckeditor5` npm package:
 
-= ckeditor5_editor
+```rb
+config.presets.define :custom do
+  plugin :Bold
+end
 ```
 
-#### Multiroot Editor
+In order to import a plugin from a custom package, you can pass the `import_name` keyword argument:
 
-```slim
-= ckeditor5_editor type: :multiroot do
-  = ckeditor5_toolbar
-  br
-  = ckeditor5_editable 'editable-a' do
-    | This is a toolbar editable
-  br
-  = ckeditor5_editable 'editable-b'
+```rb
+config.presets.define :custom do
+  plugin :YourPlugin, import_name: 'your-package'
+end
 ```
 
 ## License

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

@@ -4,9 +4,11 @@ module CKEditor5::Rails::Editor
   class PropsPlugin
     delegate :to_h, to: :import_meta
 
-    def initialize(name, premium: false)
+    def initialize(name, premium: false, import_name: nil)
       @name = name
       @premium = premium
+      @import_name = import_name
+      @import_name ||= premium ? 'ckeditor5-premium-features' : 'ckeditor5'
     end
 
     def self.normalize(plugin)
@@ -19,12 +21,12 @@ module CKEditor5::Rails::Editor
 
     private
 
-    attr_reader :name, :premium
+    attr_reader :name, :premium, :import_name
 
     def import_meta
       ::CKEditor5::Rails::Assets::JSImportMeta.new(
         import_as: name,
-        import_name: premium ? 'ckeditor5-premium-features' : 'ckeditor5'
+        import_name: import_name
       )
     end
   end

data/lib/ckeditor5/rails/presets.rb

@@ -80,20 +80,26 @@ module CKEditor5::Rails
       }
     end
 
-    def toolbar(*items)
-      @config[:toolbar] = items
+    def toolbar(*items, should_group_when_full: true)
+      @config[:toolbar] = {
+        items: items,
+        shouldNotGroupWhenFull: !should_group_when_full
+      }
     end
 
-    def plugin(name, premium: false)
-      @config[:plugins] << Editor::PropsPlugin.new(name, premium: premium)
+    def plugin(name, **kwargs)
+      @config[:plugins] << Editor::PropsPlugin.new(name, **kwargs)
     end
 
-    def plugins(*names, premium: false)
-      names.each { |name| plugin(name, premium: premium) }
+    def plugins(*names, **kwargs)
+      names.each { |name| plugin(name, **kwargs) }
     end
 
-    def language(lang)
-      @config[:language] = lang
+    def language(ui, content: ui) # rubocop:disable Naming/MethodParameterName
+      @config[:language] = {
+        ui: ui,
+        content: content
+      }
     end
   end
 end

data/lib/ckeditor5/rails/version.rb

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

metadata

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