lexxy 0.1.8.beta → 0.1.10.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5d2b0484ac9aad5019fd912a29090835732381b605e9738ed7d53ee92c30ae6
-  data.tar.gz: 5f4d8f87542fa4af872eda21776c0af69e504b7ca1aa6e9139d510b5b23d214b
+  metadata.gz: 2fffdc9d43469a6366a3d6fa16b6e5b8284c5a19bdcfa3cbffeb79a96cf16970
+  data.tar.gz: b1e76d677c2c7e9c55ff713eba32c89f04cc0e267153f4e4def7cf48238dc733
 SHA512:
-  metadata.gz: b0ed0fd1d053b8d4a88362120f2bb21ab3a79ef7f24e0a0b24fcb59f6b4e40a9b90c53329150b4b4f39370bff9556781c2b679d2c667800f7a3de2e6d7f922fc
-  data.tar.gz: 5fbe5195dbc24bf382aad7c51d76108eb7be0903819bf10f2b59014ddd062fe18d133d36314511868526217603588774d7a0b12719529cf59acab24f3b82654f
+  metadata.gz: 0c7752a992efceb4f40f411bb154037a21b7ffeb83db7dc28bf882f68ed2ff57f21ebe4c1d61dc420d6b344fd45fb8d819595a753e33d90134a8e3536d6fd0ba
+  data.tar.gz: 761ce9eee667c72a4cab67a5572cad3013f468c9248f415477c144b640a26852400c07afcdbe287afe492f858d54a798281ac96c89814fd69683f3ecd4488d77

data/README.md

@@ -341,9 +341,84 @@ The sandbox app is available at http://localhost:3000. There is also a CRUD exam
 
 ## Events
 
-* `lexxy:initialize`: Fired whenever the `<lexxy-editor>` element is attached to the DOM and is ready for use.
-* `lexxy:change`: Fired whenever the editor content changes.
-* `lexxy:file-accept`: Fired whenever a file is dropped or inserted into the editor. You can access the `File` object through the `event.detail.file` property. Call `preventDefault` on the event to cancel upload and prevent attaching the file.
+Lexxy fires a handful of custom events that you can hook into.
+Each event is dispatched on the `<lexxy-editor>` element.
+
+### `lexxy:initialize`
+
+Fired when the `<lexxy-editor>` element is attached to the DOM and ready for use.
+This is useful for one-time setup.
+
+### `lexxy:change`
+
+Fired whenever the editor content changes.
+You can use this to sync the editor state with your application.
+
+### `lexxy:file-accept`
+
+Fired when a file is dropped or inserted into the editor.
+
+- Access the file via `event.detail.file`.
+- Call `event.preventDefault()` to cancel the upload and prevent attaching the file.
+
+### `lexxy:insert-link`
+
+Fired when a plain text link is pasted into the editor.
+Access the link’s URL via `event.detail.url`.
+
+You also get a handful of callback helpers on `event.detail`:
+
+- **`replaceLinkWith(html, options)`** – replace the pasted link with your own HTML.
+- **`insertBelowLink(html, options)`** – insert custom HTML below the link.
+- **Attachment rendering** – pass `{ attachment: true }` in `options` to render as non-editable content,
+  or `{ attachment: { sgid: "your-sgid-here" } }` to provide a custom SGID.
+
+#### Example: Link Unfurling with Stimulus
+
+When a user pastes a link, you may want to turn it into a preview or embed.
+Here’s a Stimulus controller that sends the URL to your app, retrieves metadata,
+and replaces the plain text link with a richer version:
+
+```javascript
+// app/javascript/controllers/link_unfurl_controller.js
+import { Controller } from "@hotwired/stimulus"
+import { post } from "@rails/request.js"
+
+export default class extends Controller {
+  static values = {
+    url: String, // endpoint that handles unfurling
+  }
+
+  unfurl(event) {
+    this.#unfurlLink(event.detail.url, event.detail)
+  }
+
+  async #unfurlLink(url, callbacks) {
+    const { response } = await post(this.urlValue, {
+      body: JSON.stringify({ url }),
+      headers: {
+        "Content-Type": "application/json",
+        "Accept": "application/json"
+      }
+    })
+
+    const metadata = await response.json()
+    this.#insertUnfurledLink(metadata, callbacks)
+  }
+
+  #insertUnfurledLink(metadata, callbacks) {
+    // Replace the pasted link with your custom HTML
+    callbacks.replaceLinkWith(this.#renderUnfurledLinkHTML(metadata))
+
+    // Or, insert below the link as an attachment:
+    // callbacks.insertBelowLink(this.#renderUnfurledLinkHTML(metadata), { attachment: true })
+  }
+
+  #renderUnfurledLinkHTML(link) {
+    return `<a href="${link.canonical_url}">${link.title}</a>`
+  }
+}
+```
 
 ## Contributing