@octane-xplat/tiptap 0.10.0 → 0.11.1

package/README.md

@@ -23,6 +23,62 @@ export function Notes() {
 }
 ```
 
+On web the `web` prop configures the underlying tiptap `Editor`: `extensions`
+appends caller `Extension`/`Node`/`Mark` entries after the built-in
+StarterKit, and `starterKit` takes `StarterKit.configure()` options or
+`false` to hand the schema to `extensions` entirely. A caller `starterKit`
+entry replaces the built-in instead of registering it twice. The options are
+web-only. Android and AppKit do not run caller ProseMirror extensions,
+plugins, node views, or browser menus. A passed `web` option has no effect on
+those targets.
+
+```tsx
+import { TiptapEditor } from '@octane-xplat/tiptap'
+import { Mark } from '@tiptap/core'
+
+const Spoiler = Mark.create({
+	name: 'spoiler',
+	parseHTML: () => [{ tag: 'span[data-spoiler]' }],
+	renderHTML: () => ['span', { 'data-spoiler': '' }, 0],
+})
+
+export function Notes() {
+	return <TiptapEditor web={{ extensions: [Spoiler] }} />
+}
+```
+
+## Engine and feature boundary
+
+| Target | Editing engine | `web` options | Caller extensions, plugins, and browser views |
+| --- | --- | --- | --- |
+| Web | Tiptap `Editor` + `EditorContent` | `extensions` and `starterKit` apply | Supported by the web Tiptap engine |
+| Android | WordPress Aztec `AztecText`; a DOM-free Tiptap bridge converts JSON to and from HTML | Ignored | Unsupported; no live ProseMirror view, plugin, node view, or browser menu runs |
+| iOS | Unsupported placeholder from `@octane-xplat/richtext` | Ignored | Unsupported; `supported` is `false` |
+| macOS AppKit | Bundled Tiptap editor in WKWebView | Ignored by the AppKit host | Unsupported through this facade |
+
+On Android, keep HTML as the facade's canonical interchange. Tiptap JSON is a
+best-effort conversion over Aztec HTML, not a live ProseMirror document. The
+2026-10-06 [Aztec nested-tree run](../../.agents/docs/parity/nested-tree-editor.md)
+preserved nested wrappers, attributes, and child order through synthetic text
+edits and save/reopen. It also flattened paragraphs and accumulated `<br>`
+elements on reopen; it did not qualify Tiptap JSON, OS input, or structural
+tree commands. See the [per-row capability record](../../docs/notes/editor-capabilities.md).
+
+```tsx
+import { useState } from 'octane'
+import { TiptapEditor, supported } from '@octane-xplat/tiptap'
+import { Text } from '@octane-xplat/ui'
+
+export function Notes() {
+	const [html, setHTML] = useState('<p>Travel notes</p>')
+	return supported ? (
+		<TiptapEditor value={html} editable onChange={setHTML} />
+	) : (
+		<Text>Editing is unavailable on this target</Text>
+	)
+}
+```
+
 `value`/`onChange` exchange document HTML. `getJSON`/`setJSON` exchange
 tiptap document JSON: synchronous on web, bridged on native after
 `onJSONReady(true)` — the lazy bridge reports `false` (and `getJSON()`
@@ -64,7 +120,7 @@ export function DocumentCopy() {
 }
 ```
 
-The tiptap family pins to `3.28.0` to match `@octanejs/tiptap@0.0.51` —
+The tiptap family pins to `3.28.0` to match `@octanejs/tiptap@0.0.52` —
 extension `^` ranges float ahead of core and break (`getPreviousBlockSibling`),
 so consumers should keep the workspace override. See
 [`docs/app/rich-text.md`](../../docs/app/rich-text.md) for the shared contract,
@@ -76,4 +132,4 @@ The macOS export mounts a bundled local editor document in WKWebView.
 RichText uses StarterKit; Tiptap and Lexical use their existing web facades.
 Wait for `onReady`; synchronous getters return the latest received snapshot
 and commands cross WebKit asynchronously. The `native` handle is the Swift
-host transport. See [AppKit setup and engine limits](../../docs/rich-text.md#macos-appkit-editing).
+host transport. See [AppKit setup and engine limits](../../docs/app/rich-text.md#macos-appkit-editing).