QuillEditorConfigurations class

The configurations for the quill editor widget of flutter quill

Annotations

Constructors

QuillEditorConfigurations({required QuillController controller, QuillSharedConfigurations sharedConfigurations = const QuillSharedConfigurations(), bool scrollable = true, EdgeInsetsGeometry padding = EdgeInsets.zero, bool autoFocus = false, bool expands = false, String? placeholder, bool readOnly = false, 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 = 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, CustomRecognizerBuilder? customRecognizerBuilder, bool floatingCursorDisabled = false, TextSelectionControls? textSelectionControls, Future<String?> onImagePaste(Uint8List imageBytes)?, Future<String?> onGifPaste(Uint8List imageBytes)?, Map<ShortcutActivator, Intent>? customShortcuts, Map<Type, Action<Intent>>? customActions, bool detectWordBoundary = true, bool isOnTapOutsideEnabled = true, dynamic onTapOutside(PointerDownEvent event, FocusNode focusNode)?, List<String> customLinkPrefixes = const <String>[], QuillDialogTheme? dialogTheme, ContentInsertionConfiguration? contentInsertionConfiguration, QuillEditorContextMenuBuilder? contextMenuBuilder, GlobalKey<EditorState>? editorKey, bool requestKeyboardFocusOnCheckListChanged = false, QuillEditorElementOptions elementOptions = const QuillEditorElementOptions(), QuillEditorBuilder? builder, TextMagnifierConfiguration? magnifierConfiguration, TextInputAction textInputAction = TextInputAction.newline, bool enableScribble = false, void onScribbleActivated()?, EdgeInsets? scribbleAreaInsets})
Important note for the maintainers When editing this class please update the copyWith function too.
const

Properties

autoFocus → bool
Whether this editor should focus itself if nothing else is already focused.
final
builder → QuillEditorBuilder?
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
controller → QuillController
final
customActions → Map<Type, Action<Intent>>?
Contains user-defined actions.
final
customLinkPrefixes → List<String>
Additional list if links prefixes, which must not be prepended with "https://" when LinkMenuAction.launch happened
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
elementOptions → QuillEditorElementOptions
This is not complete yet and might changed
final
embedBuilders → Iterable<EmbedBuilder>?
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
isOnTapOutsideEnabled → bool
Whether the onTapOutside should be triggered or not Defaults to true it have default implementation, check onTapOuside for more
final
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
magnifierConfiguration → TextMagnifierConfiguration?
Currently this feature is experimental
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
onGifPaste → (Future<String?> Function(Uint8List imageBytes)?)
Callback when the user pastes the given gif.
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
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)?)
This will run only when isOnTapOutsideEnabled is true by default on desktop and web it will unfocus on mobile it will only unFocus if the kind property of event PointerDownEvent is PointerDeviceKind.unknown you can override this to fit your needs
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
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
readOnly → bool
Whether the text can be changed.
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
sharedConfigurations → QuillSharedConfigurations
final
showCursor → bool?
Whether to show cursor.
final
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
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
unknownEmbedBuilder → EmbedBuilder?
final

Methods

copyWith({QuillSharedConfigurations? sharedConfigurations, QuillController? controller, String? placeholder, bool? readOnly, bool? checkBoxReadOnly, bool? disableClipboard, bool? scrollable, double? scrollBottomInset, EdgeInsetsGeometry? padding, bool? autoFocus, bool? isOnTapOutsideEnabled, dynamic onTapOutside(PointerDownEvent event, FocusNode focusNode)?, bool? showCursor, bool? paintCursorAboveText, bool? enableInteractiveSelection, bool? enableSelectionToolbar, double? minHeight, double? maxHeight, double? maxContentWidth, DefaultStyles? customStyles, bool? expands, TextCapitalization? textCapitalization, Brightness? keyboardAppearance, ScrollPhysics? scrollPhysics, ValueChanged<String>? onLaunchUrl, Iterable<EmbedBuilder>? embedBuilders, EmbedBuilder? unknownEmbedBuilder, CustomStyleBuilder? customStyleBuilder, CustomRecognizerBuilder? customRecognizerBuilder, LinkActionPickerDelegate? linkActionPickerDelegate, bool? floatingCursorDisabled, TextSelectionControls? textSelectionControls, Future<String?> onImagePaste(Uint8List imageBytes)?, Future<String?> onGifPaste(Uint8List imageBytes)?, 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, QuillEditorElementOptions? elementOptions, QuillEditorBuilder? builder, TextMagnifierConfiguration? magnifierConfiguration, TextInputAction? textInputAction, bool? enableScribble, void onScribbleActivated()?, EdgeInsets? scribbleAreaInsets}) → QuillEditorConfigurations
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