MarkdownWidget class Null safety

A base class for widgets that parse and display Markdown.

Supports all standard Markdown from the original Markdown specification.

See also:

Inheritance
Implementers

Constructors

MarkdownWidget({Key? key, required String data, bool selectable = false, MarkdownStyleSheet? styleSheet, MarkdownStyleSheetBaseTheme? styleSheetTheme = MarkdownStyleSheetBaseTheme.material, SyntaxHighlighter? syntaxHighlighter, MarkdownTapLinkCallback? onTapLink, VoidCallback? onTapText, String? imageDirectory, List<BlockSyntax>? blockSyntaxes, List<InlineSyntax>? inlineSyntaxes, ExtensionSet? extensionSet, MarkdownImageBuilder? imageBuilder, MarkdownCheckboxBuilder? checkboxBuilder, Map<String, MarkdownElementBuilder> builders = const {}, bool fitContent = false, MarkdownListItemCrossAxisAlignment listItemCrossAxisAlignment = MarkdownListItemCrossAxisAlignment.baseline})
Creates a 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
builders Map<String, MarkdownElementBuilder>
Render certain tags, usually used with extensionSet [...]
final
checkboxBuilder MarkdownCheckboxBuilder?
Call when build a checkbox widget.
final
data String
The Markdown to display.
final
extensionSet ExtensionSet?
Markdown syntax extension set [...]
final
fitContent bool
Whether to allow the widget to fit the child content.
final
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
imageBuilder MarkdownImageBuilder?
Call when build an image widget.
final
imageDirectory String?
The base directory holding images referenced by Img tags with local or network file paths.
final
inlineSyntaxes List<InlineSyntax>?
Collection of custom inline syntax types to be used parsing the Markdown data.
final
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
Called when the user taps a link.
final
onTapText VoidCallback?
Default tap handler used when selectable is set to true
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
selectable bool
If true, the text is selectable. [...]
final
styleSheet MarkdownStyleSheet?
The styles to use when displaying the Markdown. [...]
final
styleSheetTheme MarkdownStyleSheetBaseTheme?
Setting to specify base theme for MarkdownStyleSheet [...]
final
syntaxHighlighter SyntaxHighlighter?
The syntax highlighter used to color text in pre elements. [...]
final

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.
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. [...]
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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. [...]
@nonVirtual, inherited