super_editor
library
Classes
ActionTagComposingReaction
ActionTagsPlugin
A plugin that adds support for action tags, which are tags that represent
a user's desire for an action, and then disappear after entry.
AddTextAttributionsCommand
Applies the given attributions to the given documentSelection.
AddTextAttributionsRequest
AdjustSelectionAroundTagReaction
An EditReaction that prevents partial selection of a stable user tag.
AlignDeltaFormat
A BlockDeltaFormat that applies an alignment to a paragraph.
AndroidControlsDocumentLayerState
AndroidCursorPainter
A CustomPainter that paints an Android-style caret.
AndroidDocumentGestureEditingController
Controls the display of drag handles, a magnifier, and a
floating toolbar, assuming Android-style behavior for the
handles.
AndroidDocumentTouchEditingControls
AndroidDocumentTouchInteractor
Document gesture interactor that's designed for Android touch input, e.g.,
drag to scroll, and handles to control selection.
AndroidHandlesDocumentLayer
A document layer that displays an Android-style caret, and positions Leaders for the Android
collapsed and expanded drag handles.
AndroidTextEditingFloatingToolbar
AndroidTextFieldCaret
An Android-style blinking caret.
AndroidToolbarFocalPointDocumentLayer
A document layer that positions a leader widget around the user's selection,
as a focal point for an Android-style toolbar display.
AsciiTable
Codes for a set of characters in the ascii table.
AttributedSpans
A set of spans, each with an associated Attribution , that take
up some amount of space in a discrete range.
AttributedText
Text with attributions applied to desired spans of text.
AttributedTextBoundsOverlay
A SuperEditorLayerBuilder that makes AttributionBounds usable by a SuperEditor.
AttributedTextEditingController
AttributedTextMarkdownSerializer
Serializes an AttributedText into markdown format
Attribution
An attribution that can be associated with a span within
an AttributedSpan.
AttributionBounds
Places invisible widgets around runs of attributed text.
AttributionBoundsLayout
AttributionChangeEvent
A NodeChangeEvent for the addition or removal of a set of attributions.
AttributionSpan
An Attribution span from start to end , inclusive.
AttributionVisitor
Visitor that visits every start and end attribution marker in an AttributedText
AudioEmbedBlockDeltaFormat
AudioNode
DocumentNode that represents an audio source at a URL.
AxisOffset
A distance from the leading and trailing boundaries of an
axis-aligned area.
BackgroundColorAttribution
Attribution to be used within AttributedText to
represent an inline span of a background color change.
BackgroundColorDeltaFormat
An inline Quill Delta format that applies a background color (highlight) to text.
BaseInsertNewlineAtCaretCommand
An abstract EditCommand that does some common accounting that's useful for various
implementations of commands that insert newlines.
BinaryNodePosition
Document position for a DocumentNode that is either fully selected
or unselected, like an image or a horizontal rule.
BinarySelection
Document selection for a DocumentNode that is either fully selected
or unselected, like an image or a horizontal rule.
BlockDeltaFormat
A block-level format for a text block, e.g., header, blockquote, code.
BlockNode
Base implementation for a DocumentNode that only supports UpstreamDownstreamNodeSelection s.
BlockquoteComponent
Displays a blockquote in a document.
BlockquoteComponentBuilder
BlockquoteComponentViewModel
BlockquoteConversionReaction
Adjusts a ParagraphNode to use a blockquote block attribution when a
user types " > " (or similar) at the start of the paragraph.
BlockquoteDeltaFormat
A BlockDeltaFormat that applies a blockquote block type to a paragraph.
BlockSelector
Selects blocks in a document that matches a given rule.
BottomSheetEditorHeight
Widget that switches its child constraints between a previewHeight ,
intrinsic height, and filled height.
BoxComponent
Editor layout component that displays content that is either
entirely selected, or not selected, like an image or a
horizontal rule.
BoxContentLayers
A ContentLayers widget that's implemented to work with Render Boxes.
CallbackAttributionVisitor
AttributionVisitor that delegates to given callbacks.
CancelComposingActionTagCommand
CancelComposingActionTagRequest
An EditRequest that cancels an on-going action tag composition near the user's selection.
CancelComposingStableTagCommand
CancelComposingStableTagRequest
An EditRequest that cancels an on-going stable tag composition near the user's selection.
CaretDocumentOverlay
Document overlay that paints a caret with the given caretStyle .
CaretDocumentOverlayState
CaretPainter
CaretStyle
CascadingPadding
Padding that accepts null padding values for desired sides, so that this
CascadingPadding can combine with other CascadingPadding s to produce
an overall padding configuration.
ChangeComposingRegionCommand
ChangeComposingRegionRequest
ChangeInteractionModeCommand
ChangeInteractionModeRequest
ChangeListItemTypeCommand
ChangeListItemTypeRequest
ChangeParagraphAlignmentCommand
ChangeParagraphAlignmentRequest
ChangeParagraphBlockTypeCommand
ChangeParagraphBlockTypeRequest
ChangeSelectionCommand
An EditCommand that changes the DocumentSelection in the DocumentComposer
to the newSelection .
ChangeSelectionRequest
EditRequest that changes the DocumentSelection to the given newSelection .
ChangeSingleColumnLayoutComponentStylesCommand
ChangeSingleColumnLayoutComponentStylesRequest
Changes layout styles, like padding and width, of a component within a SingleColumnDocumentLayout .
ChangeTaskCompletionCommand
ChangeTaskCompletionRequest
ClearComposingRegionRequest
ClearDocumentCommand
ClearDocumentRequest
An EditRequest to clear the document's content.
ClearSelectionRequest
ClosureAwareDeltaTextInputClientDecorator
A DeltaTextInputClientDecorator that notifies _onConnectionClosed when
the IME connection closes.
CodeBlockDeltaFormat
A BlockDeltaFormat that applies a code block type to a paragraph.
CollapseSelectionRequest
A ChangeSelectionRequest that represents a user's desire to collapse an existing selection
further upstream or downstream, such as when pressing SHIFT+LEFT or SHIFT+RIGHT.
ColorAttribution
Attribution to be used within AttributedText to
represent an inline span of a text color change.
ColorDeltaFormat
An inline Quill Delta format that applies a color to text.
CombineParagraphsCommand
Combines two consecutive ParagraphNodes, indicated by firstNodeId
and secondNodeId, respectively.
CombineParagraphsRequest
EditRequest to combine the ParagraphNode with firstNodeId with the ParagraphNode after it, which
should have the secondNodeId .
CommandExecutor
Executes EditCommand s in the order in which they're queued.
CommandTransaction
CommittedStableTagAttribution
An attribution for a committed tag, i.e., a stable tag that's done being composed and
shouldn't be partially selectable or editable.
CommonEditorOperations
Performs common, high-level editing and composition tasks
with a simplified API.
ComponentBuilder
Creates view models and components to display various DocumentNode s
in a Document .
ComposerPreferences
Holds preferences about user input, to be used for the
next character that is entered. This facilitates things
like a "bold mode" or "italics mode" when there is no
bold or italics text around the caret.
ComposingActionTag
ComposingRegionChangeEvent
A EditEvent that represents a change to the user's composing region within a document.
ComposingStableTag
ContentLayerProxyWidget
Widget that builds a ContentLayers layer based on a traditional widget
subtree, as represented by the given child .
ContentLayers
Widget that displays content above a number of underlays , and beneath a number of
overlays .
ContentLayersElement
Element for a ContentLayers widget.
ContentLayerState <WidgetType extends ContentLayerStatefulWidget , LayoutDataType >
A state object for a ContentLayerStatefulWidget .
ContentLayerStatefulElement
A StatefulElement that looks for an ancestor ContentLayersElement and marks
that element as needing to rebuild any time that this ContentLayerStatefulElement
needs to rebuild.
ContentLayerStatefulWidget <LayoutDataType >
Widget that builds a stateful ContentLayers layer, which is given access
to the ancestor ContentLayers content Element and RenderObject .
ContentLayerStatelessWidget
Widget that builds a stateless ContentLayers layer, which is given access
to the ancestor ContentLayers content Element and RenderObject .
ContentLayerWidget
A widget that can be displayed as a layer in a ContentLayers widget.
ContentTapDelegate
Delegate for mouse status and clicking on special types of content,
e.g., tapping on a link open the URL.
ConvertListItemToParagraphCommand
ConvertListItemToParagraphRequest
ConvertParagraphToListItemCommand
ConvertParagraphToListItemRequest
ConvertParagraphToTaskCommand
ConvertParagraphToTaskRequest
ConvertTaskToParagraphCommand
ConvertTaskToParagraphRequest
ConvertTextNodeToParagraphCommand
ConvertTextNodeToParagraphRequest
CreatedAtAttribution
An Attribution that logs the timestamp when a piece of content was created,
such as typing text, or inserting an image.
CustomUnderline
Data structure, which describes a type of underline, which should be painted
across the given textRange .
CustomUnderlineAttribution
Attribution to be used within AttributedText to mark text that should be painted
with a custom underline.
CustomUnderlineStyler
A style phase that inspects TextComponentViewModel s, finds text with
CustomUnderlineAttribution s and adds underline configurations to that
view model for each such attribution span.
CustomUnderlineStyles
A data structure that describes how various custom underline styles should
be painted.
DashConversionReaction
An EditReaction which converts two dashes (--) to an em-dash (—).
DebugPaintConfig
Configures the aspects of a document that show debug paint.
DefaultAndroidEditorToolbar
An Android floating toolbar, which includes standard buttons for an editor use-case.
DefaultCaretOverlayBuilder
A SuperEditorLayerBuilder that paints a caret at the primary selection extent
in a SuperEditor .
DefaultInsertNewlineAtCaretCommand
An EditCommand that handles a typical newline insertion.
DefaultIosEditorToolbar
An iOS floating toolbar, which includes standard buttons for an editor use-case.
DefaultIosReaderToolbar
An iOS floating toolbar, which includes standard buttons for a reader use-case.
DefaultSuperTextFieldKeyboardHandlers
DeferToTrackpadsAndMouseWheelsScrollBehavior
A ScrollBehavior that prevents gesture-based scrolling when a trackpad or mouse wheel
is already scrolling.
DeleteContentCommand
DeleteContentRequest
DeleteDownstreamCharacterCommand
DeleteDownstreamCharacterRequest
DeleteNodeCommand
DeleteNodeRequest
DeleteParagraphCommand
DeleteSelectionCommand
DeleteSelectionRequest
Deletes the selected content within the document.
DeleteUpstreamAtBeginningOfBlockNodeCommand
DeleteUpstreamAtBeginningOfNodeRequest
Request to handle a collapsed selection upstream deletion at the
beginning of a node .
DeleteUpstreamAtBeginningOfParagraphCommand
DeleteUpstreamCharacterCommand
DeleteUpstreamCharacterRequest
DeltaBlockMergeRule
A rule that decides whether a given DocumentNode should be merged into
the node before it, when creating a Document from Quill Deltas.
DeltaSerializer
Serializes some part of a MutableDocument to a Quill Delta document.
DeltaTextInputClientDecorator
A DeltaTextInputClient that forwards all calls to the given _client.
Document
A read-only document with styled text and multimedia elements.
DocumentChange
Marker interface for all document changes.
DocumentChangeLog
One or more document changes that occurred within a single edit transaction.
DocumentComposer
Maintains a DocumentSelection within a Document and
uses that selection to edit the document.
DocumentEdit
An EditEvent that altered a Document .
DocumentHandleGestureDelegate
Delegate for handling gestures on a document handle.
DocumentImeInputClient
Sends messages to, and receives messages from, the platform Input Method Engine (IME),
for the purpose of document editing.
A TextInputClient that applies IME operations to a Document .
DocumentImeSerializer
Serializes a Document and DocumentSelection into a form that's understood by
the Input Method Engine (IME), and vis-a-versa.
DocumentKeys
DocumentLayout
Abstract representation of a document layout.
DocumentLayoutEditable
An Editable that provides access to a DocumentLayout so that
EditCommand s can make decisions based on the layout of the
document in an editor.
DocumentLayoutLayerState <WidgetType extends ContentLayerStatefulWidget , LayoutDataType >
DocumentLayoutLayerStatefulWidget
A ContentLayerStatefulWidget that expects a content layer Element that
implements DocumentLayout .
DocumentLayoutLayerStatelessWidget
A ContentLayerStatelessWidget that expects a content layer Element that
implements DocumentLayout .
DocumentMouseInteractor
Governs mouse gesture interaction with a document, such as scrolling
a document with a scroll wheel, tapping to place a caret, and
tap-and-dragging to create an expanded selection.
DocumentNode
A single content node within a Document .
DocumentNodeMarkdownSerializer
Serializes a given DocumentNode to a Markdown String.
DocumentNodeSelection <SelectionType extends NodeSelection >
Description of a selection within a specific node in a document.
DocumentPosition
A logical position within a Document .
DocumentRange
A span within a Document with one side bounded at start and the other
side bounded at end .
DocumentScroller
Scrolling status and controls for a document experience.
DocumentSelection
A selection within a Document .
DocumentSelectionChange
Represents a change of a DocumentSelection .
DocumentSelectionLayout
Visual layout bounds related to a user selection in a document, such as the
caret rect, a bounding box around all selected content, etc.
DocumentSelectionOpenAndCloseImePolicy
Widget that enforces policies between IME connections, focus, and document selections.
DocumentTapDetails
Information about a gesture that occured within a DocumentLayout .
DottedUnderlinePainter
DottedUnderlineStyle
DragHandleAutoScroller
Auto-scrolls a given ScrollPosition based on the current position of
a drag handle near the boundary of the scroll region.
DragRectanglePainter
Paints a rectangle border around the given selectionRect.
Editable
An artifact that might be mutated during a request to a Editor .
EditCommand
A command that alters something in a Editor .
EditContext
All resources that are available when executing EditCommand s, such as a document,
composer, etc.
EditEvent
A change that took place within a Editor .
EditInspector
EditListener
An object that's notified with a change list from one or more
commands that were just executed within a Editor .
Editor
Editor for a document editing experience.
EditorCommandQueue
EditorFloatingCursor
Displays an iOS floating cursor for a document editor experience.
EditorSelectionAndFocusPolicy
Widget that applies policies to an editor's focus and selection, such as placing the
caret at the end of a document when the editor receives focus, and clearing the
selection when the editor loses focus.
EditReaction
An object that's notified with a change list from one or more commands that were just
executed.
EditRequest
An action that a Editor should execute.
ElementToNodeConverter
Converts a deserialized Markdown element into a DocumentNode .
EmptyContentLayer
A ContentLayerWidget that displays nothing.
ExpandSelectionRequest
A ChangeSelectionRequest that represents a user's desire to expand an existing selection
further upstream or downstream, such as when pressing SHIFT+LEFT or SHIFT+RIGHT.
ExpectedSize
The expected size of a piece of content, such as an image that's loading.
ExpectedSpans
FadeInStyler
A style phase, which controls the opacity of content, so that content
fades in over time.
FileEmbedBlockDeltaFormat
FileNode
DocumentNode that represents a file at a URL.
FillInComposingStableTagRequest
An EditRequest that replaces a composing stable tag with the given tag
and commits it.
FillInComposingUserTagCommand
FilterByNameBlockDeltaFormat
A BlockDeltaFormat that filters out any operation that doesn't have
an attribute with the given name .
FilterByNameInlineDeltaFormat
An InlineDeltaFormat that filters out any operation that doesn't have
an attribute with the given name .
FloatingCursorController
FloatingCursorListener
FloatingCursorPolicies
Values that reflect standard or default floating cursor policies.
FontFamilyAttribution
Attribution that says the text within it should use the given
fontFamily .
FontFamilyDeltaFormat
An inline Quill Delta format that applies a font family to text.
FontSizeAttribution
Attribution to be used within AttributedText to
represent an inline span of a font size change.
FunctionalDeltaSerializer
A DeltaSerializer that forwards to a given delegate function.
FunctionalEditListener
An EditListener that delegates to a callback function.
FunctionalEditReaction
An EditReaction that delegates its reaction to a given callback function.
FunctionalSuperEditorLayerBuilder
A SuperEditorLayerBuilder that's implemented with a given function, so
that simple use-cases don't need to sub-class SuperEditorLayerBuilder .
GestureEditingController
Controls the display and position of a magnifier and a floating toolbar
using a MagnifierAndToolbarController as the source of truth.
GlobalScrollLock
A singleton that provides a lock for interested/participating scrollables.
GroupedOverlayPortalController
An OverlayPortalController , which re-orders itself with all other GroupedOverlayPortalController s
such that each controller's displayPriority is honored by their z-indices.
Converts a ParagraphNode from a regular paragraph to a header when the
user types "# " (or similar) at the start of the paragraph.
A BlockDeltaFormat that applies a header block type to a paragraph.
DocumentNodeMarkdownSerializer , which serializes Markdown headers to
ParagraphNode s with an appropriate header block type, and (optionally) a
block alignment.
HintComponentBuilder
A ComponentBuilder for rendering hint text in the first node of a document,
when its an empty text node.
HintComponentViewModel
HistoryGroupingPolicy
HistoryGroupingPolicyList
A HistoryGroupingPolicy that defers to a list of other individual policies.
HorizontalRuleComponent
Displays a horizontal rule in a document.
HorizontalRuleComponentBuilder
HorizontalRuleComponentViewModel
HorizontalRuleConversionReaction
Converts node content that looks like "--- " or "—- " (an em-dash followed by a regular dash)
at the beginning of a paragraph into a horizontal rule.
HorizontalRuleNode
DocumentNode for a horizontal rule, which represents a full-width
horizontal separation in a document.
HorizontalRuleNodeSerializer
DocumentNodeMarkdownSerializer for serializing HorizontalRuleNode s as standard
Markdown horizontal rules.
ImageComponent
Displays an image in a document.
ImageComponentBuilder
ImageComponentViewModel
ImageEmbedBlockDeltaFormat
ImageNode
DocumentNode that represents an image at a URL.
ImageNodeSerializer
DocumentNodeMarkdownSerializer for serializing ImageNode s as standard Markdown
images.
ImageUrlConversionReaction
When the user creates a new node, and the previous node is just a URL
to an image, the replaces the previous node with the referenced image.
ImeAttributedTextEditingController
An AttributedTextEditingController that integrates the platform's Input
Method Engine (IME) changes into the text, selection, and composing region
of a text field's content.
ImeFocusPolicy
Widget that opens and closes an imeConnection based on the focusNode gaining
and losing primary focus.
ImeInputOwner
A widget that internally accepts IME input.
IndentListItemCommand
IndentListItemRequest
IndentParagraphCommand
IndentParagraphDeltaFormat
A BlockDeltaFormat that applies an indent to a paragraph.
IndentParagraphRequest
IndentTaskCommand
IndentTaskRequest
IndexedTag
A Tag and its position within a Document .
InlineDeltaFormat
Given a Quill Delta text insertion operation, inspects the delta's attributes and then
returns an attribution that should be applied to the AttributedText created by the
insertion operation.
InlineEmbed
InlineEmbedDeltaSerializer
Serializes pieces of text to Quill Deltas.
InlineEmbedFormat
InsertAttributedTextCommand
InsertAttributedTextRequest
InsertCharacterAtCaretCommand
InsertCharacterAtCaretRequest
Inserts the given character at the current caret position.
InsertInlinePlaceholderAtCaretCommand
InsertInlinePlaceholderAtCaretRequest
InsertNewlineAtCaretRequest
A request to insert a newline at the current caret position.
InsertNewlineInCodeBlockAtCaretCommand
An EditCommand that inserts a newline when the caret sits within a code block.
InsertNewlineInListItemAtCaretCommand
An EditCommand that inserts a newline when the caret sits within a ListItemNode .
InsertNewlineInTaskAtCaretCommand
An EditCommand that inserts a newline when the caret sits within a TaskNode .
InsertNodeAfterNodeCommand
InsertNodeAfterNodeRequest
InsertNodeAtCaretCommand
InsertNodeAtCaretRequest
InsertNodeAtEndOfDocumentRequest
Inserts the newNode at the end of the document.
InsertNodeAtIndexCommand
InsertNodeAtIndexRequest
InsertNodeBeforeNodeCommand
InsertNodeBeforeNodeRequest
InsertPlainTextAtCaretCommand
InsertPlainTextAtCaretRequest
A request to insert the given plainText at the current caret position.
InsertPlainTextAtEndOfDocumentRequest
Inserts the given plain text at the end of the document.
InsertSoftNewlineAtCaretRequest
Inserts a newline character "\n" at the current caret position, within
the current selected text node (doesn't insert a new node).
InsertSoftNewlineCommand
InsertStyledTextAtCaretCommand
InsertStyledTextAtCaretRequest
InsertStyledTextAtEndOfDocumentCommand
InsertStyledTextAtEndOfDocumentRequest
Inserts the given styled text at the end of the document.
InsertTextCommand
InsertTextRequest
IntentBlocker
Blocks a set of intents from launching Action s.
Intention
IOSCircleMagnifyingGlass
IosControlsDocumentLayerState
IosDocumentGestureEditingController
Controls the display of drag handles, a magnifier, and a
floating toolbar, assuming iOS-style behavior for the
handles.
IosDocumentTouchInteractor
Document gesture interactor that's designed for iOS touch input, e.g.,
drag to scroll, tap to place the caret, double tap to select a word,
triple tap to select a paragraph.
IOSEditingControls
Overlay editing controls for an iOS-style text field.
IOSEditingOverlayController
IosFloatingToolbarOverlay
An application overlay that displays an iOS-style toolbar.
IOSFollowingMagnifier
An iOS magnifying glass that follows a LayerLink .
IosHandlesDocumentLayer
A document layer that displays an iOS-style caret and handles.
IosHeuristics
User interaction heuristics that simulate observed behavior on
iOS devices.
IosMagnifierViewModel
Parameters used to render an iOS magnifier.
IOSRoundedRectangleMagnifyingGlass
Displays the iOS system context menu on top of the Flutter view.
IOSTextEditingFloatingToolbar
IOSTextFieldCaret
An iOS-style blinking caret.
IOSTextFieldTouchInteractor
iOS text field touch interaction surface.
IOSTextFieldTouchInteractorState
IosToolbarFocalPointDocumentLayer
A document layer that positions a leader widget around the user's selection,
as a focal point for an iOS-style toolbar display.
ItemSelectionList <T >
A list where the user can navigate between its items and select one of them.
ItemSelectionListState <T >
KeyboardEditingToolbar
A mobile document editing toolbar, which is displayed in the application
Overlay , and is mounted just above the software keyboard.
KeyboardEditingToolbarOperations
KeyboardHeightBuilder
Builds (and rebuilds) a builder with the current height of the software keyboard.
KeyboardPanelController <PanelType >
Shows and hides the keyboard panel and software keyboard.
KeyboardPanelScaffold <PanelType >
Scaffold that displays the given contentBuilder , while also (optionally) displaying
a toolbar docked to the top of the software keyboard, and/or a panel that appears
instead of the software keyboard.
KeyboardPanelScaffoldDelegate <PanelType >
KeyboardSafeAreaGeometry
Insets applied by a KeyboardPanelScaffold to an ancestor KeyboardScaffoldSafeArea
to deal with the presence or absence of the software keyboard.
KeyboardScaffoldSafeArea
Applies padding to the bottom of the child to avoid the software keyboard and
the above-keyboard toolbar.
KeyboardScaffoldSafeAreaMutator
KeyboardScaffoldSafeAreaScope
Stores and provides keyboard scaffold safe area info to its subtree, which can
coordinate safe areas between different branches of the subtree.
Level
Level s to control logging output. Logging can be enabled to include all
levels above certain Level . Level s are ordered using an integer
value Level.value . The predefined Level constants below are sorted as
follows (in descending order): Level.SHOUT , Level.SEVERE ,
Level.WARNING , Level.INFO , Level.CONFIG , Level.FINE , Level.FINER ,
Level.FINEST , and Level.ALL .
LineHeight
A widget that sets its child 's height to the line-height of a given text style .
LineHeightSquare
A widget that sets its child 's width and height to the line-height of a
given text style .
LinkAttribution
Attribution to be used within AttributedText to
represent a link.
LinkDeltaFormat
An inline Quill Delta format that applies a link to text.
LinkifyReaction
An EditReaction which converts a URL into a styled link.
ListDeltaFormat
A BlockDeltaFormat that converts a paragraph to a list item or a task.
ListItemComponentBuilder
ListItemComponentViewModel
ListItemDeltaSerializer
ListItemDotStyle
ListItemNode
ListItemNodeSerializer
DocumentNodeMarkdownSerializer for serializing ListItemNode s as standard Markdown
list items.
Logger
LogNames
MacOsSelectors
MacOS selector names that are sent to TextInputClient.performSelector .
MagnifierAndToolbarController
Controls the display and position of a magnifier and a floating toolbar.
MagnifyingGlass
A magnifying glass that enlarges the content beneath it.
MarkdownImage
A parsed image notation.
MarkdownInlineUpstreamSyntaxPlugin
A SuperEditorPlugin that finds inline Markdown syntax immediately upstream from the
caret and converts it into attributions.
MarkdownInlineUpstreamSyntaxReaction
An EditReaction that finds inline Markdown syntax immediately upstream from the
caret and converts it into attributions.
MarkdownTableCellViewModel
View model that configures the appearance of a MarkdownTableComponent 's cell.
MarkdownTableComponent
A component that displays a read-only table with block level selection.
MarkdownTableComponentBuilder
Builds MarkdownTableViewModel s and MarkdownTableComponent s for every TableBlockNode
in a document.
MarkdownTableViewModel
View model that configures the appearance of a MarkdownTableComponent .
MergeBlock
A DeltaBlockMergeRule that chooses to merge blocks whose type ==
the given block type.
MergeRapidTextInputPolicy
MergeRepeatSelectionChangesPolicy
MessagePageController
Controller for a MessagePageScaffold .
MessagePageElement
Element for a MessagePageScaffold widget.
MessagePageScaffold
A scaffold for a chat experience in which a conversation thread is
displayed, with a message editor mounted to the bottom of the chat area.
MovementModifier
Preferences for how the document selection should change, e.g.,
move word-by-word instead of character-by-character.
MoveNodeCommand
MoveNodeRequest
MultiAttributionSpan
A span that contains zero or more attributions.
MultiListenableBuilder
Builder that runs every time one of the given listenables changes.
MutableDocument
An in-memory, mutable Document .
MutableDocumentComposer
NamedAttribution
Attribution that is defined by a given String .
NamedFontSizeAttribution
An Attribution that sets the font size of text based on a given size
name, e.g., "huge", "large", "normal", "small".
NamedInlineDeltaFormat
An InlineDeltaFormat that applies a given attribution to text whenever
that text insertion includes an attribute with the given name .
NodeChangeEvent
The content of a DocumentNode changed.
NodeDocumentChange
A DocumentChange that impacts a single, specified DocumentNode with nodeId .
NodeInsertedEvent
A new DocumentNode was inserted in the Document .
NodeMetadata
Keys to access metadata on a DocumentNode .
NodeMovedEvent
A DocumentNode was moved to a new index.
NodePosition
A logical position within a DocumentNode , e.g., a TextNodePosition
within a ParagraphNode , or a BinaryNodePosition within an ImageNode .
NodeRemovedEvent
A DocumentNode was removed from the Document .
NodeSelection
Marker interface for a selection within a DocumentNode .
NodeTypedDocumentNodeMarkdownSerializer <NodeType >
A DocumentNodeMarkdownSerializer that automatically rejects any
DocumentNode that doesn't match the given NodeType.
OpacityAttribution
Attribution to be used within AttributedText to apply a given opacity
to a span of text.
OrderedListItemComponent
Displays an ordered list item in a document.
OrderedListItemComponentViewModel
OrderedListItemConversionReaction
Converts a ParagraphNode to an OrderedListItemNode when the
user types " 1. " (or similar) at the start of the paragraph.
OverlayGroupPriority
OverlaySlot
ParagraphComponent
A document component that displays a paragraph.
ParagraphComponentBuilder
ParagraphComponentViewModel
ParagraphDeltaSerializer
ParagraphNode
ParagraphNodeSerializer
DocumentNodeMarkdownSerializer for serializing ParagraphNode s as standard Markdown
paragraphs.
ParagraphPrefixConversionReaction
Base class for EditReaction s that want to take action when the user types text at
the beginning of a paragraph, which matches a given RegExp .
PasteEditorCommand
PasteEditorRequest
PasteStructuredContentEditorCommand
Inserts given structured content, in the form of a List of DocumentNode s at a
given paste position within the document.
PasteStructuredContentEditorRequest
Request to paste the given structured content in the document at the
given pastePosition .
PatternTagAttribution
An attribution for a pattern tag.
PatternTagIndex
Collects references to all pattern tags in a document for easy querying.
PatternTagPlugin
A SuperEditorPlugin that finds and attributes tags, based on patterns, in a document.
PatternTagReaction
An EditReaction that creates, updates, and removes pattern tags.
PausableValueNotifier <T >
A ValueNotifier , which allows clients to pause new value notifications.
ProxyTextDocumentComponent
A ProxyDocumentComponent that adds TextComposable capabilities so
that simple text-based proxy components can meet their expected contract
without going through the work of defining a stateful widget that mixes in
the ProxyDocumentComponent methods.
PushCaretRequest
A ChangeSelectionRequest that represents a user's desire to push the caret upstream
or downstream, such as when pressing LEFT or RIGHT.
ReadOnlyAndroidDocumentTouchInteractor
Read-only document gesture interactor that's designed for Android touch input, e.g.,
drag to scroll, and handles to control selection.
ReadOnlyDocumentKeyboardInteractor
Governs document input that comes from a physical keyboard.
ReadOnlyDocumentMouseInteractor
Governs mouse gesture interaction with a read-only document, such as scrolling
a document with a scroll wheel and tap-and-dragging to create an expanded selection.
Document gesture interactor that's designed for read-only mouse input,
e.g., drag to select, and mouse wheel to scroll.
ReadOnlyTaskComponentBuilder
Builds TaskComponentViewModel s and TaskComponent s for every
TaskNode in a document.
RemoveComposerPreferenceStylesCommand
RemoveComposerPreferenceStylesRequest
RemoveTextAttributionsCommand
Removes the given attributions from the given documentSelection.
RemoveTextAttributionsRequest
RenderBoxContentLayers
RenderObject for a BoxContentLayers widget.
RenderContentLayers
RenderMessageEditorHeight
RenderMessagePageScaffold
RenderObject for a MessagePageScaffold widget.
RenderSliverContentLayers
RenderObject for a SliverContentLayers widget.
RenderViewportWithDryLayout
ReplaceNodeCommand
ReplaceNodeRequest
ReplaceNodeWithEmptyParagraphWithCaretCommand
ReplaceNodeWithEmptyParagraphWithCaretRequest
RequestDispatcher
An object that processes EditRequest s.
ScriptAttribution
An attribution for superscript and subscript text.
ScriptDeltaFormat
An inline Quill Delta format that makes text superscript or subscript.
ScrollableInstrumentation
Connections to, and information about a scrolling experience that's
used for visual debugging.
ScrollingBoxConstraints
ScrollingMinimap
A miniature display of a Scrollable viewport and the boundary
of its content, which helps to diagnose scrolling bugs.
ScrollingMinimapPainter
Paints a minimap for a Scrollable, showing a miniature viewport,
scroll offset, current scroll direction, etc.
ScrollingMinimaps
Repository of scrolling minimap statuses, used to coordinate between
a Scrollable and the minimap that represents that Scrollable.
ScrollingMinimapsRepository
SelectableBox
SelectionChangeEvent
A EditEvent that represents a change to the user's selection within a document.
SelectionLayerLinks
A collection of LayerLink s that should be positioned near important
visual selection locations, such as at the caret position.
SelectionLeadersDocumentLayer
A document layer that positions leader widgets at the user's selection bounds.
SelectionReason
Holds common reasons for selection changes.
Developers aren't limited to these selection change reasons. Any object can be passed as
a reason for a selection change. However, some Super Editor behavior is based on userInteraction .
SelectionStyles
Styles applied to the user's selection, e.g., selected text.
SetParagraphIndentCommand
SetParagraphIndentRequest
SetTaskIndentCommand
SetTaskIndentRequest
Sets the indent of the task with ID nodeId to the given indent .
SignalNotifier
A ChangeNotifier that allows clients to send a change signal to listeners.
SingleAxisTrackpadAndWheelScroller
A widget that scrolls a given controller , either vertically or horizontally, when the user
interacts with the widget via a trackpad or a mouse wheel, but only when no other scrollable
has claimed scrolling ownership.
SingleColumnDocumentComponentContext
Information that is provided to a ComponentBuilder to
construct an appropriate DocumentComponent widget.
SingleColumnDocumentLayout
Displays a document in a single-column layout.
SingleColumnLayoutComponentStyles
SingleColumnLayoutComponentViewModel
Base class for a component view model that appears within a
SingleColumnDocumentLayout .
SingleColumnLayoutCustomComponentStyler
SingleColumnLayoutStylePhase that applies custom styling to specific
components.
SingleColumnLayoutPresenter
Produces SingleColumnLayoutViewModel s to be displayed by a
SingleColumnDocumentLayout .
SingleColumnLayoutPresenterChangeListener
SingleColumnLayoutSelectionStyler
SingleColumnLayoutStylePhase that applies visual selections to each component,
e.g., text selections, image selections, caret positioning.
SingleColumnLayoutStylePhase
A single phase of style rules, which are applied in a pipeline to
a baseline SingleColumnLayoutViewModel .
SingleColumnLayoutViewModel
View model for an entire SingleColumnDocumentLayout .
SingleColumnStylesheetStyler
Style phase that applies a given Stylesheet to the document view model.
SingleStrikethroughSyntax
A Markdown DelimiterSyntax that matches strikethrough spans of text, which are represented in
Markdown with surrounding ~ tags, e.g., "this is strikethrough text".
SizeDeltaFormat
An inline Quill Delta format that applies a named or numerical size to text.
SliverContentLayers
A ContentLayers widget that's implemented to work with Slivers.
SliverHybridStack
Component that allows mixing RenderSliver child with other RenderBox
children. The RenderSliver child will be laid out first, and then the
RenderBox children will be laid out to cover the entire scroll extent
of the RenderSliver child.
SoftwareKeyboardController
SuperEditor controller that opens and closes the software keyboard.
SoftwareKeyboardControllerDelegate
Delegate that's attached to a SoftwareKeyboardController , which implements
the opening and closing of the software keyboard.
SoftwareKeyboardOpener
Widget that opens and closes the software keyboard, when requested.
SpanMarker
Marks the start or end of an attribution span.
SpanRange
A range of characters in a string of text, based on Flutter's TextRange.
SpecialCharacters
Characters that are difficult to represent literally, and therefore are provided as constants.
SpellingAndGrammarStyler
A SingleColumnLayoutStylePhase that applies spelling and grammar error
underlines to TextNode s in the document that have reported errors.
SplitExistingTaskCommand
SplitExistingTaskRequest
SplitListItemCommand
SplitListItemIntention
SplitListItemRequest
SplitParagraphCommand
Splits the ParagraphNode affiliated with the given nodeId at the
given splitPosition, placing all text after splitPosition in a
new ParagraphNode with the given newNodeId, inserted after the
original node.
SplitParagraphIntention
SplitParagraphRequest
SplitTaskIntention
SquiggleUnderlinePainter
SquiggleUnderlineStyle
StableTagIndex
Collects references to all stable tags in a document for easy querying.
StableTagPlugin
A SuperEditor plugin that adds the ability to create stable tags, such as
persistent user references, e.g., "@dash".
StandardEmbedBlockDeltaFormat
StraightUnderlinePainter
StraightUnderlineStyle
StyledHintBuilder
Builds a hint widget based on given hintText and a hintTextStyleBuilder .
StyleRule
A single style rule within a Stylesheet .
Styles
The keys to the style metadata used by a StyleRule .
Stylesheet
Stylesheet for styling content within a document.
StyleUpstreamMarkdownSyntaxParser
An UpstreamMarkdownInlineSyntax that parses standard Markdown styles, e.g.,
bold, italics, code, strikethrough.
StyleUpstreamMarkdownToken
An UpstreamMarkdownToken that applies standard inline Markdown styles,
e.g., bold, italics, strikethrough, and code.
SubmitComposingActionTagCommand
SubmitComposingActionTagRequest
SubmitParagraphIntention
SuperAndroidTextField
SuperAndroidTextFieldState
SuperDesktopTextField
Highly configurable text field intended for web and desktop uses.
SuperDesktopTextFieldState
SuperEditor
A rich text editor that displays a document in a single-column layout.
SuperEditorAddEmptyParagraphTapHandler
A ContentTapDelegate that adds an empty paragraph at the end of the document
when the user taps below the last node in the document.
SuperEditorAndroidControlsController
A controller, which coordinates the state of various Android editor controls, including
the caret, handles, magnifier, and toolbar.
SuperEditorAndroidControlsOverlayManager
Adds and removes an Android-style editor controls overlay, as dictated by an ancestor
SuperEditorAndroidControlsScope .
SuperEditorAndroidControlsOverlayManagerState
SuperEditorAndroidControlsScope
An InheritedWidget that provides shared access to a SuperEditorAndroidControlsController ,
which coordinates the state of Android controls like the caret, handles, magnifier, etc.
SuperEditorAndroidHandlesDocumentLayerBuilder
A SuperEditorLayerBuilder , which builds an AndroidHandlesDocumentLayer ,
which displays Android-style caret and handles.
SuperEditorAndroidToolbarFocalPointDocumentLayerBuilder
A SuperEditorDocumentLayerBuilder that builds an AndroidToolbarFocalPointDocumentLayer , which
positions a Leader widget around the document selection, as a focal point for an Android
floating toolbar.
SuperEditorContext
Collection of core artifacts used to edit a document.
SuperEditorDebugVisuals
SuperEditorDebugVisualsConfig
SuperEditorDryLayout
A custom Viewport that wraps a given superEditor so that this subtree can run
dry layout, reporting the intrinsic height of the superEditor .
SuperEditorFocusDebugVisuals
SuperEditorHardwareKeyHandler
Applies appropriate edits to a document and selection when the user presses
hardware keys.
SuperEditorImageSyntax
Matches all images.
SuperEditorImeConfiguration
Input Method Engine (IME) configuration for document text input.
SuperEditorImeDebugVisuals
SuperEditorImeInteractor
SuperEditor interactor that edits a document based on IME input
from the operating system.
SuperEditorImeInteractorState
SuperEditorImePolicies
A collection of policies that dictate how a SuperEditor 's focus, selection, and
IME should interact, such as opening the software keyboard whenever SuperEditor 's
selection changes (openKeyboardOnSelectionChange ).
SuperEditorIosControlsController
A controller, which coordinates the state of various iOS editor controls, including
the caret, handles, floating cursor, magnifier, and toolbar.
SuperEditorIosControlsScope
An InheritedWidget that provides shared access to a SuperEditorIosControlsController ,
which coordinates the state of iOS controls like the caret, handles, magnifier, etc.
SuperEditorIosHandlesDocumentLayerBuilder
A SuperEditorLayerBuilder , which builds a IosHandlesDocumentLayer ,
which displays iOS-style caret and handles.
SuperEditorIosMagnifierOverlayManager
Adds and removes an iOS-style editor magnifier, as dictated by an ancestor
SuperEditorIosControlsScope .
SuperEditorIosMagnifierOverlayManagerState
SuperEditorIosToolbarFocalPointDocumentLayerBuilder
A SuperEditorDocumentLayerBuilder that builds a IosToolbarFocalPointDocumentLayer , which
positions a Leader widget around the document selection, as a focal point for an
iOS floating toolbar.
SuperEditorIosToolbarOverlayManager
Adds and removes an iOS-style editor toolbar, as dictated by an ancestor
SuperEditorIosControlsScope .
SuperEditorIosToolbarOverlayManagerState
SuperEditorLaunchLinkTapHandler
A ContentTapDelegate that opens links when the user taps text with
a LinkAttribution .
SuperEditorLayerBuilder
Builds widgets that are displayed at the same position and size as
the document layout within a SuperEditor .
SuperEditorPlugin
A SuperEditor plugin.
SuperEditorPopover
A popover that shares focus with a SuperEditor.
SuperEditorSelectionPolicies
A collection of policies that dictate how a SuperEditor 's selection will change
based on other behaviors, such as focus changes.
SuperEditorState
SuperIOSTextField
SuperIOSTextFieldState
SuperMessage
A chat message widget.
SuperMessageContext
A collection of artifacts that are available within every SuperMessage .
SuperMessageDocumentLayerBuilder
Builds widgets that are displayed at the same position and size as
the document layout within a SuperMessage .
SuperMessageIosHandlesDocumentLayerBuilder
A SuperMessageLayerBuilder, which builds a IosHandlesDocumentLayer ,
which displays iOS-style handles.
SuperMessageIosToolbarFocalPointDocumentLayerBuilder
A SuperMessageDocumentLayerBuilder that builds a IosToolbarFocalPointDocumentLayer , which
positions a Leader widget around the document selection, as a focal point for an
iOS floating toolbar.
SuperMessageStyles
Styles that apply to a given SuperMessage , including a document stylesheet,
and selection styles, for both light and dark modes.
SuperReader
SuperReaderContext
Collection of core artifacts used to display a read-only document.
SuperReaderDocumentLayerBuilder
Builds widgets that are displayed at the same position and size as
the document layout within a SuperReader .
SuperReaderIosControlsController
A controller, which coordinates the state of various iOS reader controls, including
drag handles, magnifier, and toolbar.
SuperReaderIosControlsScope
An InheritedWidget that provides shared access to a SuperReaderIosControlsController ,
which coordinates the state of iOS controls like drag handles, magnifier, and toolbar.
SuperReaderIosDocumentTouchInteractor
Document gesture interactor that's designed for iOS touch input, e.g.,
drag to scroll, double and triple tap to select content, and drag
selection ends to expand selection.
SuperReaderIosHandlesDocumentLayerBuilder
A SuperReaderLayerBuilder, which builds a IosHandlesDocumentLayer ,
which displays iOS-style handles.
SuperReaderIosMagnifierOverlayManager
Adds and removes an iOS-style editor magnifier, as dictated by an ancestor
SuperReaderIosControlsScope .
SuperReaderIosMagnifierOverlayManagerState
SuperReaderIosToolbarFocalPointDocumentLayerBuilder
A SuperReaderDocumentLayerBuilder that builds a IosToolbarFocalPointDocumentLayer , which
positions a Leader widget around the document selection, as a focal point for an
iOS floating toolbar.
SuperReaderIosToolbarOverlayManager
Adds and removes an iOS-style editor toolbar, as dictated by an ancestor
SuperReaderIosControlsScope .
SuperReaderIosToolbarOverlayManagerState
SuperReaderLaunchLinkTapHandler
A ContentTapDelegate that opens links when the user taps text with
a LinkAttribution .
SuperReaderState
SuperTextField
Text field that supports styled text.
SuperTextFieldContext
Collection of core artifacts used to interact with, and edit, a text field.
SuperTextFieldGestureDetails
Information about a gesture that happened within a SuperTextField .
SuperTextFieldGestureInteractor
Handles all user gesture interactions for text entry.
SuperTextFieldImeInteractor
Opens and closes an IME connection based on changes to focus and selection.
SuperTextFieldKeyboardInteractor
Handles all keyboard interactions for text entry in a text field.
SuperTextFieldKeys
SuperTextFieldLaunchLinkTapHandler
A SuperTextFieldTapHandler that opens links when the user taps text with
a LinkAttribution .
SuperTextFieldScrollview
Handles all scrolling behavior for a text field.
SuperTextFieldScrollviewState
SuperTextFieldState
SuperTextFieldTapHandler
Tap handler that can (optionally) respond to single, double, and triple taps, as well as dictate the cursor
appearance on desktop.
TableBlockNode
A DocumentNode that represents a read-only block table.
TableBlockNodeSerializer
DocumentNodeMarkdownSerializer for serializing TableBlockNode s as the extended Markdown
syntax for tables.
TableStyles
The keys to the style metadata used to style a table.
Tag
A text tag, e.g., "@dash", "#flutter".
TagAroundPosition
An IndexedTag , along with a text position about which the tag was found.
TagFinder
A set of tools for finding tags within document text.
TagRule
A rule for matching a text token to a tag.
TagUserReaction
An EditReaction that creates, updates, and removes composing stable tags, and commits those
composing tags, causing them to become uneditable.
TapSequenceGestureRecognizer
Recognizes when the user has tapped the screen at the same location one,
two, and three times.
TaskComponent
A document component that displays a complete-able task.
TaskComponentBuilder
Builds TaskComponentViewModel s and TaskComponent s for every
TaskNode in a document.
TaskComponentViewModel
View model that configures the appearance of a TaskComponent .
TaskDeltaSerializer
TaskNode
This file includes everything needed to add the concept of a task
to Super Editor. This includes:
TaskNodeSerializer
DocumentNodeMarkdownSerializer for serializing TaskNode s using Github's style syntax.
TextBlockDeltaSerializer
A DeltaSerializer that includes standard Quill Delta rules for
serializing text blocks, e.g., paragraphs, lists, and tasks.
TextComponent
Displays text in a document.
TextComponentState
TextComposable
Contract for widgets that include editable text.
TextDeletedEvent
TextDeltasDocumentEditor
Applies software keyboard text deltas to a document.
TextError
A spelling or grammar error within a TextNode .
TextInputConnectionDecorator
Base class for TextInputConnection decorators.
TextInsertionEvent
TextLayoutCaret
TextLayoutCaretState
TextNode
TextNodeMetadata
Keys to access metadata that are specific to a TextNode .
TextNodePosition
A logical position within a TextNode .
TextNodeSelection
A logical selection within a TextNode .
TextScrollController
TextScrollControllerDelegate
TextScrollView
A scrollable that positions its child based on text metrics.
TextWithHintComponent
Document component that displays hint text when its content text
is empty.
ToggleTextAttributionsCommand
Applies the given attributions to the given documentSelection,
if none of the content in the selection contains any of the
given attributions. Otherwise, all the given attributions
are removed from the content within the documentSelection.
ToggleTextAttributionsRequest
ToolbarConfig
Configuration used to display a toolbar.
UnderlaySlot
Underlines
A group of text ranges that should be displayed with underlines, along with the style
of those underlines.
UnderlineStyle
UnderlineSyntax
A Markdown DelimiterSyntax that matches underline spans of text, which are represented in
Markdown with surrounding ¬ tags, e.g., "this is ¬underline¬ text".
UnIndentListItemCommand
UnIndentListItemRequest
UnIndentParagraphCommand
UnIndentParagraphRequest
UnIndentTaskCommand
UnIndentTaskRequest
UnknownComponent
Displays a Placeholder widget within a document layout.
UnknownComponentBuilder
UnorderedListItemComponent
Displays a un-ordered list item in a document.
UnorderedListItemComponentViewModel
UnorderedListItemConversionReaction
Converts a ParagraphNode to an UnorderedListItemNode when the
user types "* " (or similar) at the start of the paragraph.
UpdateComposerTextStylesReaction
EditReaction that synchronizes the active composer styles with the caret's
position, when the caret moves in relevant ways.
UpdateSubTaskIndentAfterTaskDeletionReaction
UpstreamDownstreamNodePosition
NodePosition that either sits at the upstream edge, or the downstream edge of
the given content, like sitting before or after an image.
UpstreamDownstreamNodeSelection
A NodeSelection for a DocumentNode that only supports an upstream and downstream
position, like a caret sitting before or after an image.
UpstreamMarkdownInlineSyntax
A parser for a specific set of inline Markdown syntaxes, based on
the offset of a caret.
UpstreamMarkdownToken
A Markdown token that's assembled by a specific UpstreamMarkdownInlineSyntax .
UrlMediaNode
DocumentNode that represents a media source that exists a given url .
UserTypedText
VideoEmbedBlockDeltaFormat
VideoNode
DocumentNode that represents a video at a URL.
ViewportWithDryLayout
Constants
actionTagCancelledAttribution → const NamedAttribution
An attribution for an action tag that was being composed and then was cancelled.
actionTagComposingAttribution → const NamedAttribution
An attribution for an action tag that's currently being composed.
audioDeltaSerializer → const FunctionalDeltaSerializer
A DeltaSerializer that serializes AudioNode s to deltas.
blockquoteAttribution → const NamedAttribution
Blockquote attribution
boldAttribution → const NamedAttribution
Bold style attribution.
codeAttribution → const NamedAttribution
Code style attribution.
contentSlot → const String
defaultActionTagRule → const TagRule
defaultAndroidControlsColor → const Color
defaultBlockFormats → const List <FilterByNameBlockDeltaFormat
The standard block-level text formats that are parsed from Quill Deltas,
e.g., headers, blockquotes, list items.
defaultBlockMergeRules → const List <MergeBlock
The standard set of DeltaBlockMergeRule s used when parsing Quill Deltas.
defaultComponentBuilders → const List <ComponentBuilder
Creates visual components for the standard SuperEditor .
defaultDarkChatSelectionStyles → const SelectionStyles
defaultDeltaSerializers → const List <DeltaSerializer
The serializers the are used by default to convert a Super Editor Document to a
Quill Delta document.
defaultDesktopCaretColor → const Color
defaultEditorSelectorHandlers → const Map <String SuperEditorSelectorHandler
Map selector names to its handlers.
defaultEmbedBockFormats → const List <StandardEmbedBlockDeltaFormat
The standard block-level embed formats that are parsed from Quill Deltas,
e.g., images, audio, video.
defaultExtendableTypes → const Set <Type
defaultGrammarErrorUnderlineStyle → const SquiggleUnderlineStyle
defaultInlineFormats → const List <InlineDeltaFormat
The standard inline text formats that are parsed from Quill Deltas, e.g.,
bold, italics, underline, links.
defaultInlineHtmlSerializers → const List <String ? Function(Attribution attribution , TagType tagType
defaultInlineHtmlSyntaxes → const List <AttributedText ? Function(Element element , AttributedText text
defaultInlineWidgetBuilderChain → const List <Widget ? Function(BuildContext context , TextStyle textStyle , Object placeholder
The default priority list of inline widget builders, which map AttributedText
placeholders to widgets.
defaultIOSControlsColor → const Color
defaultIosHandleBallDiameter → const double
The diameter of the small circle that appears on the top and bottom of
expanded iOS text handles in dip.
defaultIosMagnifierAnimationCurve → const Cubic
defaultIosMagnifierEnterAnimationDuration → const Duration
defaultIosMagnifierExitAnimationDuration → const Duration
defaultIosMagnifierSize → const Size
defaultLightChatSelectionStyles → const SelectionStyles
defaultMergePolicy → const HistoryGroupingPolicyList
The merge policies that are used in the standard Editor construction.
defaultNodeHtmlSerializerChain → const NodeHtmlSerializerChain
The standard HTML serializers for every type of DocumentNode in a Document .
defaultSelectionColor → const Color
defaultSelectionStyle → const SelectionStyles
Default visual styles related to content selection.
defaultSpellingErrorUnderlineStyle → const SquiggleUnderlineStyle
defaultSuperEditorDocumentOverlayBuilders → const List <SuperEditorLayerBuilder
Default list of document overlays that are displayed on top of the document
layout in a SuperEditor .
defaultSuperMessageDocumentOverlayBuilders → const List <SuperMessageDocumentLayerBuilder
Default list of document overlays that are displayed on top of the document
layout in a SuperMessage .
defaultSuperReaderDocumentOverlayBuilders → const List <SuperReaderDocumentLayerBuilder
Default list of document overlays that are displayed on top of the document
layout in a SuperReader .
defaultTextFieldImeKeyboardHandlers → const List <TextFieldKeyboardHandler
The keyboard actions that a SuperTextField uses by default when using TextInputSource.ime .
defaultTextFieldKeyboardHandlers → const List <TextFieldKeyboardHandler
The keyboard actions that a SuperTextField uses by default.
defaultTextFieldSelectorHandlers → const Map <String SuperTextFieldSelectorHandler
defaultUpstreamInlineMarkdownParsers → const List <StyleUpstreamMarkdownSyntaxParser
fileDeltaSerializer → const FunctionalDeltaSerializer
A DeltaSerializer that serializes FileNode s into deltas.
grammarErrorAttribution → const NamedAttribution
Grammar error attribution.
hashTagRule → const TagRule
Default TagRule for hash tags.
Header 1 style block attribution.
Header 2 style block attribution.
Header 3 style block attribution.
Header 4 style block attribution.
Header 5 style block attribution.
Header 6 style block attribution.
imageDeltaSerializer → const FunctionalDeltaSerializer
A DeltaSerializer that serializes ImageNode s into deltas.
italicsAttribution → const NamedAttribution
Italics style attribution.
kTapMinTime → const Duration
kTapTimeout → const Duration
listItemAttribution → const NamedAttribution
listItemDeltaSerializer → const ListItemDeltaSerializer
A DataSerializer that serializes ListItemNode s into deltas.
mergeRapidTextInputPolicy → const MergeRapidTextInputPolicy
A sane default configuration of a MergeRapidTextInputPolicy .
mergeRepeatSelectionChangesPolicy → const MergeRepeatSelectionChangesPolicy
neverMergePolicy → const _NeverMergePolicy
paragraphAttribution → const NamedAttribution
Plain paragraph block attribution.
paragraphDeltaSerializer → const ParagraphDeltaSerializer
A DeltaSerializer that serializes ParagraphNode s into deltas.
readOnlyDefaultSelectionStyle → const SelectionStyles
Default visual styles related to content selection.
spellingErrorAttribution → const NamedAttribution
Spelling error attribution.
stableTagCancelledAttribution → const NamedAttribution
An attribution for a stable tag that was being composed and then was cancelled.
stableTagComposingAttribution → const NamedAttribution
An attribution for a stable tag that's currently being composed.
strikethroughAttribution → const NamedAttribution
Strikethrough style attribution.
subscriptAttribution → const ScriptAttribution
Subscript style attribution.
superscriptAttribution → const ScriptAttribution
Superscript style attribution.
tableBlockAttribution → const NamedAttribution
taskDeltaSerializer → const TaskDeltaSerializer
A DeltaSerializer that serializes TaskNode s into deltas.
underlineAttribution → const NamedAttribution
Underline style attribution.
userTagRule → const TagRule
TagRule for user tags.
videoDeltaSerializer → const FunctionalDeltaSerializer
A DeltaSerializer that serializes VideoNode s into deltas.
Functions
anchorHtmlSyntax (Element element , AttributedText text → AttributedText ?
anyCharacterOrDestructiveKeyToDeleteSelection ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
anyCharacterToInsertInParagraph ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
anyCharacterToInsertInTextContent ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
attributedTextFromMarkdown (String markdown → AttributedText
Parses markdown and returns it as AttributedText .
backspaceToClearParagraphBlockType ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
When the caret is collapsed at the beginning of a ParagraphNode
and backspace is pressed, clear any existing block type, e.g.,
header 1, header 2, blockquote.
backspaceToConvertTaskToParagraph ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
backspaceToUnIndentListItem ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
backspaceToUnIndentParagraph ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
backspaceToUnIndentTask ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
blockControlKeys ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
Halt execution of the current key event if the key pressed is one of
the functions keys (F1, F2, F3, etc.), or the Page Up/Down, Home/End key.
boldHtmlSyntax (Element element , AttributedText text → AttributedText ?
cmdBToToggleBold ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
cmdIToToggleItalics ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
codeInlineHtmlSyntax (Element element , AttributedText text → AttributedText ?
collapseSelectionWhenEscIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
When the ESC key is pressed, the editor should collapse the expanded selection.
computeListItemOrdinalValue (ListItemNode listItem , Document document → int
Computes the ordinal value of an ordered list item.
copy ({required Document document , required DocumentSelection selection → void
Serializes the current selection to plain text, and adds it to the
clipboard.
copyWhenCmdCIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
createDefaultDocumentEditor ({MutableDocument ?document , MutableDocumentComposer ?composer , HistoryGroupingPolicy historyGroupingPolicy = defaultMergePolicy , bool isHistoryEnabled = false → Editor
createShortcut (ReadOnlyDocumentKeyboardAction action , {LogicalKeyboardKey ?keyPressedOrReleased , Set <LogicalKeyboardKey ?triggers , bool ?isShiftPressed , bool ?isCmdPressed , bool ?isCtlPressed , bool ?isAltPressed , bool onKeyUp = false , bool onKeyDown = true , Set <TargetPlatform ?platforms → ReadOnlyDocumentKeyboardAction
A proxy for a ReadOnlyDocumentKeyboardAction that filters events based
on onKeyUp, onKeyDown, and shortcut.
cutWhenCmdXIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deactivateLoggers (Set <Logger > loggers → void
defaultAndroidEditorToolbarBuilder (BuildContext context , Key floatingToolbarKey , CommonEditorOperations editorOps , SuperEditorAndroidControlsController editorControlsController , ValueListenable <DocumentSelection ? selectionNotifier , LeaderLink focalPoint → Widget
Builds a standard editor-style Android floating toolbar.
defaultAttributionsToExtendToNewParagraph (Attribution attribution → bool
The default Attribution s, which will be carried over from the end of a paragraph
to the beginning of a new paragraph, when splitting a paragraph at the very end.
defaultBlockquoteToHtmlSerializer (Document document , DocumentNode node , NodeSelection ?selection , InlineHtmlSerializerChain inlineSerializers → String ?
defaultBoldHtmlSerializer (Attribution attribution , TagType tagType → String ?
defaultCodeBlockToHtmlSerializer (Document document , DocumentNode node , NodeSelection ?selection , InlineHtmlSerializerChain inlineSerializers → String ?
defaultCodeHtmlSerializer (Attribution attribution , TagType tagType → String ?
defaultHintStyleBuilder (Set <Attribution attributions → TextStyle
Creates default TextStyles for hint text in a super text field.
defaultHorizontalRuleToHtmlSerializer (Document document , DocumentNode node , NodeSelection ?selection , InlineHtmlSerializerChain inlineSerializers → String ?
defaultImageToHtmlSerializer (Document document , DocumentNode node , NodeSelection ?selection , InlineHtmlSerializerChain inlineSerializers → String ?
defaultInlineTextStyler (Set <Attribution attributions , TextStyle existingStyle → TextStyle
defaultIosEditorToolbarBuilder (BuildContext context , Key floatingToolbarKey , LeaderLink focalPoint , CommonEditorOperations editorOps , SuperEditorIosControlsController editorControlsController → Widget
Builds a standard editor-style iOS floating toolbar.
defaultIosPopoverToolbarBuilder (BuildContext context , IOSEditingOverlayController controller → Widget
Returns a widget for the default/standard iOS-style popover provided by Super Text Field.
defaultIosReaderToolbarBuilder (BuildContext context , Key floatingToolbarKey , LeaderLink focalPoint , Document document , ValueListenable <DocumentSelection ? selection , SuperReaderIosControlsController editorControlsController → Widget
Builds a standard reader-style iOS floating toolbar.
defaultItalicsHtmlSerializer (Attribution attribution , TagType tagType → String ?
defaultLinkHtmlSerializer (Attribution attribution , TagType tagType → String ?
defaultListItemIndentCalculator (TextStyle textStyle , int indent → double
The standard TextBlockIndentCalculator used by list items in SuperEditor.
defaultListItemToHtmlSerializer (Document document , DocumentNode node , NodeSelection ?selection , InlineHtmlSerializerChain inlineSerializers → String ?
defaultParagraphIndentCalculator (TextStyle textStyle , int indent → double
The standard TextBlockIndentCalculator used by paragraphs in SuperEditor.
defaultParagraphToHtmlSerializer (Document document , DocumentNode node , NodeSelection ?selection , InlineHtmlSerializerChain inlineSerializers → String ?
defaultSelectedTextColorStrategy ({required Color originalTextColor , required Color selectionHighlightColor → Color
Default SelectedTextColorStrategy , which retains the original text color,
regardless of selection color.
defaultStrikethroughHtmlSerializer (Attribution attribution , TagType tagType → String ?
defaultStyleBuilder (Set <Attribution attributions → TextStyle
Creates TextStyles for the standard SuperEditor .
defaultTaskIndentCalculator (TextStyle textStyle , int indent → double
The standard TextBlockIndentCalculator used by tasks in SuperEditor.
defaultTextFieldStyleBuilder (Set <Attribution attributions → TextStyle
Default TextStyles for SuperTextField .
defaultUnderlineHtmlSerializer (Attribution attribution , TagType tagType → String ?
deleteBackward (SuperEditorContext context → void
deleteCharacterWhenBackspaceIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteDownstreamCharacterWithCtrlDeleteOnMac ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteDownstreamContentWithDelete ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteForward (SuperEditorContext context → void
deleteToBeginningOfLine (SuperEditorContext context → void
deleteToEndOfLine (SuperEditorContext context → void
deleteToEndOfLineWithCmdDeleteOnMac ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteToStartOfLineWithCmdBackspaceOnMac ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteUpstreamContentWithBackspace ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteWordBackward (SuperEditorContext context → void
deleteWordDownstreamWithAltDeleteOnMac ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteWordDownstreamWithControlDeleteOnWindowsAndLinux ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteWordForward (SuperEditorContext context → void
deleteWordUpstreamWithAltBackspaceOnMac ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deleteWordUpstreamWithControlBackspaceOnWindowsAndLinux ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
deserializeMarkdownToDocument (String markdown , {MarkdownSyntax syntax = MarkdownSyntax.superEditor , List <BlockSyntax > customBlockSyntax = const [] , List <ElementToNodeConverter customElementToNodeConverters = const [] , Iterable <InlineSyntax > ?inlineMarkdownSyntaxes , Iterable <InlineHtmlSyntax ?inlineHtmlSyntaxes , bool encodeHtml = false → MutableDocument
Parses the given markdown and deserializes it into a MutableDocument .
doNothingWhenThereIsNoSelection ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
doNothingWithBackspaceOnWeb ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
doNothingWithCtrlOrCmdAndZOnWeb ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
doNothingWithDeleteOnWeb ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
doNothingWithEnterOnWeb ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
doNothingWithLeftRightArrowKeysAtMiddleOfTextOnWeb ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
enterToInsertBlockNewline ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
enterToInsertNewTask ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
enterToUnIndentParagraph ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
Un-indents the current paragraph if the paragraph is empty and the user
pressed Enter.
expandPositionToParagraph ({required String text , required TextPosition textPosition → TextSelection
Expands a selection in both directions starting at textPosition until
the selection reaches a newline, or the end of the available text.
expandPositionToWord ({required String text , required TextPosition textPosition → TextSelection
Expands a selection in both directions starting at textPosition until
the selection reaches a space, or the end of the available text.
getBlockSelection (DocumentPosition caretPosition → DocumentSelection ?
getCharacterEndBounds (String text , int startingCodePointIndex → int
Returns the code point index for the code point that ends the visual
character that begins at startingCodePointIndex.
getCharacterStartBounds (String text , int endingCodePointIndex → int
Returns the code point index for the code point that begins the visual
character that ends at endingCodePointIndex.
getDownstreamSelectableNodeAfter (Document document , DocumentLayoutResolver documentLayoutResolver , DocumentNode startingNode → DocumentNode ?
Returns the first DocumentNode after startingNode whose
DocumentComponent is visually selectable.
getParagraphDirection (String text → TextDirection
Returns the TextDirection of the text based on its first non-whitespace character.
getParagraphSelection ({required DocumentPosition docPosition , required DocumentLayout docLayout → DocumentSelection ?
Returns the paragraph of text that contains the given docPosition, or null
if there is no text at the given docPosition.
getUpstreamSelectableNodeBefore (Document document , DocumentLayoutResolver documentLayoutResolver , DocumentNode startingNode → DocumentNode ?
Returns the first DocumentNode before startingNode whose
DocumentComponent is visually selectable.
getWordSelection ({required DocumentPosition docPosition , required DocumentLayout docLayout → DocumentSelection ?
Returns the word of text that contains the given docPosition, or null if
no text exists at the given docPosition.
ignoreKeyCombos (List <ShortcutActivator keys → DocumentKeyboardAction
A DocumentKeyboardAction that reports ExecutionInstruction.blocked
for any key combination that matches one of the given keys.
ignoreTextFieldKeyCombos (List <ShortcutActivator keys → TextFieldKeyboardHandler
A TextFieldKeyboardHandler that reports TextFieldKeyboardHandlerResult.blocked
for any key combination that matches one of the given keys.
indentListItem (SuperEditorContext context → void
initAllLogs (Level level → void
initLoggers (Level level , Set <Logger > loggers → void
inlineAssetImageBuilder (BuildContext context , TextStyle textStyle , Object placeholder → Widget ?
An inline widget builder that displays an image from local assets.
inlineNetworkImageBuilder (BuildContext context , TextStyle textStyle , Object placeholder → Widget ?
An inline widget builder that displays an image from the network.
insertNewLine (SuperEditorContext context → void
iOSSystemPopoverEditorToolbarWithFallbackBuilder (BuildContext context , Key floatingToolbarKey , LeaderLink focalPoint , CommonEditorOperations editorOps , SuperEditorIosControlsController editorControlsController → Widget
A DocumentFloatingToolbarBuilder that displays the iOS system popover toolbar, if the version of
iOS is recent enough, otherwise builds defaultIosEditorToolbarBuilder .
iOSSystemPopoverTextFieldToolbarWithFallback (BuildContext context , IOSEditingOverlayController controller → Widget
An IOSPopoverToolbarBuilder that displays the iOS system popover toolbar, if the version of
iOS is recent enough, otherwise builds defaultIosPopoverToolbarBuilder .
isCharacterBlacklisted (String character → bool
This method is the implementation for isKeyEventCharacterBlacklisted , but without
the kIsWeb check, so that the behavior can be unit tested.
isKeyEventCharacterBlacklisted (String ?character → bool
Whether the given character should be ignored when it's received within
a KeyEvent on web.
isLogActive (Logger logger → bool
Returns true if the given logger is currently logging, or
false otherwise.
italicHtmlSyntax (Element element , AttributedText text → AttributedText ?
mergeNodeWithNextWhenDeleteIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveCaretDown ({required Editor editor , required DocumentLayout documentLayout , required bool retainCollapsedSelection → bool
Moves the DocumentComposer 's selection extent position down,
vertically, either by moving the selection extent down one line of
text, or by moving the selection extent down to the node below the
current extent.
moveCaretDownstream ({required Editor editor , required DocumentLayout documentLayout , MovementModifier ?movementModifier , required bool retainCollapsedSelection → bool
Moves the DocumentComposer 's selection extent position in the
downstream direction (to the right for left-to-right languages).
moveCaretUp ({required Editor editor , required DocumentLayout documentLayout , required bool retainCollapsedSelection → bool
Moves the DocumentComposer 's selection extent position up,
vertically, either by moving the selection extent up one line of
text, or by moving the selection extent up to the node above the
current extent.
moveCaretUpstream ({required Editor editor , required DocumentLayout documentLayout , MovementModifier ?movementModifier , required bool retainCollapsedSelection → bool
moveDown (SuperEditorContext context → void
moveDownAndModifySelection (SuperEditorContext context → void
moveLeft (SuperEditorContext context → void
moveLeftAndModifySelection (SuperEditorContext context → void
moveLeftAndRightWithArrowKeys ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveParagraphBackwardAndModifySelection (SuperEditorContext context → void
moveParagraphForwardAndModifySelection (SuperEditorContext context → void
moveParagraphSelectionUpWhenBackspaceIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveRight (SuperEditorContext context → void
moveRightAndModifySelection (SuperEditorContext context → void
moveSelectionToNearestSelectableNode ({required Editor editor , required Document document , required DocumentLayoutResolver documentLayoutResolver , required DocumentSelection ?currentSelection , required DocumentNode startingNode , bool expand = false → bool
Moves the DocumentComposer 's selection to the nearest node to startingNode,
whose DocumentComponent is visually selectable.
moveToBeginningOfDocument (SuperEditorContext context → void
moveToBeginningOfDocumentAndModifySelection (SuperEditorContext context → void
moveToBeginningOfParagraph (SuperEditorContext context → void
moveToEndOfDocument (SuperEditorContext context → void
moveToEndOfDocumentAndModifySelection (SuperEditorContext context → void
moveToEndOfParagraph (SuperEditorContext context → void
moveToLeftEndOfLine (SuperEditorContext context → void
moveToLeftEndOfLineAndModifySelection (SuperEditorContext context → void
moveToLineEndWithEnd ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveToLineStartOrEndWithCtrlAOrE ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveToLineStartWithHome ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveToNearestSelectableComponent (Editor editor , DocumentLayout documentLayout , String nodeId , DocumentComponent <StatefulWidget component → void
moveToRightEndOfLine (SuperEditorContext context → void
moveToRightEndOfLineAndModifySelection (SuperEditorContext context → void
moveToStartOrEndOfLineWithArrowKeysOnWeb ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveUp (SuperEditorContext context → void
moveUpAndDownWithArrowKeys ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
moveUpAndModifySelection (SuperEditorContext context → void
moveWordLeft (SuperEditorContext context → void
moveWordLeftAndModifySelection (SuperEditorContext context → void
moveWordRight (SuperEditorContext context → void
moveWordRightAndModifySelection (SuperEditorContext context → void
noStyleBuilder (Set <Attribution attributions → TextStyle
AttributionStyleBuilder that returns a default TextStyle, for
use when creating baseline view models before the text styles are
configured.
parseInlineMarkdown (String text , {Iterable <InlineSyntax > ?inlineMarkdownSyntaxes , Iterable <InlineHtmlSyntax ?inlineHtmlSyntaxes , bool encodeHtml = false → AttributedText
Parses inline markdown content.
parseQuillDeltaDocument (Map <String dynamic > deltaDocument , {Editor ?customEditor , List <BlockDeltaFormat blockFormats = defaultBlockFormats , List <DeltaBlockMergeRule blockMergeRules = defaultBlockMergeRules , List <InlineDeltaFormat inlineFormats = defaultInlineFormats , List <InlineEmbedFormat inlineEmbedFormats = const [] , List <BlockDeltaFormat embedBlockFormats = defaultEmbedBockFormats → MutableDocument
Parses a fully formed Quill Delta document (as JSON) into a MutableDocument .
parseQuillDeltaOps (List deltaOps , {Editor ?customEditor , List <BlockDeltaFormat blockFormats = defaultBlockFormats , List <DeltaBlockMergeRule blockMergeRules = defaultBlockMergeRules , List <InlineDeltaFormat inlineFormats = defaultInlineFormats , List <InlineEmbedFormat inlineEmbedFormats = const [] , List <BlockDeltaFormat embedBlockFormats = defaultEmbedBockFormats → MutableDocument
Parses a list of Quill Delta operations (as JSON) into a MutableDocument .
pasteMarkdown ({required Editor editor , required Document document , required DocumentComposer composer → Future <void >
Deletes all selected content, and then pastes the current clipboard
content at the given location, interpreting the clipboard content
as Markdown.
pasteMarkdownOnCmdAndCtrlV ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
A SuperEditor keyboard action that pastes clipboard content into the document,
interpreting the clipboard content as Markdown.
pasteWhenCmdVIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
printLog (LogRecord record → void
readOnlyDefaultInlineTextStyler (Set <Attribution attributions , TextStyle existingStyle → TextStyle
readOnlyDefaultStyleBuilder (Set <Attribution attributions → TextStyle
Creates TextStyles for the standard SuperReader .
scrollOnCtrlOrCmdAndEndKeyPress ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
Scrolls the viewport to the bottom of the content, when the user presses
CMD + END on Mac, or CTRL + END on all other platforms.
scrollOnCtrlOrCmdAndHomeKeyPress ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
Scrolls the viewport to the top of the content, when the user presses
CMD + HOME on Mac, or CTRL + HOME on all other platforms.
scrollOnPageDownKeyPress ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
Scrolls down by the viewport height, or as far as possible,
when the user presses the Page Down key.
scrollOnPageUpKeyPress ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
Scrolls up by the viewport height, or as high as possible,
when the user presses the Page Up key.
scrollPageDown (SuperEditorContext context → void
scrollPageUp (SuperEditorContext context → void
scrollToBeginningOfDocument (SuperEditorContext context → void
scrollToEndOfDocument (SuperEditorContext context → void
selectAll (Editor editor → bool
Sets the selection's value to include the entire Document .
selectAllWhenCmdAIsPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
selectBlockAt (DocumentPosition position , ValueNotifier <DocumentSelection ? selection → bool
selectRegion ({required Editor editor , required DocumentLayout documentLayout , required Offset baseOffsetInDocument , required Offset extentOffsetInDocument , required SelectionType selectionType , bool expandSelection = false → void
Calculates an appropriate DocumentSelection from an (x,y)
baseOffsetInDocument, to an (x,y) extentOffsetInDocument, setting
the new document selection in the given selection.
selectWordAt ({required DocumentPosition docPosition , required DocumentLayout docLayout , required ValueNotifier <DocumentSelection ? selection → bool
sendKeyEventToMacOs ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
serializeDocumentToMarkdown (Document doc , {DocumentSelection ?selection , MarkdownSyntax syntax = MarkdownSyntax.superEditor , List <DocumentNodeMarkdownSerializer customNodeSerializers = const [] → String
Serializes the given doc to Markdown text.
shiftEnterToInsertNewlineInBlock ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
shiftTabToUnIndentListItem ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
shiftTabToUnIndentParagraph ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
shiftTabToUnIndentTask ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
strikethroughHtmlSyntax (Element element , AttributedText text → AttributedText ?
superEditorAddEmptyParagraphTapHandlerFactory (SuperEditorContext editContext → SuperEditorAddEmptyParagraphTapHandler
superEditorLaunchLinkTapHandlerFactory (SuperEditorContext editContext → SuperEditorLaunchLinkTapHandler
superReaderLaunchLinkTapHandlerFactory (SuperReaderContext readerContext → SuperReaderLaunchLinkTapHandler
tabToIndentListItem ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
tabToIndentParagraph ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
tabToIndentTask ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
toggleInteractionModeWhenCmdOrCtrlPressed ({required SuperEditorContext editContext , required KeyEvent keyEvent → ExecutionInstruction
tryToParseUrl (String word → Uri ?
Parses the text as Uri , prepending "https://" if it doesn't start
with "http://" or "https://".
underlineHtmlSyntax (Element element , AttributedText text → AttributedText ?
unIndentListItem (SuperEditorContext context → void
Typedefs
AttributionBoundsBuilder
= Widget ? Function(BuildContext context , Attribution attribution
Builder that (optionally) returns a widget that is positioned at the size
and location of attributed text.
AttributionBoundsSelector
= bool Function(Attribution attribution
Filter function that decides whether the text with the given attribution
should have a widget boundary placed around it.
AttributionExtensionSelector
= bool Function(Attribution attribution
A function that returns true if the given attribution should be automatically
extended when the caret is placed after such an attributed character, and the
user continues to type - or false to ignore the attribution for future typing.
AttributionFilter
= bool Function(Attribution candidate
Returns true when the given candidate Attribution matches the desired condition.
AttributionSpanVisitor
= void Function(MultiAttributionSpan span
AttributionStyleAdjuster
= TextStyle Function(Set <Attribution attributions , TextStyle existingStyle
Adjusts the given existingStyle based on the given attributions.
AttributionStyleBuilder
= TextStyle Function(Set <Attribution attributions
Creates the desired TextStyle given the attributions associated
with a span of text.
ContentLayerWidgetBuilder
= ContentLayerWidget Function(BuildContext context
A widget builder, which builds a ContentLayerWidget .
DecorationBuilder
= Widget Function(BuildContext Widget child
DeltaSerializerDelegate
= bool Function(DocumentNode node , Delta deltas
DocumentChangeListener
= void Function(DocumentChangeLog changeLog
Listener that's notified when a document changes.
DocumentCollapsedHandleBuilder
= Widget Function(BuildContext required LeaderLink focalPoint , required DocumentHandleGestureDelegate gestureDelegate , required Key handleKey , required bool shouldShow
Builds a full-screen collapsed drag handle display, with the handle positioned near the focalPoint,
and with the handle attached to the given handleKey.
DocumentExpandedHandlesBuilder
= Widget Function(BuildContext required LeaderLink downstreamFocalPoint , required DocumentHandleGestureDelegate downstreamGestureDelegate , required Key downstreamHandleKey , required bool shouldShow , required LeaderLink upstreamFocalPoint , required DocumentHandleGestureDelegate upstreamGestureDelegate , required Key upstreamHandleKey
Builds a full-screen display of a set of expanded drag handles, with the handles positioned near the
upstreamFocalPoint and downstreamFocalPoint, respectively, and with the handles attached to the
given upstreamHandleKey and downstreamHandleKey, respectively.
DocumentFloatingToolbarBuilder
= Widget Function(BuildContext context , Key mobileToolbarKey , LeaderLink focalPoint
Builds a full-screen floating toolbar display, with the toolbar positioned near the
focalPoint, and with the toolbar attached to the given mobileToolbarKey.
DocumentKeyboardAction
= ExecutionInstruction Function({required SuperEditorContext editContext , required KeyEvent keyEvent
Executes this action, if the action wants to run, and returns
a desired ExecutionInstruction to either continue or halt
execution of actions.
DocumentLayoutResolver
= DocumentLayout Function()
Obtains a DocumentLayout .
DocumentMagnifierBuilder
= Widget Function(BuildContext Key magnifierKey , LeaderLink focalPoint , bool isVisible
Builds a full-screen magnifier display, with the magnifier following the given focalPoint,
and with the magnifier attached to the given magnifierKey.
EditRequestHandler
= EditCommand ? Function(Editor editor , EditRequest request
Factory method that creates and returns an EditCommand that can handle
the given EditRequest , or null if this handler doesn't apply to the given
EditRequest .
GestureDoubleTapCallback
= void Function()
InlineHtmlSerializer
= String ? Function(Attribution attribution , TagType tagType
A function that (maybe) serializes the given attribution to an HTML tag.
InlineHtmlSerializerChain List <InlineHtmlSerializer
A priority-order list of InlineHtmlSerializer s, which can be used to serialize
text segments from a document to inline HTML.
InlineHtmlSyntax
= AttributedText ? Function(Element element , AttributedText text
InlineWidgetBuilder
= Widget ? Function(BuildContext context , TextStyle textStyle , Object placeholder
Builder that returns a Widget for a given placeholder, or null
if this builder doesn't know how to build the given placeholder.
InlineWidgetBuilderChain List <InlineWidgetBuilder
A Chain of Responsibility that builds widgets for text inline placeholders.
IOSPopoverToolbarBuilder
= Widget Function(BuildContext IOSEditingOverlayController
Builder that returns a widget for an iOS-style popover editing toolbar.
MagnifierBuilder
= Widget Function(BuildContext IosMagnifierViewModel magnifierInfo , [Key ?magnifierKey
MessagePageScaffoldContentBuilder
= Widget Function(BuildContext context , double bottomSpacing
Builder that builds the content subtree within a MessagePageScaffold .
NodeHtmlSerializer
= String ? Function(Document document , DocumentNode node , NodeSelection ?selection , InlineHtmlSerializerChain inlineSerializers
A function that (maybe) serializes the given node to HTML.
NodeHtmlSerializerChain List <NodeHtmlSerializer
A priority-order list of NodeHtmlSerializer s, which can be used to serialize
an entire Document of nodes.
OnUpdateComposingActionTag
= void Function(IndexedTag ?composingActionTag
OnUpdateComposingStableTag
= void Function(ComposingStableTag ?composingStableTag
OrderedListItemNumeralBuilder
= Widget Function(BuildContext OrderedListItemComponent
Reaction
= void Function(EditContext editorContext , RequestDispatcher requestDispatcher , List <EditEvent changeList
ReadOnlyDocumentKeyboardAction
= ExecutionInstruction Function({required SuperReaderContext documentContext , required KeyEvent keyEvent
Executes this action, if the action wants to run, and returns
a desired ExecutionInstruction to either continue or halt
execution of actions.
RightClickListener
= void Function(BuildContext textFieldContext , AttributedTextEditingController textController , Offset textFieldOffset
SelectableListItemBuilder T >
= Widget Function(BuildContext context , T item , bool isActive , VoidCallback onTap
Builds a list item.
SelectedTextColorStrategy
= Color Function({required Color originalTextColor , required Color selectionHighlightColor
Returns the Color that should be used for selected text, possibly based
on the originalTextColor.
SelectionChanger
= void Function(DocumentSelection ?newSelection
Styler
= Map <String dynamic > Function(Document DocumentNode
Generates style metadata for the given DocumentNode within the Document .
SuperEditorContentTapDelegateFactory
= ContentTapDelegate Function(SuperEditorContext editContext
SuperEditorSelectorHandler
= void Function(SuperEditorContext context
A callback to handle a performSelector call.
SuperReaderContentTapDelegateFactory
= ContentTapDelegate Function(SuperReaderContext editContext
SuperTextFieldLayoutResolver
= ProseTextLayout Function()
Function that returns the text layout for a text field.
SuperTextFieldSelectorHandler
= void Function({required SuperTextFieldContext textFieldContext
A callback to handle a performSelector call.
TableCellDecorator
= BoxDecoration ? Function({required Map <String dynamic > cellMetadata , required AttributedText cellText , required int columnIndex , required int rowIndex
A function that decorates a table cell.
TableRowDecorator
= BoxDecoration ? Function({required int rowIndex
A function that decorates a table row.
TextBlockIndentCalculator
= double Function(TextStyle blockTextStyle , int indent
A function that calculates the pixels to indent a text block in a document, given
the blockTextStyle, and the indent level.
TextFieldKeyboardHandler
= TextFieldKeyboardHandlerResult Function({required KeyEvent keyEvent , required SuperTextFieldContext textFieldContext
TextInputConnectionFactory
= TextInputConnection Function(TextInputClient client , TextInputConfiguration configuration
UnorderedListItemDotBuilder
= Widget Function(BuildContext UnorderedListItemComponent
ViewModelChangeCallback
= void Function({required List <String addedComponents , required List <String changedComponents , required List <String movedComponents , required List <String removedComponents
VisitAttributionsCallback
= void Function(AttributedText fullText , int index , Set <Attribution startingAttributions , Set <Attribution endingAttributions
Visits every index in the the given AttributedText which has at least
one start or end marker, passing the attributions that start or end at the index.
VoidCallback
= void Function()
A zero-parameter function that returns nothing.
super_editor 0.3.0-dev.42 