RubyGems - ckeditor5 - Versions diffs - 1.19.4 → 1.20.0 - Mend

ckeditor5 1.19.4 → 1.20.0

Files changed (27) hide show

checksums.yaml +4 -4
data/Gemfile +5 -2
data/README.md +2 -0
data/lib/ckeditor5/rails/assets/assets_bundle_html_serializer.rb +43 -25
data/lib/ckeditor5/rails/cdn/helpers.rb +81 -2
data/lib/ckeditor5/rails/context/helpers.rb +28 -0
data/lib/ckeditor5/rails/context/preset_builder.rb +33 -0
data/lib/ckeditor5/rails/editor/helpers/config_helpers.rb +39 -0
data/lib/ckeditor5/rails/editor/helpers/editor_helpers.rb +73 -13
data/lib/ckeditor5/rails/engine.rb +11 -3
data/lib/ckeditor5/rails/hooks/form.rb +44 -0
data/lib/ckeditor5/rails/hooks/importmap.rb +58 -0
data/lib/ckeditor5/rails/hooks/simple_form.rb +42 -0
data/lib/ckeditor5/rails/presets/concerns/configuration_methods.rb +45 -0
data/lib/ckeditor5/rails/presets/concerns/plugin_methods.rb +54 -0
data/lib/ckeditor5/rails/presets/manager.rb +49 -0
data/lib/ckeditor5/rails/presets/plugins_builder.rb +32 -0
data/lib/ckeditor5/rails/presets/preset_builder.rb +117 -0
data/lib/ckeditor5/rails/presets/toolbar_builder.rb +33 -0
data/lib/ckeditor5/rails/version.rb +1 -1
data/spec/e2e/features/editor_types_spec.rb +1 -1
data/spec/e2e/spec_helper.rb +2 -7
data/spec/lib/ckeditor5/rails/assets/{asset_bundle_hml_serializer_spec.rb → assets_bundle_hml_serializer_spec.rb} +58 -15
data/spec/lib/ckeditor5/rails/cdn/helpers_spec.rb +41 -5
data/spec/lib/ckeditor5/rails/engine_spec.rb +32 -0
data/spec/lib/ckeditor5/rails/hooks/importmap_spec.rb +131 -0
metadata +7 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c5b5fc8c89342abfcc436a313865c718a6f34b69b3a31a61cf6e08cbaa096e
-  data.tar.gz: e68c422c8089b7d474daf1a6b64c9a3e1fcfdbc2aa8c7daa341a9464b0687368
+  metadata.gz: e314a874501f623577e3e18a2d69aad4c1d1c901cf2aea3b7feb51d1b854f8cc
+  data.tar.gz: 42cb9fca3c8206ea2cba20b0d3229f06bc8420075f49da795849032bdad06da4
 SHA512:
-  metadata.gz: 577c327a85e8ea006375edf587aad41be62cc8c8fb635d34c71001ce360b15c5faf43be349b93fc089862dd9481f325d16984084af4a3861cc28ae4cd68b6dee
-  data.tar.gz: b3cfdbff22f5324ad609981e2f4a8a9fbec3d9d3cf99141abcd817184d1761a5a88dd939eaa793157cb35b05c75c26b04b538dc445f5d3edc7569458421c15c4
+  metadata.gz: f99b51b674897abae5b231e5e34f71a4e64963a2a88b16ef9f5f00dba1a9f17998f5bbfd7a4e1a19c6abd6716601f4c0bcbb978003a04938d2fa1a5b4ebbdf28
+  data.tar.gz: 050a3bf881dca0d54e186fe01066c8b7a4112d0f818e84f80de4ba8301cdd53500dc88cef800259ea9b2c1b0a23a42f93d3cce4fe0618206540a9bc9281222a8

data/Gemfile CHANGED Viewed

@@ -8,17 +8,20 @@ group :development do
   gem 'brakeman', '~> 6.1', '>= 6.1.1', require: false
   gem 'guard', '~> 2.19', '>= 2.19.0'
   gem 'guard-process', '~> 1.2'
+  gem 'importmap-rails'
+  gem 'propshaft'
   gem 'pry', '~> 0.15', '>= 0.15.0'
   gem 'pry-rails', '~> 0.3', '>= 0.3.11'
-  gem 'rails', '~> 7.0', '>= 7.0.0'
+  gem 'rails', '~> 8.0', '>= 8.0.0'
   gem 'rake', '~> 13.2', '>= 13.2.1'
   gem 'rubocop', '~> 1.66', require: false
   gem 'rubocop-rails', '~> 2.26', '>= 2.26.2', require: false
   gem 'rubocop-rails-omakase', '~> 1.0.0', require: false
   gem 'simple_form', '~> 5.3', '>= 5.3.0'
   gem 'slim', '~> 5.2', '>= 5.2.0'
-  gem 'sprockets-rails', '~> 3.2', '>= 3.2.2'
   gem 'sqlite3', '>= 1.4'
+  gem 'stimulus-rails'
+  gem 'turbo-rails'
 end
 group :test, :development do

data/README.md CHANGED Viewed

@@ -30,6 +30,8 @@ In your layout:
 <!DOCTYPE html>
 <html>
   <head>
+    <!-- ⚠️ If you use `rails-importmap` you have to include the importmap somewhere in the head. -->
+    <%= javascript_importmap_tags %>
     <%= yield :head %>
   </head>
   <body>

data/lib/ckeditor5/rails/assets/assets_bundle_html_serializer.rb CHANGED Viewed

@@ -9,22 +9,26 @@ module CKEditor5::Rails::Assets
   class AssetsBundleHtmlSerializer
     include ActionView::Helpers::TagHelper
-    attr_reader :bundle
+    attr_reader :bundle, :importmap
-    def initialize(bundle)
+    def initialize(bundle, importmap: true)
       raise TypeError, 'bundle must be an instance of AssetsBundle' unless bundle.is_a?(AssetsBundle)
+      @importmap = importmap
       @bundle = bundle
     end
     def to_html
-      safe_join([
-                  scripts_import_map_tag,
-                  preload_tags,
-                  styles_tags,
-                  window_scripts_tags,
-                  web_component_tag
-                ])
+      tags = [
+        preload_tags,
+        styles_tags,
+        window_scripts_tags,
+        web_component_tag
+      ]
+      tags.prepend(AssetsImportMap.new(bundle).to_html) if importmap
+      safe_join(tags)
     end
     def self.url_resource_preload_type(url)
@@ -47,22 +51,6 @@ module CKEditor5::Rails::Assets
       end)
     end
-    def scripts_import_map_tag
-      return @scripts_import_map_tag if defined?(@scripts_import_map_tag)
-      import_map = bundle.scripts.each_with_object({}) do |script, map|
-        next if !script.esm? || looks_like_url?(script.import_name)
-        map[script.import_name] = script.url
-      end
-      @scripts_import_map_tag = tag.script(
-        { imports: import_map }.to_json.html_safe,
-        type: 'importmap',
-        nonce: true
-      )
-    end
     def styles_tags
       @styles_tags ||= safe_join(bundle.stylesheets.map do |url|
         tag.link(href: url, rel: 'stylesheet', crossorigin: 'anonymous')
@@ -86,6 +74,36 @@ module CKEditor5::Rails::Assets
         end
       end)
     end
+  end
+  class AssetsImportMap
+    include ActionView::Helpers::TagHelper
+    attr_reader :bundle
+    def initialize(bundle)
+      @bundle = bundle
+    end
+    def to_json(*_args)
+      import_map = bundle.scripts.each_with_object({}) do |script, map|
+        next if !script.esm? || looks_like_url?(script.import_name)
+        map[script.import_name] = script.url
+      end
+      { imports: import_map }.to_json
+    end
+    def to_html
+      tag.script(
+        to_json.html_safe,
+        type: 'importmap',
+        nonce: true
+      )
+    end
+    private
     def looks_like_url?(str)
       uri = URI.parse(str)

data/lib/ckeditor5/rails/cdn/helpers.rb CHANGED Viewed

@@ -12,7 +12,58 @@ require_relative 'ckbox_bundle'
 module CKEditor5::Rails
   module Cdn::Helpers
-    def ckeditor5_assets(preset: :default, **kwargs)
+    class ImportmapAlreadyRenderedError < ArgumentError; end
+    # The `ckeditor5_assets` helper includes CKEditor 5 assets in your application.
+    # It's responsible for generating the necessary JavaScript and CSS imports based on
+    # the specified preset and configuration.
+    #
+    # @param [Symbol, PresetBuilder] preset The name of the preset to use (default: :default)
+    #   or a PresetBuilder object created using ckeditor5_preset helper
+    # @param [Hash] kwargs Additional configuration options:
+    #   - version: Specify a custom CKEditor version
+    #   - cdn: Select CDN provider (:jsdelivr, :unpkg, etc.)
+    #   - translations: Array of language codes to include
+    #   - ckbox: Configuration hash for CKBox integration
+    #   - license_key: Commercial license key
+    #   - premium: Enable premium features
+    #   - language: Set editor UI language (e.g. :pl, :es)
+    #
+    # @example Basic usage with default preset
+    #   <%= ckeditor5_assets %>
+    #   <%= ckeditor5_editor %>
+    #
+    # @example Simple editor with custom configuration
+    #   <%= ckeditor5_assets preset: :basic %>
+    #   <%= ckeditor5_editor toolbar: [:bold, :italic], plugins: [:Bold, :Italic] %>
+    #
+    # @example Using custom preset with translations and language
+    #   <%= ckeditor5_assets preset: :custom, translations: [:pl, :es], language: :pl %>
+    #
+    # @example Commercial usage with license key
+    #   <%= ckeditor5_assets license_key: 'your-license-key' %>
+    #
+    # @example Using preset builder object
+    #   <% @preset = ckeditor5_preset do
+    #     version '43.3.1'
+    #     toolbar :bold, :italic
+    #     plugins :Bold, :Italic
+    #   end %>
+    #   <%= ckeditor5_assets preset: @preset %>
+    #
+    # @example Editor only configuration with different types
+    #   <%= ckeditor5_assets preset: :basic %>
+    #   <%= ckeditor5_editor type: :classic %>
+    #   <%= ckeditor5_editor type: :inline %>
+    #   <%= ckeditor5_editor type: :balloon %>
+    #
+    def ckeditor5_assets(
+      preset: :default,
+      importmap: true,
+      **kwargs
+    )
+      ensure_importmap_not_rendered!
       mapped_preset = merge_with_editor_preset(preset, **kwargs)
       mapped_preset => {
         cdn:,
@@ -34,7 +85,7 @@ module CKEditor5::Rails
         preset: mapped_preset
       }
-      Assets::AssetsBundleHtmlSerializer.new(bundle).to_html
+      build_html_tags(bundle, importmap)
     end
     Cdn::UrlGenerator::CDN_THIRD_PARTY_GENERATORS.each_key do |key|
@@ -105,5 +156,33 @@ module CKEditor5::Rails
         bundle << plugin.preload_assets_bundle if plugin.preload_assets_bundle.present?
       end
     end
+    def importmap_available?
+      respond_to?(:importmap_rendered?)
+    end
+    def ensure_importmap_not_rendered!
+      return unless importmap_available? && importmap_rendered?
+      raise ImportmapAlreadyRenderedError,
+            'CKEditor5 assets must be included before javascript_importmap_tags. ' \
+            'Please move ckeditor5_assets helper before javascript_importmap_tags in your layout.'
+    end
+    def build_html_tags(bundle, importmap)
+      serializer = Assets::AssetsBundleHtmlSerializer.new(
+        bundle,
+        importmap: importmap && !importmap_available?
+      )
+      html = serializer.to_html
+      if importmap_available?
+        @__ckeditor_context[:html_tags] = html
+        nil
+      else
+        html
+      end
+    end
   end
 end

data/lib/ckeditor5/rails/context/helpers.rb CHANGED Viewed

@@ -5,6 +5,22 @@ require_relative 'preset_serializer'
 module CKEditor5::Rails::Context
   module Helpers
+    # Creates a CKEditor context component that can be shared between multiple editors.
+    # This allows you to define common plugins that will be available to all editors
+    # within the context.
+    #
+    # @param [PresetBuilder] preset The preset object containing shared plugins configuration
+    # @yield The block where editor instances should be defined
+    #
+    # @example Basic usage with shared plugins
+    #   <% preset = ckeditor5_context_preset do
+    #     plugins :Mention, :Emoji  # These plugins will be shared across all editors
+    #   end %>
+    #
+    #   <%= ckeditor5_context(preset) do %>
+    #     <%= ckeditor5_editor preset: :content %>
+    #     <%= ckeditor5_editor preset: :description %>
+    #   <% end %>
     def ckeditor5_context(preset = nil, &block)
       preset ||= PresetBuilder.new
       context_props = PresetSerializer.new(preset)
@@ -12,6 +28,18 @@ module CKEditor5::Rails::Context
       tag.public_send(:'ckeditor-context-component', **context_props.to_attributes, &block)
     end
+    # Creates a new preset builder object for use with ckeditor5_context.
+    # Used to define shared plugins that will be available to all editors within the context.
+    # Note: Only plugins configuration is relevant for context, other settings like toolbar
+    # should be configured at the editor level.
+    #
+    # @yield Block for configuring the shared plugins
+    # @return [PresetBuilder] A new preset builder instance
+    #
+    # @example Creating a context with shared plugins
+    #   <% preset = ckeditor5_context_preset do
+    #     plugins :Comments, :TrackChanges, :Collaboration  # Shared functionality plugins
+    #   end %>
     def ckeditor5_context_preset(&block)
       PresetBuilder.new(&block)
     end

data/lib/ckeditor5/rails/context/preset_builder.rb CHANGED Viewed

@@ -5,10 +5,39 @@ require_relative '../presets/concerns/plugin_methods'
 module CKEditor5::Rails
   module Context
+    # PresetBuilder provides functionality for building CKEditor 5 presets.
+    #
+    # This class includes configuration and plugin handling methods from concerns
+    # and allows defining presets either through initialization blocks or method chaining.
+    #
+    # @example Basic preset definition
+    #   preset = PresetBuilder.new do
+    #     version '43.3.1'
+    #     gpl
+    #     type :classic
+    #     toolbar :bold, :italic
+    #   end
+    #
+    # @example Cloning and modifying a preset
+    #   new_preset = preset.clone
+    #   new_preset.toolbar do
+    #     append :underline
+    #   end
+    #
+    # @see Presets::Concerns::ConfigurationMethods
+    # @see Presets::Concerns::PluginMethods
     class PresetBuilder
       include Presets::Concerns::ConfigurationMethods
       include Presets::Concerns::PluginMethods
+      # Initializes a new preset builder with optional configuration block
+      #
+      # @param block [Proc] Optional configuration block
+      # @example Initialize with block
+      #   PresetBuilder.new do
+      #     version '43.3.1'
+      #     toolbar :bold, :italic
+      #   end
       def initialize(&block)
         @config = {
           plugins: []
@@ -17,6 +46,10 @@ module CKEditor5::Rails
         instance_eval(&block) if block_given?
       end
+      # Creates a deep copy of the preset builder
+      #
+      # @param source [PresetBuilder] Source preset to copy from
+      # @return [PresetBuilder] New preset instance with copied configuration
       def initialize_copy(source)
         super

data/lib/ckeditor5/rails/editor/helpers/config_helpers.rb CHANGED Viewed

@@ -2,10 +2,49 @@
 module CKEditor5::Rails::Editor::Helpers
   module Config
+    # Creates a reference to a DOM element that will be used by CKEditor's features.
+    # This is particularly useful for features that need to check element presence
+    # or operate on specific DOM elements.
+    #
+    # @param selector [String] CSS selector for the target element
+    # @return [Hash] A hash with the element reference in CKEditor's format
+    #
+    # @example Referencing an element in plugin configuration
+    #   configure :yourPlugin, {
+    #     element: ckeditor5_element_ref("body")
+    #   }
     def ckeditor5_element_ref(selector)
       { '$element': selector }
     end
+    # Creates or retrieves a preset configuration for CKEditor.
+    # When called with a name, finds and returns an existing preset.
+    # When called with a block, creates a new preset with the given configuration.
+    #
+    # @param name [Symbol, nil] The name of an existing preset to retrieve
+    # @yield Block for configuring a new preset
+    # @return [PresetBuilder] The preset configuration object
+    #
+    # @example Finding an existing preset
+    #   @preset = ckeditor5_preset(:default)
+    #
+    # @example Creating a custom preset in controller
+    #   @preset = ckeditor5_preset do
+    #     version '43.3.1'
+    #     toolbar :sourceEditing, :|, :bold, :italic
+    #     plugins :Essentials, :Paragraph, :Bold, :Italic
+    #   end
+    #
+    # @example Using preset in view
+    #   <%= ckeditor5_assets preset: @preset %>
+    #   <%= ckeditor5_editor %>
+    #
+    # @example Overriding existing preset
+    #   @preset = ckeditor5_preset(:default).override do
+    #     toolbar do
+    #       remove :underline, :heading
+    #     end
+    #   end
     def ckeditor5_preset(name = nil, &block)
       return CKEditor5::Rails::Engine.find_preset(name) if name

data/lib/ckeditor5/rails/editor/helpers/editor_helpers.rb CHANGED Viewed

@@ -11,19 +11,53 @@ module CKEditor5::Rails
     class EditorContextError < StandardError; end
     class PresetNotFoundError < ArgumentError; end
-    # Creates a CKEditor 5 editor instance
-    #
-    # @param preset [Symbol] High-level configuration preset that defines base editor setup,
-    #   including editor type, plugins, and default configuration
-    # @param config [Hash] Editor-specific configuration that overrides preset defaults
-    # @param extra_config [Hash] Additional configuration to be merged with the base config
-    # @param type [Symbol] Editor type (:classic, :inline, :balloon, :decoupled, :multiroot),
-    #   defaults to preset's type if not specified
-    # @param initial_data [String] Initial content for the editor
-    # @param watchdog [Boolean] Whether to enable the CKEditor watchdog feature
-    # @param editable_height [String, Integer] Height of the editable area (Classic editor only)
-    # @param language [String] Language code for the editor UI
-    # @param html_attributes [Hash] Additional HTML attributes for the editor element
+    # Creates a CKEditor 5 editor instance in the view.
+    #
+    # @param preset [Symbol, PresetBuilder] The name of the preset or a PresetBuilder object
+    # @param config [Hash] Custom editor configuration that overrides preset configuration
+    # @param extra_config [Hash] Additional configuration to merge with preset/custom config
+    # @param type [Symbol] Editor type (:classic, :inline, :balloon, :decoupled, :multiroot)
+    # @param initial_data [String] Initial HTML content for the editor
+    # @param watchdog [Boolean] Enable/disable the editor crash recovery (default: true)
+    # @param editable_height [Integer] Set fixed height for editor in pixels
+    # @param language [Symbol] Set editor UI language (e.g. :pl, :es)
+    # @param html_attributes [Hash] Additional HTML attributes for editor element
+    #
+    # @example Basic usage with default preset
+    #   <%= ckeditor5_editor %>
+    #
+    # @example Custom preset with specific height and initial content
+    #   <%= ckeditor5_editor preset: :custom, editable_height: 300, initial_data: "<p>Hello</p>" %>
+    #
+    # @example Inline editor with custom styling
+    #   <%= ckeditor5_editor type: :inline, style: 'width: 600px' %>
+    #
+    # @example Multiroot editor with multiple editable areas
+    #   <%= ckeditor5_editor type: :multiroot do %>
+    #     <%= ckeditor5_toolbar %>
+    #     <%= ckeditor5_editable 'title', style: 'border: 1px solid gray' %>
+    #     <%= ckeditor5_editable 'content' %>
+    #   <% end %>
+    #
+    # @example Decoupled editor with custom UI layout
+    #   <%= ckeditor5_editor type: :decoupled do %>
+    #     <div class="toolbar-container">
+    #       <%= ckeditor5_toolbar %>
+    #     </div>
+    #     <div class="editor-container">
+    #       <%= ckeditor5_editable %>
+    #     </div>
+    #   <% end %>
+    #
+    # @example Editor with event handlers
+    #   <%= ckeditor5_editor oneditorchange: 'handleChange',
+    #                        oneditorready: 'handleReady',
+    #                        oneditorerror: 'handleError' %>
+    #
+    # @example Form integration
+    #   <%= form_for @post do |f| %>
+    #     <%= f.ckeditor5 :content, required: true %>
+    #   <% end %>
     def ckeditor5_editor( # rubocop:disable Metrics/ParameterLists
       preset: nil,
       config: nil, extra_config: {}, type: nil,
@@ -51,18 +85,44 @@ module CKEditor5::Rails
       tag.public_send(:'ckeditor-component', **tag_attributes, &block)
     end
+    # Creates an editable area for multiroot or decoupled editors.
+    #
+    # @param name [String] Identifier for the editable area
+    # @param kwargs [Hash] HTML attributes for the editable element
+    #
+    # @example Creating a named editable area in multiroot editor
+    #   <%= ckeditor5_editable 'content', style: 'border: 1px solid gray' %>
     def ckeditor5_editable(name = nil, **kwargs, &block)
       tag.public_send(:'ckeditor-editable-component', name: name, **kwargs, &block)
     end
+    # Creates a UI part component for the editor (toolbar, menubar).
+    #
+    # @param name [String] Name of the UI component ('toolbar', 'menuBarView')
+    # @param kwargs [Hash] HTML attributes for the UI component
+    #
+    # @example Creating a toolbar component
+    #   <%= ckeditor5_ui_part 'toolbar' %>
     def ckeditor5_ui_part(name, **kwargs, &block)
       tag.public_send(:'ckeditor-ui-part-component', name: name, **kwargs, &block)
     end
+    # Creates a toolbar component for decoupled editor.
+    #
+    # @param kwargs [Hash] HTML attributes for the toolbar element
+    #
+    # @example Creating a toolbar with custom class
+    #   <%= ckeditor5_toolbar class: 'custom-toolbar' %>
     def ckeditor5_toolbar(**kwargs)
       ckeditor5_ui_part('toolbar', **kwargs)
     end
+    # Creates a menubar component for decoupled editor.
+    #
+    # @param kwargs [Hash] HTML attributes for the menubar element
+    #
+    # @example Creating a menubar with custom styling
+    #   <%= ckeditor5_menubar style: 'margin-bottom: 10px' %>
     def ckeditor5_menubar(**kwargs)
       ckeditor5_ui_part('menuBarView', **kwargs)
     end

data/lib/ckeditor5/rails/engine.rb CHANGED Viewed

@@ -3,8 +3,6 @@
 require 'rails/engine'
 require_relative 'presets/manager'
-require_relative 'hooks/form'
 require_relative 'plugins/simple_upload_adapter'
 require_relative 'plugins/wproofreader'
@@ -30,6 +28,16 @@ module CKEditor5::Rails
       ActionView::Helpers::FormBuilder.include(Hooks::Form::FormBuilderExtension)
     end
+    initializer 'ckeditor5.importmap', after: :load_config_initializers, before: 'importmap' do |_app|
+      require_relative 'hooks/importmap'
+      ActiveSupport.on_load(:action_view) do
+        if defined?(::Importmap::ImportmapTagsHelper)
+          ::Importmap::ImportmapTagsHelper.prepend(Hooks::Importmap::ImportmapTagsHelper)
+        end
+      end
+    end
     class << self
       def base
         config.ckeditor5
@@ -45,7 +53,7 @@ module CKEditor5::Rails
       end
       def find_preset(preset)
-        return preset if preset.is_a?(CKEditor5::Rails::Presets::PresetBuilder)
+        return preset if preset.is_a?(Presets::PresetBuilder)
         base.presets[preset]
       end

data/lib/ckeditor5/rails/hooks/form.rb CHANGED Viewed

@@ -48,6 +48,50 @@ module CKEditor5::Rails::Hooks
     end
     module FormBuilderExtension
+      # Creates a CKEditor 5 field for the specified form attribute.
+      #
+      # @param method [Symbol] The model attribute to edit
+      # @param options [Hash] Options for customizing the editor
+      #
+      # @option options [Symbol] :preset (:default) The preset configuration to use
+      # @option options [Symbol] :type (:classic) Editor type (classic, inline, balloon, decoupled)
+      # @option options [Hash] :config Custom editor configuration
+      # @option options [String] :initial_data Initial content for the editor
+      # @option options [Boolean] :required (false) Whether the field is required
+      # @option options [String] :class CSS classes for the editor
+      # @option options [String] :style Inline CSS styles
+      #
+      # @example Basic usage
+      #   <%= form_for @post do |f| %>
+      #     <%= f.ckeditor5 :content %>
+      #   <% end %>
+      #
+      # @example With custom styling and required field
+      #   <%= form_for @post do |f| %>
+      #     <%= f.ckeditor5 :content,
+      #           style: 'width: 700px',
+      #           required: true,
+      #           initial_data: 'Hello World!'
+      #     %>
+      #   <% end %>
+      #
+      # @example Using custom preset and type
+      #   <%= form_for @post do |f| %>
+      #     <%= f.ckeditor5 :content,
+      #           preset: :custom,
+      #           type: :inline,
+      #           class: 'custom-editor'
+      #     %>
+      #   <% end %>
+      #
+      # @example Simple Form integration
+      #   <%= simple_form_for @post do |f| %>
+      #     <%= f.input :content,
+      #           as: :ckeditor5,
+      #           input_html: { style: 'width: 600px' },
+      #           required: true
+      #     %>
+      #   <% end %>
       def ckeditor5(method, options = {})
         EditorInputBuilder.new(object_name, object, @template)
                           .build_editor(method, options)

data/lib/ckeditor5/rails/hooks/importmap.rb ADDED Viewed

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module CKEditor5::Rails::Hooks
+  module Importmap
+    module ImportmapTagsHelper
+      def javascript_importmap_tags(entry_point = 'application', importmap: Rails.application.importmap)
+        @importmap_rendered = true
+        serialized_tags = [
+          javascript_importmap_module_preload_tags(importmap, entry_point: entry_point),
+          javascript_import_module_tag(entry_point)
+        ]
+        importmap_json = prepare_importmap_json(importmap)
+        if @__ckeditor_context.present?
+          process_ckeditor_context(serialized_tags, importmap_json)
+        else
+          serialized_tags.prepend(javascript_inline_importmap_tag(importmap_json))
+        end
+        safe_join(serialized_tags, "\n")
+      end
+      def importmap_rendered?
+        @importmap_rendered
+      end
+      private
+      def prepare_importmap_json(importmap)
+        importmap.to_json(resolver: self)
+      end
+      def process_ckeditor_context(serialized_tags, importmap_json)
+        bundle = @__ckeditor_context.fetch(:bundle)
+        merged_json = merge_ckeditor_importmap(bundle, importmap_json)
+        serialized_tags.prepend(javascript_inline_importmap_tag(merged_json))
+        serialized_tags.append(@__ckeditor_context[:html_tags])
+      end
+      def merge_ckeditor_importmap(bundle, base_importmap_json)
+        ckeditor_json = CKEditor5::Rails::Assets::AssetsImportMap.new(bundle).to_json
+        merge_import_maps_json(ckeditor_json, base_importmap_json)
+      end
+      def merge_import_maps_json(a_json, b_json)
+        a = JSON.parse(a_json)
+        b = JSON.parse(b_json)
+        a['imports'].merge!(b['imports'])
+        a.to_json
+      rescue JSON::ParserError => e
+        Rails.logger.error "Failed to merge import maps: #{e.message}"
+        b_json
+      end
+    end
+  end
+end