QuillEditor class

Inheritance

Constructors

QuillEditor({required QuillController controller, required FocusNode focusNode, required ScrollController scrollController, required bool scrollable, required EdgeInsetsGeometry padding, required bool autoFocus, required bool readOnly, required bool expands, bool? showCursor, bool? paintCursorAboveText, String? placeholder, bool enableInteractiveSelection = true, bool enableSelectionToolbar = true, double scrollBottomInset = 0, double? minHeight, double? maxHeight, double? maxContentWidth, DefaultStyles? customStyles, TextCapitalization textCapitalization = TextCapitalization.sentences, Brightness keyboardAppearance = Brightness.light, ScrollPhysics? scrollPhysics, ValueChanged<String>? onLaunchUrl, bool onTapDown(TapDownDetails details, TextPosition (Offset offset))?, bool onTapUp(TapUpDetails details, TextPosition (Offset offset))?, bool onSingleLongTapStart(LongPressStartDetails details, TextPosition (Offset offset))?, bool onSingleLongTapMoveUpdate(LongPressMoveUpdateDetails details, TextPosition (Offset offset))?, bool onSingleLongTapEnd(LongPressEndDetails details, TextPosition (Offset offset))?, Iterable<EmbedBuilder>? embedBuilders, EmbedBuilder? unknownEmbedBuilder, LinkActionPickerDelegate linkActionPickerDelegate = defaultLinkActionPickerDelegate, CustomStyleBuilder? customStyleBuilder, bool floatingCursorDisabled = false, TextSelectionControls? textSelectionControls, Future<String?> onImagePaste(Uint8List imageBytes)?, Map<LogicalKeySet, Intent>? customShortcuts, Map<Type, Action<Intent>>? customActions, bool enableUnfocusOnTapOutside = true, List<String> customLinkPrefixes = const <String>[], Color? cursorColor, Key? key})
const
QuillEditor.basic({required QuillController controller, required bool readOnly, Brightness? keyboardAppearance, Iterable<EmbedBuilder>? embedBuilders, Locale? locale})
factory

Properties

autoFocus bool
Whether this editor should focus itself if nothing else is already focused.
final
controller QuillController
Controller object which establishes a link between a rich text document and this editor.
final
cursorColor Color?
光标颜色
final
customActions Map<Type, Action<Intent>>?
final
customLinkPrefixes List<String>
Additional list if links prefixes, which must not be prepended with "https://" when LinkMenuAction.launch happened
final
customShortcuts Map<LogicalKeySet, Intent>?
final
customStyleBuilder CustomStyleBuilder?
final
customStyles DefaultStyles?
final
embedBuilders Iterable<EmbedBuilder>?
final
enableInteractiveSelection bool
Whether to enable user interface affordances for changing the text selection.
final
enableSelectionToolbar bool
Whether to show the cut/copy/paste menu when selecting text.
final
enableUnfocusOnTapOutside bool
Whether focus should be revoked on tap outside the editor.
final
expands bool
Whether this editor's height will be sized to fill its parent.
final
floatingCursorDisabled bool
final
focusNode FocusNode
Controls whether this editor has keyboard focus.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance Brightness
The appearance of the keyboard.
final
linkActionPickerDelegate LinkActionPickerDelegate
Delegate function responsible for showing menu with link actions on mobile platforms (iOS, Android).
final
maxContentWidth double?
The maximum width to be occupied by the content of this editor.
final
maxHeight double?
The maximum height to be occupied by this editor.
final
minHeight double?
The minimum height to be occupied by this editor.
final
onImagePaste → (Future<String?> Function(Uint8List imageBytes)?)
Callback when the user pastes the given image.
final
onLaunchUrl ValueChanged<String>?
Callback to invoke when user wants to launch a URL.
final
onSingleLongTapEnd → (bool Function(LongPressEndDetails details, TextPosition (Offset offset))?)
final
onSingleLongTapMoveUpdate → (bool Function(LongPressMoveUpdateDetails details, TextPosition (Offset offset))?)
final
onSingleLongTapStart → (bool Function(LongPressStartDetails details, TextPosition (Offset offset))?)
final
onTapDown → (bool Function(TapDownDetails details, TextPosition (Offset offset))?)
final
onTapUp → (bool Function(TapUpDetails details, TextPosition (Offset offset))?)
final
padding EdgeInsetsGeometry
Additional space around the content of this editor.
final
paintCursorAboveText bool?
final
placeholder String?
final
readOnly bool
Whether the text can be changed.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollable bool
Whether this editor should create a scrollable container for its content.
final
scrollBottomInset double
final
scrollController ScrollController
The ScrollController to use when vertically scrolling the contents.
final
scrollPhysics ScrollPhysics?
The ScrollPhysics to use when vertically scrolling the input.
final
showCursor bool?
Whether to show cursor.
final
textCapitalization TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard.
final
textSelectionControls TextSelectionControls?
allows to create a custom textSelectionControls, if this is null a default textSelectionControls based on the app's theme will be used
final
unknownEmbedBuilder EmbedBuilder?
final

Methods

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