MarkdownBody class

A non-scrolling widget that parses and displays Markdown.

Supports all GitHub Flavored Markdown from the specification.

See also:

• Markdown, which is a scrolling container of Markdown.
• github.github.com/gfm/

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• MarkdownWidget
• MarkdownBody

Constructors

MarkdownBody({Key? key, required String data, bool selectable = false, MarkdownStyleSheet? styleSheet, MarkdownStyleSheetBaseTheme? styleSheetTheme, SyntaxHighlighter? syntaxHighlighter, MarkdownTapLinkCallback? onTapLink, VoidCallback? onTapText, String? imageDirectory, List<BlockSyntax>? blockSyntaxes, List<InlineSyntax>? inlineSyntaxes, ExtensionSet? extensionSet, MarkdownImageBuilder? imageBuilder, MarkdownCheckboxBuilder? checkboxBuilder, MarkdownBulletBuilder? bulletBuilder, Map<String, MarkdownElementBuilder> builders = const <String, MarkdownElementBuilder>{}, MarkdownListItemCrossAxisAlignment listItemCrossAxisAlignment = MarkdownListItemCrossAxisAlignment.baseline, bool shrinkWrap = true, bool fitContent = true})

Creates a non-scrolling widget that parses and displays Markdown.

const

Properties

blockSyntaxes → List<BlockSyntax>?

Collection of custom block syntax types to be used parsing the Markdown data.

final, inherited

builders → Map<String, MarkdownElementBuilder>

Render certain tags, usually used with extensionSet

final, inherited

bulletBuilder → MarkdownBulletBuilder?

Called when building a bullet

final, inherited

checkboxBuilder → MarkdownCheckboxBuilder?

Call when build a checkbox widget.

final, inherited

data → String

The Markdown to display.

final, inherited

extensionSet → ExtensionSet?

Markdown syntax extension set

final, inherited

fitContent → bool

Whether to allow the widget to fit the child content.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

imageBuilder → MarkdownImageBuilder?

Call when build an image widget.

final, inherited

imageDirectory → String?

The base directory holding images referenced by Img tags with local or network file paths.

final, inherited

inlineSyntaxes → List<InlineSyntax>?

Collection of custom inline syntax types to be used parsing the Markdown data.

final, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

listItemCrossAxisAlignment → MarkdownListItemCrossAxisAlignment

Controls the cross axis alignment for the bullet and list item content in lists.

final, inherited

onTapLink → MarkdownTapLinkCallback?

Called when the user taps a link.

final, inherited

onTapText → VoidCallback?

Default tap handler used when selectable is set to true

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectable → bool

If true, the text is selectable.

final, inherited

shrinkWrap → bool

See ScrollView.shrinkWrap

final

styleSheet → MarkdownStyleSheet?

The styles to use when displaying the Markdown.

final, inherited

styleSheetTheme → MarkdownStyleSheetBaseTheme?

Setting to specify base theme for MarkdownStyleSheet

final, inherited

syntaxHighlighter → SyntaxHighlighter?

The syntax highlighter used to color text in pre elements.

final, inherited

Methods

build(BuildContext context, List<Widget>? children) → Widget

Subclasses should override this function to display the given children, which are the parsed representation of data.

override

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → _MarkdownWidgetState

Creates the mutable state for this widget at a given location in the tree.

inherited

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited