flutter/ui/markdown/widget/all library
Classes
- BlockquoteConfig
- config class for Block quotes, tag: blockquote
- BlockquoteNode
- Tag: MarkdownTag.blockquote
- BrNode
- Tag: MarkdownTag.br
- CheckBoxConfig
- config class for checkbox, tag: input
- CodeBlockNode
- Tag: MarkdownTag.pre
- CodeConfig
- config class for code, tag: code
- CodeNode
- Tag: MarkdownTag.code the code textSpan
- ConcreteElementNode
- the default concrete node for ElementNode
- DelNode
- Tag: MarkdownTag.del
- ElementNode
- this node will accept other MarkdownSpanNodeGeneralFrameworkWidget as children
- EmNode
- Tag: MarkdownTag.em
- H1Config
- config class for h1
- H2Config
- config class for h2
- H3Config
- config class for h3
- H4Config
- config class for h4
- H5Config
- config class for h5
- H6Config
- config class for h6
- HeadingConfig
- config class for heading
- HeadingDivider
- only support h1 and h2
- HeadingNode
- Tag: MarkdownTag.h1 ~ MarkdownTag.h6
- HorizontalRulesConfig
- config class for HorizontalRulesNode
- HorizontalRulesNode
- Tag: MarkdownTag.hr
- ImageNode
- Tag: MarkdownTag.img
- ImageViewer
- show image with InteractiveViewer
- ImgConfig
- config class for image, tag: img
- InputNode
- Tag: MarkdownTag.input
- LinkConfig
- config class for link, tag: a
- LinkNode
- Tag: MarkdownTag.a
- ListConfig
- config class for list, tag: li
- ListNode
- Tag MarkdownTag.li
- MarkdownBlockGeneralFrameworkWidget
- use MarkdownBlockGeneralFrameworkWidget to build markdown by Column it does not support scrolling by default, but it will adapt to the width automatically.
- MarkdownGeneralFrameworkWidget
- UncompleteDocumentation
- MarkdownGeneralFrameworkWidgetState
- UncompleteDocumentation
- MarkdownProxyRichTextGeneralFrameworkWidget
-
use MarkdownProxyRichTextGeneralFrameworkWidget to give
textScaleFactora default value - MarkdownSpanNodeGeneralFrameworkWidget
- the basic node
- MarkdownSpanNodeGeneralFrameworkWidgetGeneratorWithTag
- use MarkdownSpanNodeGeneralFrameworkWidgetGeneratorWithTag that you can custom your own MarkdownSpanNodeGeneralFrameworkWidgetGenerator with tag
- MCheckBox
- the check box widget
- ParagraphMarkdownConfig
- config class for paragraphs, tag: p
- ParagraphNode
- Tag: MarkdownTag.p
- PreConfig
- config class for pre
- StrongNode
- Tag: MarkdownTag.strong
- TableConfig
- UncompleteDocumentation
- TableNode
- UncompleteDocumentation
- TBodyNode
- UncompleteDocumentation
- TdNode
- UncompleteDocumentation
- TextNode
- text node only displays text
- THeadNode
- UncompleteDocumentation
- ThNode
- UncompleteDocumentation
- TrNode
- UncompleteDocumentation
- UlOrOLNode
- Tag MarkdownTag.ol、MarkdownTag.ul
- WidgetVisitor
- use WidgetVisitor that can transform MarkdownNode to MarkdownSpanNodeGeneralFrameworkWidgets and you can use MarkdownSpanNodeGeneralFrameworkWidget with Text.rich or RichText to get widget
Functions
-
convertHiNodes(
List< Node> nodes, Map<String, TextStyle> theme, TextStyle? style, TextStyle? styleNotMatched) → List<TextSpan> - UncompleteDocumentation
-
getDefaultMarker(
bool isOrdered, int depth, Color? color, int index, double paddingTop, MarkdownConfigGeneralFramework config) → Widget - get default marker for list
-
highLightSpans(
String input, {String? language, bool autoDetectionLanguage = false, Map< String, TextStyle> theme = const {}, TextStyle? textStyle, TextStyle? styleNotMatched, int tabSize = 8}) → List<InlineSpan> - transform code to highlight code
-
wrapByAutoScroll(
int index, Widget child, AutoScrollController controller) → Widget -
wrap widget by
AutoScrollTagthat can useAutoScrollControllerto scrollToIndex
Typedefs
- CheckBoxBuilder = Widget Function(bool checked)
- define a function to return a checkbox widget
- CodeBuilder = Widget Function(String code, String language)
- UncompleteDocumentation
- CodeWrapper = Widget Function(Widget child, String code, String language)
- UncompleteDocumentation
- ErrorImgBuilder = Widget Function(String url, String alt, Object error)
- UncompleteDocumentation
-
ImgBuilder
= Widget Function(String url, Map<
String, String> attributes) - UncompleteDocumentation
- ListMarker = Widget? Function(bool isOrdered, int depth, int index)
- the function to get marker widget
- MarkdownSpanNodeGeneralFrameworkWidgetAcceptCallback = void Function(MarkdownSpanNodeGeneralFrameworkWidget node, int nodeIndex)
-
when a
SpanNopeis visited, this callback will be triggered - MarkdownSpanNodeGeneralFrameworkWidgetGenerator = MarkdownSpanNodeGeneralFrameworkWidget Function(Element e, MarkdownConfigGeneralFramework config, WidgetVisitor visitor)
- use MarkdownSpanNodeGeneralFrameworkWidgetGenerator will return a MarkdownSpanNodeGeneralFrameworkWidget
- TextNodeGenerator = MarkdownSpanNodeGeneralFrameworkWidget? Function(Node node, MarkdownConfigGeneralFramework config, WidgetVisitor visitor)
- use TextNodeGenerator to custom your own TextNode
- WidgetWrapper = Widget Function(Widget child)
-
wrap
childby another widget