muse_low_level library
Muse — advanced/internal framework API.
Use this barrel when you need to drop down to renderer/buffer primitives,
the element machinery, or render-object base classes. The API here is
stable but advanced — most apps should not need it; prefer
package:muse/muse.dart.
For raw FFI (ABI-unstable until the native library stabilizes), see
package:muse/muse_ffi.dart.
Classes
- Buffer
- High-level wrapper for OpenTUI's optimized buffer operations.
- BuildOwner
- Coordinates the build pipeline, render root, focus, and input for an app.
- CursorController
- Centralised cursor coordination for focusable widgets.
- DirectBufferAccess
- Direct access to Buffer internal arrays for performance-critical operations
- DirectTextAccess
- Read-only direct views of TextBuffer native cache arrays.
- Element
- An instantiation of a Widget at a location in the element tree.
- FlexChildData
- Data for each child in a flex layout
- FlexibleElement
- FlexibleElement type.
- FlexRenderObjectElement
- MultiChildRenderObjectElement specialised for RenderFlex parents.
- FocusAttachment
- FocusAttachment type.
- FocusManager
- FocusManager type.
- HitTestEntry
- A target and target-local position produced by hit testing.
- HitTestResult
- Result of a render-tree hit test.
- HitTestTarget
- Render object contract for pointer-event targets.
- InheritedElement
- Element that manages an InheritedWidget.
- MultiChildRenderObjectElement
- Element for RenderObjectWidgets with multiple children.
- MultiChildRenderObjectWidget
- Abstract base class for RenderObjectWidgets with multiple children
- ProxyElement
- Element backing a ProxyWidget, building its single child.
- RenderBox
- A render object that uses the box layout model.
- RenderConstrainedBox
- A render object that enforces additional constraints on its child.
- RenderDecoratedBox
- A render object that paints a Decoration.
- Renderer
- Manages the terminal rendering pipeline, including frame buffers, compositing, and output flushing.
- RenderFlex
- A render object that displays its children in a flex layout
- RenderObject
- Base class for objects in the render tree.
- RenderObjectElement
- Element for widgets that manage RenderObjects
- RenderObjectWidget
- Base class for widgets that manage RenderObjects
- RenderPadding
- A render object that applies padding to its child.
- RenderParagraph
- RenderObject that lays out inline spans and records text paint commands.
- RenderPositionedBox
- A render object that positions its child within the available space according to an alignment.
- RenderProxyBox
- A render object that forwards layout and paint to a single child.
- RenderScrollBox
- RenderObject behind ScrollBox: lays out its child unbounded along the scroll axis, then translates and clips during paint. Renders an optional 1-cell scrollbar gutter on the trailing edge.
- RenderTextArea
-
RenderBox behind TextArea. Paints the visible window of
_linesand drives cursor visibility. Scroll offsets are computed by the State before each rebuild — the render object is purely a sink. - SingleChildRenderObjectElement
- Element backing a SingleChildRenderObjectWidget.
- SingleChildRenderObjectWidget
- SingleChildRenderObjectWidget type.
- StatefulElement
- Element backing a StatefulWidget, owning its State.
- StatelessElement
- Element backing a StatelessWidget.
- TextBuffer
- High-performance text buffer with selection support, backed by native storage.
- WidgetInspectorService
- Debug inspector that snapshots the mounted element tree as text.
Enums
- Axis
- The direction of a flex layout.
Mixins
- RenderObjectWithSingleChild
- Mixin for render objects that own a single render child.
Extensions
- CursorManagement on Renderer
- Cursor-management methods added to Renderer.
- KeyboardSupport on Renderer
- Kitty keyboard protocol methods added to Renderer.
- MouseSupport on Renderer
- Mouse input methods added to Renderer.
Functions
-
describeIdentity(
Object object) → String - A short identity string: the object's runtime type plus a hex identity hash.
Typedefs
- ElementVisitor = void Function(Element element)
- Signature for callbacks that visit an Element.
- FrameCallback = void Function()
- Signature for callbacks invoked when a frame is scheduled.