MarkdownPage class - about library

Constructors

MarkdownPage({Key? key, Widget? title, ScaffoldBuilder? scaffoldBuilder, String? applicationName, bool? useMustache, Map<String, String>? mustacheValues, required String filename, MarkdownTapHandler? tapHandler, MarkdownStyleSheet? styleSheet, String? imageDirectory, List<BlockSyntax>? blockSyntaxes, List<InlineSyntax>? inlineSyntaxes, ExtensionSet? extensionSet, MarkdownImageBuilder? imageBuilder, MarkdownCheckboxBuilder? checkboxBuilder, Map<String, MarkdownElementBuilder> builders = const {}, bool fitContent = true, bool selectable = false, bool shrinkWrap = true, MarkdownStyleSheetBaseTheme styleSheetTheme = MarkdownStyleSheetBaseTheme.material, SyntaxHighlighter? syntaxHighlighter}): Creates a page that shows a markdown document.
const

Properties

applicationName → String?: The name of the application.
final
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
extensionSet → ExtensionSet?: Markdown syntax extension set
final
filename → String: The markdown asset file to load
final
fitContent → bool: Whether to allow the widget to fit the child content.
final
hashCode → int: The hash code for this object.
no setterinherited
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.
finalinherited
mustacheValues → Map<String, String>?: Values to replace in the texts
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scaffoldBuilder → ScaffoldBuilder?: The builder for the Scaffold around the content.
final
selectable → bool: If true, the text is selectable.
final
shrinkWrap → bool: See ScrollView.shrinkWrap
final
styleSheet → MarkdownStyleSheet?: Defines which TextStyle objects to use for which Markdown elements.
final
styleSheetTheme → MarkdownStyleSheetBaseTheme: Setting to specify base theme for MarkdownStyleSheet
final
syntaxHighlighter → SyntaxHighlighter?: The syntax highlighter used to color text in pre elements.
final
tapHandler → MarkdownTapHandler?: The handler that handles taps on links in the template. Defaults to UrlMarkdownTapHandler.
final
title → Widget?: The screen title
final
useMustache → bool: Whether to replace {{ }} strings with mustacheValues
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → MarkdownPageState: 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.
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