QuillEditorConfig class

The configuration of the editor widget.

Annotations

Constructors

QuillEditorConfig.new({bool scrollable = true, EdgeInsetsGeometry padding = EdgeInsets.zero, @experimental List<CharacterShortcutEvent> characterShortcutEvents = const [], @experimental List<SpaceShortcutEvent> spaceShortcutEvents = const [], bool autoFocus = false, bool expands = false, String? placeholder, bool? checkBoxReadOnly, bool disableClipboard = false, TextSelectionThemeData? textSelectionThemeData, bool? showCursor, bool? paintCursorAboveText, bool enableInteractiveSelection = true, bool enableSelectionToolbar = true, double scrollBottomInset = 0, double? minHeight, double? maxHeight, double? maxContentWidth, DefaultStyles? customStyles, TextCapitalization textCapitalization = TextCapitalization.sentences, Brightness? keyboardAppearance, 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))?, @experimental KeyEventResult? onKeyPressed(KeyEvent event, Node? node)?, bool enableAlwaysIndentOnTab = false, Iterable<EmbedBuilder>? embedBuilders, TextSpanBuilder textSpanBuilder = defaultSpanBuilder, QuillMagnifierBuilder? quillMagnifierBuilder, EmbedBuilder? unknownEmbedBuilder, @experimental QuillSearchConfig searchConfig = const QuillSearchConfig(), LinkActionPickerDelegate linkActionPickerDelegate = defaultLinkActionPickerDelegate, CustomStyleBuilder? customStyleBuilder, CustomRecognizerBuilder? customRecognizerBuilder, bool floatingCursorDisabled = false, TextSelectionControls? textSelectionControls, Map<ShortcutActivator, Intent>? customShortcuts, Map<Type, Action<Intent>>? customActions, bool detectWordBoundary = true, bool onTapOutsideEnabled = true, dynamic onTapOutside(PointerDownEvent event, FocusNode focusNode)?, List<String> customLinkPrefixes = const <String>[], QuillDialogTheme? dialogTheme, ContentInsertionConfiguration? contentInsertionConfiguration, QuillEditorContextMenuBuilder? contextMenuBuilder, GlobalKey<EditorState>? editorKey, bool requestKeyboardFocusOnCheckListChanged = false, TextInputAction textInputAction = TextInputAction.newline, bool enableScribble = false, void onScribbleActivated()?, EdgeInsets? scribbleAreaInsets, MouseCursor readOnlyMouseCursor = SystemMouseCursors.text, void onPerformAction(TextInputAction action)?, @experimental LeadingBlockNodeBuilder? customLeadingBlockBuilder})
const

Properties

autoFocus → bool
Whether this editor should focus itself if nothing else is already focused.
final
characterShortcutEvents → List<CharacterShortcutEvent>
Contains all the events that will be handled when the exact characters satifies the condition. This mean if you press asterisk key, if you have a CharacterShortcutEvent with the asterisk then that event will be handled
final
checkBoxReadOnly → bool?
Override readOnly for checkbox.
final
contentInsertionConfiguration → ContentInsertionConfiguration?
Configuration of handler for media content inserted via the system input method.
final
contextMenuBuilder → QuillEditorContextMenuBuilder?
final
customActions → Map<Type, Action<Intent>>?
Contains user-defined actions.
final
customLeadingBlockBuilder → LeadingBlockNodeBuilder?
final
customLinkPrefixes → List<String>
Link prefixes that are addations to linkPrefixes, which are used on link launch LinkMenuAction.launch to check whether a link is valid.
final
customRecognizerBuilder → CustomRecognizerBuilder?
final
customShortcuts → Map<ShortcutActivator, Intent>?
Contains user-defined shortcuts map.
final
customStyleBuilder → CustomStyleBuilder?
final
customStyles → DefaultStyles?
Allows to override DefaultStyles.
final
detectWordBoundary → bool
final
dialogTheme → QuillDialogTheme?
Configures the dialog theme.
final
disableClipboard → bool
Disable Clipboard features
final
editorKey → GlobalKey<EditorState>?
Using the editorKey for get getLocalRectForCaret editorKey.currentState?.renderEditor.getLocalRectForCaret
final
embedBuilders → Iterable<EmbedBuilder>?
final
enableAlwaysIndentOnTab → bool
Enables always indenting when the TAB key is pressed.
final
enableInteractiveSelection → bool
Whether to enable user interface affordances for changing the text selection.
final
enableScribble → bool
Enable Scribble? Currently Apple Pencil only, defaults to false.
final
enableSelectionToolbar → bool
Whether to show the cut/copy/paste menu when selecting text.
final
expands → bool
Whether this editor's height will be sized to fill its parent.
final
floatingCursorDisabled → bool
final
hashCode → int
The hash code for this object.
no setterinherited
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
onKeyPressed → KeyEventResult? Function(KeyEvent event, Node? node)?
A handler for keys that are pressed when the editor is focused.
final
onLaunchUrl → ValueChanged<String>?
Callback to invoke when user wants to launch a URL.
final
onPerformAction → void Function(TextInputAction action)?
Called when a text input action is performed.
final
onScribbleActivated → void Function()?
Called when Scribble is activated.
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
onTapOutside → dynamic Function(PointerDownEvent event, FocusNode focusNode)?
By default on non-mobile platforms, the editor will unfocus.
final
onTapOutsideEnabled → bool
Whether the onTapOutside should be triggered or not.
final
onTapUp → bool Function(TapUpDetails details, TextPosition (Offset offset))?
final
padding → EdgeInsetsGeometry
Additional space around the content of this editor. by default will be EdgeInsets.zero
final
paintCursorAboveText → bool?
final
placeholder → String?
The text placeholder in the quill editor
final
quillMagnifierBuilder → QuillMagnifierBuilder?
To add a magnifier when selecting, specify a builder that returns the magnfier widget
final
readOnlyMouseCursor → MouseCursor
The readOnlyMouseCursor is used for Windows, macOS when readOnly is true
final
requestKeyboardFocusOnCheckListChanged → bool
When there is a change the check list values should we request keyboard focus??
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scribbleAreaInsets → EdgeInsets?
Optional insets for the scribble area.
final
scrollable → bool
Whether this editor should create a scrollable container for its content.
final
scrollBottomInset → double
final
scrollPhysics → ScrollPhysics?
The ScrollPhysics to use when vertically scrolling the input.
final
searchConfig → QuillSearchConfig
See search page for docs.
final
showCursor → bool?
Whether to show cursor.
final
spaceShortcutEvents → List<SpaceShortcutEvent>
Contains all the events that will be handled when space key is pressed
final
textCapitalization → TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard.
final
textInputAction → TextInputAction
Default to TextInputAction.newline
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
textSelectionThemeData → TextSelectionThemeData?
By default we will use
final
textSpanBuilder → TextSpanBuilder
final
unknownEmbedBuilder → EmbedBuilder?
final

Methods

copyWith({LeadingBlockNodeBuilder? customLeadingBlockBuilder, String? placeholder, List<CharacterShortcutEvent>? characterShortcutEvents, List<SpaceShortcutEvent>? spaceShortcutEvents, bool? checkBoxReadOnly, bool? disableClipboard, bool? scrollable, double? scrollBottomInset, bool? enableAlwaysIndentOnTab, EdgeInsetsGeometry? padding, bool? autoFocus, bool? onTapOutsideEnabled, dynamic onTapOutside(PointerDownEvent event, FocusNode focusNode)?, KeyEventResult? onKeyPressed(KeyEvent event, Node? node)?, bool? showCursor, bool? paintCursorAboveText, MouseCursor? readOnlyMouseCursor, bool? enableInteractiveSelection, bool? enableSelectionToolbar, double? minHeight, double? maxHeight, double? maxContentWidth, DefaultStyles? customStyles, bool? expands, TextCapitalization? textCapitalization, Brightness? keyboardAppearance, ScrollPhysics? scrollPhysics, ValueChanged<String>? onLaunchUrl, bool onTapDown(TapDownDetails details, TextPosition (Offset offset))?, bool onTapUp(TapUpDetails details, TextPosition (Offset offset))?, Iterable<EmbedBuilder>? embedBuilders, TextSpanBuilder? textSpanBuilder, EmbedBuilder? unknownEmbedBuilder, CustomStyleBuilder? customStyleBuilder, CustomRecognizerBuilder? customRecognizerBuilder, QuillSearchConfig? searchConfig, LinkActionPickerDelegate? linkActionPickerDelegate, bool? floatingCursorDisabled, TextSelectionControls? textSelectionControls, Map<ShortcutActivator, Intent>? customShortcuts, Map<Type, Action<Intent>>? customActions, bool? detectWordBoundary, List<String>? customLinkPrefixes, QuillDialogTheme? dialogTheme, QuillEditorContextMenuBuilder? contextMenuBuilder, ContentInsertionConfiguration? contentInsertionConfiguration, GlobalKey<EditorState>? editorKey, TextSelectionThemeData? textSelectionThemeData, bool? requestKeyboardFocusOnCheckListChanged, TextInputAction? textInputAction, bool? enableScribble, void onScribbleActivated()?, EdgeInsets? scribbleAreaInsets, void onPerformAction(TextInputAction action)?}) → QuillEditorConfig
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited