HtmlEditor class

The full HTML editor widget.

It contains the editor's text field where the user can insert the text, aswell as the toolbar.

Inheritance

Constructors

HtmlEditor({Key? key, String? hint, ResizeMode resizeMode = ResizeMode.resizeToParent, HtmlEditorController? controller, InAppWebViewSettings? inAppWebViewSettings, bool? spellCheck, List<String>? customOptions, Future<bool> allowUrlLoading(Uri? uri)?, VoidCallback? onInit, VoidCallback? onFocus, VoidCallback? onBlur, ValueChanged<HtmlEditorFile>? onImageUpload, ValueChanged<HtmlEditorUploadError>? onImageUploadError, ValueChanged<int>? onKeyup, ValueChanged<int>? onKeydown, VoidCallback? onMouseUp, VoidCallback? onMouseDown, ValueChanged<String>? onChange, ValueChanged<String>? onUrlPressed, String cssBuilder(String css, ThemeData themeData)?, String jsInitBuilder(String js)?})
const

Properties

allowUrlLoading → (Future<bool> Function(Uri? uri)?)
If the editor should allow the default behavior for url handling when the user clicks/taps on one.
final
controller HtmlEditorController?
The controller for the HTML editor.
final
cssBuilder → (String Function(String css, ThemeData themeData)?)
Used to build custom CSS code for the editor.
final
customOptions List<String>?
List of custom options to be added to the summernote initialiser.
final
hashCode int
The hash code for this object.
no setterinherited
hint String?
The hint to display when the editor is empty.
final
inAppWebViewSettings → InAppWebViewSettings?
The initial options for the InAppWebViewSettings used only on mobile platforms.
final
jsInitBuilder → (String Function(String js)?)
Used to build custom JavaScript code for initialising Summernote editor.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onBlur VoidCallback?
Callback to be called when the editor loses focus.
final
onChange ValueChanged<String>?
Callback to be called when the user changes the text in the editor.
final
onFocus VoidCallback?
Callback to be called when the editor gains focus.
final
onImageUpload ValueChanged<HtmlEditorFile>?
Callback to be called when the user inserts an image.
final
onImageUploadError ValueChanged<HtmlEditorUploadError>?
Callback to be called when an error occurs while uploading an image.
final
onInit VoidCallback?
Callback to be called when the editor is initialized.
final
onKeydown ValueChanged<int>?
Callback to be called when a key is pressed.
final
onKeyup ValueChanged<int>?
Callback to be called when a key is released.
final
onMouseDown VoidCallback?
Callback to be called when the user releases the mouse button while the cursor is in editor.
final
onMouseUp VoidCallback?
Callback to be called when the user presses the mouse button while the cursor is in editor.
final
onUrlPressed ValueChanged<String>?
Callback to be called when the taps/clicks a url inside the editor.
final
resizeMode ResizeMode
Defines the resize mode of the editor.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
spellCheck bool?
If the spell check should be enabled.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's 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