Expand description
ratatui widget + RPC handler for embedding an orzma webview.
Run inside an orzma pane: Orzma::connect dials $ORZMA_SOCK, Webview
registers content (minting a handle), WebviewWidget renders it as a
ratatui widget, and OrzmaBackend (wrapping the terminal backend) emits the
mount APC verb during each draw — no separate flush call.
Structs§
- Focus
Change - A change of webview focus the host reported for one placement.
- Frame
Placements - The per-frame collector handed to the
crate::WebviewWidgetas its state. - Handle
Id - The opaque identity of one registration, as minted by the control plane.
- KeyChord
- A modifier chord a webview lets through to the app while focused.
- Orzma
- An orzma session: owns the control-socket connection and reader thread.
- Orzma
Backend - A ratatui
Backendthat wraps another backend and emits orzma webview mount/unmount verbs after each frame’s cell diff — so an app needs no separate post-draw flush call. - RpcError
- An error returned by an RPC handler, surfaced to the page as a rejected Promise.
- Webview
- A webview definition: content plus RPC handlers, before registration.
- Webview
Default Placeholder - A no-op fallback widget (the default): renders nothing.
- Webview
Handle - A registered webview: emit events to its page(s), drive its default placement, mint further placements, and read the two ids it is addressed by.
- Webview
Instance - One extra placement of a registration, minted by
WebviewHandle::new_instance. - Webview
Widget - A ratatui widget that mounts an orzma webview at its area.
Enums§
- Orzma
Error - An error from the ratatui_orzma SDK.
Type Aliases§
- Orzma
Result - A
Resultwhose error isOrzmaError.