Markdown class

A scrolling widget that parses and displays Markdown.

Supports all GitHub Flavored Markdown from the specification.

See also:

Inheritance

Constructors

Markdown({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, EdgeInsets padding = const EdgeInsets.all(16.0), ScrollController? controller, ScrollPhysics? physics, bool shrinkWrap = false})
Creates a 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.
finalinherited
builders Map<String, MarkdownElementBuilder>
Render certain tags, usually used with extensionSet
finalinherited
bulletBuilder MarkdownBulletBuilder?
Called when building a bullet
finalinherited
checkboxBuilder MarkdownCheckboxBuilder?
Call when build a checkbox widget.
finalinherited
controller ScrollController?
An object that can be used to control the position to which this scroll view is scrolled.
final
data String
The Markdown to display.
finalinherited
extensionSet → ExtensionSet?
Markdown syntax extension set
finalinherited
fitContent bool
Whether to allow the widget to fit the child content.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
imageBuilder MarkdownImageBuilder?
Call when build an image widget.
finalinherited
imageDirectory String?
The base directory holding images referenced by Img tags with local or network file paths.
finalinherited
inlineSyntaxes List<InlineSyntax>?
Collection of custom inline syntax types to be used parsing the Markdown data.
finalinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listItemCrossAxisAlignment MarkdownListItemCrossAxisAlignment
Controls the cross axis alignment for the bullet and list item content in lists.
finalinherited
Called when the user taps a link.
finalinherited
onTapText VoidCallback?
Default tap handler used when selectable is set to true
finalinherited
padding EdgeInsets
The amount of space by which to inset the children.
final
physics ScrollPhysics?
How the scroll view should respond to user input.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectable bool
If true, the text is selectable.
finalinherited
shrinkWrap bool
Whether the extent of the scroll view in the scroll direction should be determined by the contents being viewed.
final
styleSheet MarkdownStyleSheet?
The styles to use when displaying the Markdown.
finalinherited
styleSheetTheme MarkdownStyleSheetBaseTheme?
Setting to specify base theme for MarkdownStyleSheet
finalinherited
syntaxHighlighter SyntaxHighlighter?
The syntax highlighter used to color text in pre elements.
finalinherited

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