MarkdownText class
A widget that renders Markdown content as styled ANSI text.
Uses the markdownToAnsi renderer from the artisanal core package, which
supports headings, bold, italic, code blocks, blockquotes, lists, tables,
horizontal rules, hyperlinks, and syntax highlighting.
MarkdownText(
data: '# Hello\n\nThis is **bold** and *italic*.',
maxWidth: 80,
)
- Inheritance
-
- Object
- Widget
- RenderObjectWidget
- LeafRenderObjectWidget
- MarkdownText
Constructors
- MarkdownText({required String data, AnsiRendererOptions? options, Style? textStyle, bool softWrap = true, int? maxWidth, Key? key})
Properties
-
children
→ List<
Widget> -
Child widgets that receive forwarded messages.
no setterinherited
- data → String
-
The Markdown source text to render.
final
- debugRenderObjectPassthrough → bool
-
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
- focusable → bool
-
Whether this widget can receive keyboard focus.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Unique identifier for this widget.
no setterinherited
- key → Key?
-
Key for preserving widget identity.
finalinherited
- maxWidth → int?
-
Maximum width in columns for rendered output.
final
- options → AnsiRendererOptions?
-
Optional rendering options for the ANSI renderer.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- softWrap → bool
-
Whether to soft-wrap text output.
final
- textStyle → Style?
-
Style for normal body/paragraph text.
final
- theme → Theme
-
Access the current theme.
no setterinherited
Methods
-
buildCachedView<
T> (T builder(), Object? cacheKey) → T -
Returns a cached view if the cache key matches.
inherited
-
createRenderObject(
) → RenderObject -
override
-
didUnmountRenderObject(
RenderObject renderObject) → void -
inherited
-
handleInit(
) → Cmd? -
Override this instead of init for widget-specific initialization.
inherited
-
handleIntercept(
Msg msg) → (Widget, Cmd?) -
Override this to handle messages before they reach children.
inherited
-
handleUpdate(
Msg msg) → (Widget, Cmd?) -
Override this to handle messages specific to this widget.
inherited
-
init(
) → Cmd? -
Called once when the widget is first mounted.
inherited
-
invalidateCachedView(
) → void -
Clears any cached view for this widget.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
Msg msg) → (Model, Cmd?) -
Handles messages by forwarding to children then calling handleUpdate.
inherited
-
updateRenderObject(
RenderObject renderObject) → void -
override
-
view(
) → Object -
Renders the widget to a string or View.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited