SelectableHtml class

Inheritance

Constructors

SelectableHtml({Key? key, GlobalKey<State<StatefulWidget>>? anchorKey, required String? data, OnTap? onLinkTap, OnTap? onAnchorTap, OnCssParseError? onCssParseError, bool shrinkWrap = false, Map<String, Style> style = const {}, Map<CustomRenderMatcher, SelectableCustomRender> customRenders = const {}, List<String> tagsList = const [], TextSelectionControls? selectionControls, ScrollPhysics? scrollPhysics})
The SelectableHtml widget takes HTML as input and displays a RichText tree of the parsed HTML content (which is selectable)
SelectableHtml.fromDom({Key? key, GlobalKey<State<StatefulWidget>>? anchorKey, @required Document? document, OnTap? onLinkTap, OnTap? onAnchorTap, OnCssParseError? onCssParseError, bool shrinkWrap = false, Map<String, Style> style = const {}, Map<CustomRenderMatcher, SelectableCustomRender> customRenders = const {}, List<String> tagsList = const [], TextSelectionControls? selectionControls, ScrollPhysics? scrollPhysics})
SelectableHtml.fromElement({Key? key, GlobalKey<State<StatefulWidget>>? anchorKey, @required Element? documentElement, OnTap? onLinkTap, OnTap? onAnchorTap, OnCssParseError? onCssParseError, bool shrinkWrap = false, Map<String, Style> style = const {}, Map<CustomRenderMatcher, SelectableCustomRender> customRenders = const {}, List<String> tagsList = const [], TextSelectionControls? selectionControls, ScrollPhysics? scrollPhysics})

Properties

customRenders Map<CustomRenderMatcher, SelectableCustomRender>
Either return a custom widget for specific node types or return null to fallback to the default rendering.
final
data String?
The HTML data passed to the widget as a String
final
documentElement → Element?
The HTML data passed to the widget as a pre-processed dom.Element
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onAnchorTap OnTap?
A function that defines what to do when an anchor link is tapped. When this value is set, the default anchor behaviour is overwritten.
final
onCssParseError OnCssParseError?
A function that defines what to do when CSS fails to parse
final
onLinkTap OnTap?
A function that defines what to do when a link is tapped
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollPhysics ScrollPhysics?
Allows you to override the default scrollPhysics for SelectableText.rich
final
selectionControls TextSelectionControls?
Custom Selection controls allows you to override default toolbar and build custom toolbar options
final
shrinkWrap bool
A parameter that should be set when the HTML widget is expected to be have a flexible width, that doesn't always fill its maximum width constraints. For example, auto horizontal margins are ignored, and block-level elements only take up the width they need.
final
style Map<String, Style>
An API that allows you to override the default style for any HTML element
final
tagsList List<String>
A list of HTML tags that are the only tags that are rendered. By default, this list is empty and all supported HTML tags are rendered.
final

Methods

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

Static Properties

tags List<String>
no setter