QuillHtmlEditor class
QuillHtmlEditor widget to display the quill editor,
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- QuillHtmlEditor
Constructors
- QuillHtmlEditor({String? text, required QuillEditorController controller, required double minHeight, bool isEnabled = true, dynamic onTextChanged(String)?, Color backgroundColor = Colors.white, String? hintText = 'Start typing something amazing', dynamic onFocusChanged(bool)?, VoidCallback? onEditorCreated, dynamic onSelectionChanged(SelectionModel)?, EdgeInsets? padding = EdgeInsets.zero, EdgeInsets? hintTextPadding = EdgeInsets.zero, TextAlign? hintTextAlign = TextAlign.start, dynamic onEditorResized(double)?, dynamic onEditingComplete(String)?, bool? ensureVisible = false, LoadingBuilder? loadingBuilder, InputAction? inputAction = InputAction.newline, bool? autoFocus = false, TextStyle? textStyle = const TextStyle(fontStyle: FontStyle.normal, fontSize: 20.0, color: Colors.black87, fontWeight: FontWeight.normal), TextStyle? hintTextStyle = const TextStyle(fontStyle: FontStyle.normal, fontSize: 20.0, color: Colors.black87, fontWeight: FontWeight.normal)})
- QuillHtmlEditor widget to display the quill editor, pass the controller to access the editor methods
Properties
- autoFocus → bool?
-
autoFocus Whether the widget should automatically request focus when it is inserted
into the widget tree. If set to
true, the widget will request focus immediately after being built and inserted into the tree. If set tofalse, it will not request focus automatically.final - backgroundColor → Color
-
backgroundColor to set the background color of the editor
final
- controller → QuillEditorController
-
controller to access all the methods of editor and toolbar
final
- ensureVisible → bool?
-
ensureVisible by default it will be set to false, set it to true to
make sure the focus area of the editor is visible.
Note: Please make sure to wrap the editor with SingleChildScrollView, to make the
editor scrollable.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hintText → String?
-
hintText is a placeholder, by default, the hint will be 'Description'
We can override the placeholder text by passing hintText to the editor
final
- hintTextAlign → TextAlign?
-
hintTextAlign optional style to align the editor's hint text
default value is hintTextAlign.start
final
- hintTextPadding → EdgeInsets?
-
hintTextPadding optional style to set padding to the editor's text,
default padding will be EdgeInsets.zero
final
- hintTextStyle → TextStyle?
-
hintTextStyle optional style for the hint text styepe,
while all fields in the style are not mapped;Some basic fields like,
fontStyle, fontSize, color,fontWeight can be applied
font family support is not available yet
final
- inputAction → InputAction?
-
Represents an optional input action within a specific context.
final
- isEnabled → bool
-
isEnabled as the name suggests, is used to enable or disable the editor
When it is set to false, the user cannot edit or type in the editor
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingBuilder → LoadingBuilder?
-
A builder function that provides a widget to display while the data is loading.
final
- minHeight → double
-
minHeight to define the minimum height of the editor
final
- onEditingComplete → dynamic Function(String)?
-
onEditingComplete callback function that triggers on editing completed
final
- onEditorCreated → VoidCallback?
-
onEditorCreated a callback method triggered once the editor is created
it will be called only once after editor is loaded completely
final
- onEditorResized → dynamic Function(double)?
-
onEditorResized method returns height of the widget on resize,
final
- onFocusChanged → dynamic Function(bool)?
-
onFocusChanged method returns a boolean value, if the editor has focus,
it will return true; if not, will return false
final
- onSelectionChanged → dynamic Function(SelectionModel)?
-
onSelectionChanged method returns SelectionModel, which has index and
length of the selected text
final
- onTextChanged → dynamic Function(String)?
-
onTextChanged callback function that triggers on text changed
final
- padding → EdgeInsets?
-
padding optional style to set padding to the editor's text,
default padding will be EdgeInsets.zero
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- text → String?
-
text to set initial text to the editor, please use text
We can also use the setText method for the same
final
- textStyle → TextStyle?
-
textStyle optional style for the default editor text,
while all fields in the style are not mapped;Some basic fields like,
fontStyle, fontSize, color,fontWeight can be applied
font family support is not available yet
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → QuillHtmlEditorState -
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, int wrapWidth = 65}) → 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