rails-domternal 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ff0118eed2f74446b2b4d18eae2ae42d905b3875f6bcf1dc253e116a2a10fb0
-  data.tar.gz: 355c02ba5479fa07c42242850dd03367c32d7447015deb4b2c8f4a13d265154f
+  metadata.gz: 8a3fe5a247cff03bf6c637edeccc0d1401773dce754b72e284bd547ff5b7043c
+  data.tar.gz: 695395c691f38f150cd560dde279f18ee5238d9f68ddcfdd2c8a673c8adcf69f
 SHA512:
-  metadata.gz: 7762281bd24200520b2e9612b3c7fba7ab032c65e5b6b0dcb632ab1f100f6fe5f66159a67d2cd3d5b460b73c461ea51351ecabbff9c26155507f4e77378effa1
-  data.tar.gz: a84961c1d821ae90784fb1fdb8dc75665171fae96a830a591c263bff4b85e6f538a7c8997318a0ddb776c3b3afcde3a18a6779fcdd3c51f9d7922aa957604078
+  metadata.gz: 80b0e8838e6b6ffbaae774c23c393521c9d6fa31ba64f4e3c6311580a49a0293155bd3192f16828bf9c23516b11437ab7d97672455b20ec98ba46790a9b77a2f
+  data.tar.gz: e3d28b7e185c1a95b28be8a5c0a81e037497c075e9d54bf5dac35c8c6522f6abf773a1f162cfa06de201ab19ca45eb3ca4f9acb5446282d70fe439e0c6c4596b

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.3.0 (2026-08-11)
+
+- Expose the mounted ProseMirror instance through `<domternal-editor>.editor`.
+- Expose the fixed toolbar through `<domternal-editor>.toolbar`.
+- Document the custom element's public JavaScript API and deferred-mounting behavior.

data/README.md

@@ -52,6 +52,26 @@ Configure defaults in `config/initializers/domternal.rb` (generated by the insta
 see `Rails::Domternal::Configuration` for the full list of options (default extensions,
 toolbar, theme, sanitizer allowlist, upload limits).
 
+### JavaScript API
+
+`<domternal-editor>` exposes a small public API for integrations that need to coordinate
+with the editor without depending on its internal implementation:
+
+```js
+const element = document.querySelector("domternal-editor")
+
+await element.ready()       // Mounts a deferred editor and resolves with the element.
+element.editor              // The mounted ProseMirror editor, or null before mounting.
+element.toolbar             // The fixed toolbar, or null for :notion / toolbar: false.
+element.value               // The current HTML, including the server-rendered value before mounting.
+element.input               // The linked hidden input, or null when the input is missing.
+```
+
+Call `ready()` before using `editor` or `toolbar` when the editor may still be deferred.
+The `domternal:initialize` event fires after the editor and configured toolbar have been
+created. The `domternal:change` event fires after the linked input is updated; both events
+bubble from the `<domternal-editor>` element.
+
 `#to_plain_text` converts a body to text the way ActionText does: block boundaries and
 `<br>` become newlines rather than collapsing into spaces, so line-oriented content (one
 list entry or answer per line) survives, and search columns built from rich text stay

data/app/assets/javascripts/domternal/element.js

@@ -87,6 +87,18 @@ export class DomternalEditorElement extends HTMLElement {
     return id ? document.getElementById(id) : null
   }
 
+  // Public access to the mounted ProseMirror editor. Returns null while the editor is
+  // deferred or mounting; call `await element.ready()` before using it when necessary.
+  get editor() {
+    return this._wrapper?.editor ?? null
+  }
+
+  // Public access to the fixed toolbar, when one is configured. Notion-style and
+  // toolbar-less editors return null.
+  get toolbar() {
+    return this._toolbar ?? null
+  }
+
   // The editor's current HTML. Falls back to the linked input while the editor is still
   // deferred or mounting — an unmounted editor never touches the input, so the value the
   // server rendered is still the right answer and submitting the form is always safe.

data/lib/rails/domternal/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module Domternal
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-domternal
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stefan
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile