QuillRawEditorConfigurations class
- Annotations
Constructors
-
QuillRawEditorConfigurations({required QuillController controller, required FocusNode focusNode, required ScrollController scrollController, required double scrollBottomInset, required CursorStyle cursorStyle, required Color selectionColor, required TextSelectionControls selectionCtrls, required EmbedsBuilder embedBuilder, required bool autoFocus, bool showCursor = true, bool scrollable = true, EdgeInsetsGeometry padding = EdgeInsets.zero, bool readOnly = false, bool? checkBoxReadOnly, bool disableClipboard = false, String? placeholder, ValueChanged<
String> ? onLaunchUrl, QuillEditorContextMenuBuilder? contextMenuBuilder = defaultContextMenuBuilder, bool showSelectionHandles = false, TextCapitalization textCapitalization = TextCapitalization.none, double? maxHeight, double? minHeight, double? maxContentWidth, DefaultStyles? customStyles, Map<ShortcutActivator, Intent> ? customShortcuts, Map<Type, Action< ? customActions, bool expands = false, bool isOnTapOutsideEnabled = true, dynamic onTapOutside(PointerDownEvent event, FocusNode focusNode)?, Brightness? keyboardAppearance, bool enableInteractiveSelection = true, ScrollPhysics? scrollPhysics, LinkActionPickerDelegate linkActionPickerDelegate = defaultLinkActionPickerDelegate, CustomStyleBuilder? customStyleBuilder, CustomRecognizerBuilder? customRecognizerBuilder, bool floatingCursorDisabled = false, Future<Intent> >String?> onImagePaste(Uint8List imageBytes)?, Future<String?> onGifPaste(Uint8List imageBytes)?, List<String> customLinkPrefixes = const <String>[], QuillDialogTheme? dialogTheme, ContentInsertionConfiguration? contentInsertionConfiguration, TextInputAction textInputAction = TextInputAction.newline, bool requestKeyboardFocusOnCheckListChanged = false, bool enableScribble = false, void onScribbleActivated()?, EdgeInsets? scribbleAreaInsets}) -
const
Properties
- autoFocus → bool
-
Whether this editor should focus itself if nothing else is already
focused.
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?
-
Builds the text selection toolbar when requested by the user.
final
- controller → QuillController
-
Controls the document being edited.
final
- cursorStyle → CursorStyle
-
The style to be used for the editing cursor.
final
-
customActions
→ Map<
Type, Action< ?Intent> > -
Contains user-defined actions.
final
-
customLinkPrefixes
→ List<
String> -
final
- customRecognizerBuilder → CustomRecognizerBuilder?
-
final
-
customShortcuts
→ Map<
ShortcutActivator, Intent> ? -
Contains user-defined shortcuts map.
final
- customStyleBuilder → CustomStyleBuilder?
-
final
- customStyles → DefaultStyles?
-
Allows to override DefaultStyles.
final
- dialogTheme → QuillDialogTheme?
-
Configures the dialog theme.
final
- disableClipboard → bool
-
Disable Clipboard features
final
- embedBuilder → EmbedsBuilder
-
Builder function for embeddable objects.
final
- enableInteractiveSelection → bool
-
If true, then long-pressing this TextField will select text and show the
cut/copy/paste menu, and tapping will move the text caret.
final
- enableScribble → bool
-
Enable Scribble? Currently Apple Pencil only, defaults to false.
final
- expands → bool
-
Whether this widget'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
- isOnTapOutsideEnabled → bool
-
Whether the onTapOutside should be triggered or not
Defaults to
true
it have default implementation, checkonTapOuside
for morefinal - keyboardAppearance → Brightness?
-
The appearance of the keyboard.
final
- linkActionPickerDelegate → LinkActionPickerDelegate
-
final
- maxContentWidth → double?
-
The maximum width to be occupied by the content of this editor.
final
- maxHeight → double?
-
The maximum height this editor can have.
final
- minHeight → double?
-
The minimum height this editor can have.
final
-
onGifPaste
→ (Future<
String?> Function(Uint8List imageBytes)?) -
final
-
onImagePaste
→ (Future<
String?> Function(Uint8List imageBytes)?) -
final
-
onLaunchUrl
→ ValueChanged<
String> ? -
Callback which is triggered when the user wants to open a URL from
a link in the document.
final
- onScribbleActivated → (void Function()?)
-
Called when Scribble is activated.
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
- padding → EdgeInsetsGeometry
-
Additional space around the editor contents.
final
- placeholder → String?
-
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
-
final
- scrollBottomInset → double
-
final
- scrollController → ScrollController
-
final
- scrollPhysics → ScrollPhysics?
-
The ScrollPhysics to use when vertically scrolling the input.
final
- selectionColor → Color
-
The color to use when painting the selection.
final
- selectionCtrls → TextSelectionControls
-
Delegate for building the text selection handles and toolbar.
final
- selectionEnabled → bool
-
no setter
- showCursor → bool
-
Whether to show cursor.
final
- showSelectionHandles → bool
-
Whether to show selection handles.
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
-
final
Methods
-
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
Static Methods
-
defaultContextMenuBuilder(
BuildContext context, QuillRawEditorState state) → Widget