Packages

ckeditor5_phoenix

1.22.0
1.28.2 1.28.1 1.28.0 1.27.2 1.27.1 1.27.0 1.26.0 1.25.1 1.25.0 1.24.2 1.24.1 1.24.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.2 1.17.1 1.17.0 1.16.1 1.16.0 1.15.8 1.15.7 1.15.6 1.15.5 1.15.4 1.15.3 1.15.2 1.15.1 1.15.0 1.14.2 1.14.1 1.14.0 1.13.0 1.12.0 1.11.0 1.10.2 1.10.1 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.4.0 1.3.0 1.2.1 1.2.0 1.1.0 1.0.8 1.0.7

CKEditor 5 integration for Phoenix Framework

HexDocs

Current section

Files

Jump to
Readme
54 Versions
8 Dependencies
Dependants
Files
Activity
ckeditor5_phoenix lib components root_value_sentinel.ex
Raw

lib/components/root_value_sentinel.ex 

defmodule CKEditor5.Components.RootValueSentinel do

  @moduledoc """

  This module defines a Phoenix component that serves as a sentinel for the root value

  of the CKEditor 5 instance in a LiveView. It renders a hidden div element that holds

  the current value of the editor, which can be used for synchronization between the client

  and server.

  """



  use Phoenix.Component



  @doc """

  Renders a hidden div element that contains the current value of the editor. This is used

  as a sentinel for the editor's root value, allowing for synchronization between the client and server.

  """



  attr :editor_id, :string,

    required: true,

    doc: "The ID for the editor instance."



  attr :value, :string,

    required: true,

    doc: "The current value of the editor."



  attr :root, :string,

    required: false,

    default: "main",

    doc:

      "The name of the root element for multi-root editors. If not provided, it defaults to 'main'."



  attr :root_attrs, :map,

    required: false,

    default: %{},

    doc:

      "A map of HTML attributes to apply to the editor root element (e.g., class, data-*, etc.)."



  def render(assigns) do

    ~H"""

    <div

      id={"#{@editor_id}_#{@root}_sentinel"}

      style="display:none"

      phx-hook="CKRootValueSentinel"

      data-cke-editor-id={@editor_id}

      data-cke-root-name={@root}

      data-cke-value={@value}

      data-cke-root-attrs={Jason.encode!(@root_attrs)}

    >

    </div>

    """

  end

end