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.
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.
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
AttributedTextEditingController
Attribution
An attribution that can be associated with a span within an AttributedSpan.
AttributionBounds
Positions 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
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 backgrounnd color change.
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.
BlockNode
Base implementation for a DocumentNode that only supports UpstreamDownstreamNodeSelections.
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.
BlockSelector
Selects blocks in a document that matches a given rule.
BoxComponent
Editor layout component that displays content that is either entirely selected, or not selected, like an image or a horizontal rule.
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 CascadingPaddings 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
ClearSelectionRequest
ClosureAwareDeltaTextInputClientDecorator
A DeltaTextInputClientDecorator that notifies _onConnectionClosed when the IME connection closes.
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.
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 EditCommands 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 DocumentNodes 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.
ConvertBlockquoteToParagraphCommand
ConvertListItemToParagraphCommand
ConvertListItemToParagraphRequest
ConvertParagraphToListItemCommand
ConvertParagraphToListItemRequest
ConvertParagraphToTaskCommand
ConvertParagraphToTaskRequest
ConvertTaskToParagraphCommand
ConvertTaskToParagraphRequest
ConvertTextNodeToParagraphCommand
ConvertTextNodeToParagraphRequest
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.
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
DeleteContentCommand
DeleteContentRequest
DeleteDownstreamCharacterCommand
DeleteDownstreamCharacterRequest
DeleteNodeCommand
DeleteNodeRequest
DeleteParagraphCommand
DeleteUpstreamAtBeginningOfBlockNodeCommand
DeleteUpstreamAtBeginningOfNodeRequest
Request to handle a collapsed selection upstream deletion at the beginning of a node.
DeleteUpstreamAtBeginningOfParagraphCommand
DeleteUpstreamCharacterCommand
DeleteUpstreamCharacterRequest
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.
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 EditCommands 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.
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.
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 EditCommands, 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.
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
FillInComposingStableTagRequest
An EditRequest that replaces a composing stable tag with the given tag and commits it.
FillInComposingUserTagCommand
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.
FontSizeAttribution
Attribution to be used within AttributedText to represent an inline span of a font size change.
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.
GroupedOverlayPortalController
An OverlayPortalController, which re-orders itself with all other GroupedOverlayPortalControllers such that each controller's displayPriority is honored by their z-indices.
HeaderConversionReaction
Converts a ParagraphNode from a regular paragraph to a header when the user types "# " (or similar) at the start of the paragraph.
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.
ImageComponent
Displays an image in a document.
ImageComponentBuilder
ImageComponentViewModel
ImageNode
DocumentNode that represents an image at a URL.
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
IndentParagraphRequest
IndentTaskCommand
IndentTaskRequest
IndexedTag
A Tag and its position within a Document.
InsertAttributedTextCommand
InsertAttributedTextRequest
InsertCharacterAtCaretCommand
InsertCharacterAtCaretRequest
InsertNodeAfterNodeCommand
InsertNodeAfterNodeRequest
InsertNodeAtCaretCommand
InsertNodeAtCaretRequest
InsertNodeAtIndexCommand
InsertNodeAtIndexRequest
InsertNodeBeforeNodeCommand
InsertNodeBeforeNodeRequest
InsertTextCommand
InsertTextRequest
IntentBlocker
Blocks a set of intents from launching Actions.
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.
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
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.
LinkAttribution
Attribution to be used within AttributedText to represent a link.
LinkifyReaction
An EditReaction which converts a URL into a styled link.
ListItemComponentBuilder
ListItemComponentViewModel
ListItemDotStyle
ListItemNode
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.
MergeRapidTextInputPolicy
MergeRepeatSelectionChangesPolicy
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.
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.
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.
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
ParagraphComponent
A document component that displays a paragraph.
ParagraphComponentBuilder
ParagraphComponentViewModel
ParagraphNode
ParagraphPrefixConversionReaction
Base class for EditReactions 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 DocumentNodes 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.
RemoveComposerPreferenceStylesCommand
RemoveComposerPreferenceStylesRequest
RemoveTextAttributionsCommand
Removes the given attributions from the given documentSelection.
RemoveTextAttributionsRequest
RenderContentLayers
RenderObject for a ContentLayers widget.
ReplaceNodeCommand
ReplaceNodeRequest
ReplaceNodeWithEmptyParagraphWithCaretCommand
ReplaceNodeWithEmptyParagraphWithCaretRequest
RequestDispatcher
An object that processes EditRequests.
ScriptAttribution
An attribution for superscript and subscript text.
ScrollableInstrumentation
Connections to, and information about a scrolling experience that's used for visual debugging.
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.
A collection of LayerLinks 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.
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 SingleColumnLayoutViewModels 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.
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.
SplitBlockquoteCommand
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".
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.
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.
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
SuperEditorFocusDebugVisuals
SuperEditorHardwareKeyHandler
Applies appropriate edits to a document and selection when the user presses hardware keys.
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
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.
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
SuperTextFieldScrollview
Handles all scrolling behavior for a text field.
SuperTextFieldScrollviewState
SuperTextFieldState
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 TaskComponentViewModels and TaskComponents for every TaskNode in a document.
TaskComponentViewModel
View model that configures the appearance of a TaskComponent.
TaskNode
This file includes everything needed to add the concept of a task to Super Editor. This includes:
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.
TextInputConnectionDecorator
Base class for TextInputConnection decorators.
TextInsertionEvent
TextLayoutCaret
TextLayoutCaretState
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.
Underlines
A group of text ranges that should be displayed with underlines, along with the style of those underlines.
UnderlineStyle
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.
UserTypedText

Enums

AnimationDirection
AttributionChange
AttributionVisitEvent
DocumentGestureMode
The mode of user gesture input.
DragMode
ExecutionInstruction
HandleType
Type of handle for touch editing.
HintBehavior
Policy that dictates when to display a hint in a Super Text Field.
HistoryBehavior
The way a command interacts with the history ledger, AKA "undo".
LinkUpdatePolicy
Configuration for the action that should happen when a text containing a link attribution is modified, e.g., "google.com" becomes "gogle.com".
ListItemType
OrderedListNumeralStyle
The styling of an ordered list numberal.
PrependedCharacterPolicy
SelectionBound
SelectionChangeType
SelectionHandleType
SelectionType
SpanMarkerType
The type of a marker within a span, either start or end.
SuperTextFieldPlatformConfiguration
Configures a SuperTextField for the given platform.
TapHandlingInstruction
TextFieldKeyboardHandlerResult
TextFieldSizePolicy
TextInputSource
The mode of user text input.
TransactionMerge
ViewportEdge

Mixins

DocumentComponent<T extends StatefulWidget>
Contract for all widgets that operate as document components within a DocumentLayout.
ProxyDocumentComponent<T extends StatefulWidget>
A DocumentComponent that wraps, and defers to, another DocumentComponent.
ProxyTextComposable
TextComposable that wraps, and defers to, a child TextComposable.
SelectionAwareViewModelMixin
Allows a SingleColumnLayoutComponentViewModel to be aware of the selection within its node.
TextComponentViewModel
Mixin for all SingleColumnLayoutComponentViewModels that represent a text-based block, e.g., paragraph, blockquote, list item.

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.
blockquoteAttribution → const NamedAttribution
Blockquote attribution
boldAttribution → const NamedAttribution
Bold style attribution.
codeAttribution → const NamedAttribution
Code style attribution.
defaultActionTagRule → const TagRule
defaultAndroidControlsColor → const Color
defaultComponentBuilders → const List<ComponentBuilder>
Creates visual components for the standard SuperEditor.
defaultDesktopCaretColor → const Color
defaultEditorSelectorHandlers → const Map<String, SuperEditorSelectorHandler>
Map selector names to its handlers.
defaultExtendableTypes → const Set<Type>
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
defaultMergePolicy → const HistoryGroupingPolicyList
The merge policies that are used in the standard Editor construction.
defaultSelectionColor → const Color
defaultSelectionStyle → const SelectionStyles
Default visual styles related to content selection.
defaultSuperEditorDocumentOverlayBuilders → const List<SuperEditorLayerBuilder>
Default list of document overlays that are displayed on top of the document layout in a SuperEditor.
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>
hashTagRule → const TagRule
Default TagRule for hash tags.
header1Attribution → const NamedAttribution
Header 1 style block attribution.
header2Attribution → const NamedAttribution
Header 2 style block attribution.
header3Attribution → const NamedAttribution
Header 3 style block attribution.
header4Attribution → const NamedAttribution
Header 4 style block attribution.
header5Attribution → const NamedAttribution
Header 5 style block attribution.
header6Attribution → const NamedAttribution
Header 6 style block attribution.
italicsAttribution → const NamedAttribution
Italics style attribution.
kTapMinTime → const Duration
kTapTimeout → const Duration
listItemAttribution → const NamedAttribution
mergeRapidTextInputPolicy → const MergeRapidTextInputPolicy
A sane default configuration of a MergeRapidTextInputPolicy.
mergeRepeatSelectionChangesPolicy → const MergeRepeatSelectionChangesPolicy
neverMergePolicy → const _NeverMergePolicy
paragraphAttribution → const NamedAttribution
Plain paragraph block attribution.
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.
underlineAttribution → const NamedAttribution
Underline style attribution.
userTagRule → const TagRule
TagRule for user tags.

Properties

androidTextFieldLog → Logger
final
appleBlockedIntents → Set<Type>
A set of Intents, which Flutter dispatches by default on Apple platforms (macOS and iOS), that should have its associated Actions blocked.
final
attributionsLog → Logger
final
contentLayersLog → Logger
final
copyWhenCmdCIsPressedOnMac → ReadOnlyDocumentKeyboardAction
final
copyWhenCtlCIsPressedOnWindowsAndLinux → ReadOnlyDocumentKeyboardAction
final
defaultEditorReactions → List
final
defaultExtendableStyles → Set<NamedAttribution>
final
defaultImeKeyboardActions → List<DocumentKeyboardAction>
Keyboard actions for a SuperEditor running with IME on desktop.
final
defaultKeyboardActions → List<DocumentKeyboardAction>
Keyboard actions for the standard SuperEditor.
final
defaultRequestHandlers → List
final
defaultStylesheet → Stylesheet
Stylesheet applied to all SuperEditors by default.
final
disableLongPressSelectionForSuperlist ↔ bool
Global flag that disables long-press selection for Android and iOS, as a hack for Superlist, because Superlist has a custom long-press behavior per-component.
getter/setter pair
docGesturesLog → Logger
final
editorActionTagsLog → Logger
final
editorDocLog → Logger
final
editorEditsLog → Logger
final
editorGesturesLog → Logger
final
editorImeConnectionLog → Logger
final
editorImeDeltasLog → Logger
final
editorImeLog → Logger
final
editorIosFloatingCursorLog → Logger
final
editorKeyLog → Logger
final
editorLayoutLog → Logger
final
editorLog → Logger
final
editorOpsLog → Logger
final
editorPatternTagsLog → Logger
final
editorPoliciesLog → Logger
final
editorScrollingLog → Logger
final
editorStableTagsLog → Logger
final
editorStyleLog → Logger
final
editorTagsLog → Logger
final
editorTokensLog → Logger
final
expandSelectionToLineEndWithCtrlEOnWindowsAndLinux → ReadOnlyDocumentKeyboardAction
final
expandSelectionToLineEndWithEndOnWindowsAndLinux → ReadOnlyDocumentKeyboardAction
final
expandSelectionToLineStartWithCtrlAOnWindowsAndLinux → ReadOnlyDocumentKeyboardAction
final
expandSelectionToLineStartWithHomeOnWindowsAndLinux → ReadOnlyDocumentKeyboardAction
final
expandSelectionWithDownArrow → ReadOnlyDocumentKeyboardAction
final
expandSelectionWithLeftArrow → ReadOnlyDocumentKeyboardAction
final
expandSelectionWithRightArrow → ReadOnlyDocumentKeyboardAction
final
expandSelectionWithUpArrow → ReadOnlyDocumentKeyboardAction
final
imeTextFieldLog → Logger
final
infrastructureLog → Logger
final
iosTextFieldLog → Logger
final
longPressSelectionLog → Logger
final
nonAppleBlockedIntents → Set<Type>
A set of Intents, which Flutter dispatches by default on non-Apple platforms (Android, Windows, Linux), that should have its associated Actions blocked.
final
readerDocLog → Logger
final
readerGesturesLog → Logger
final
readerImeLog → Logger
final
readerKeyLog → Logger
final
readerLayoutLog → Logger
final
readerLog → Logger
final
readerOpsLog → Logger
final
readerScrollingLog → Logger
final
readerStyleLog → Logger
final
readOnlyDefaultComponentBuilders → List<ComponentBuilder>
Creates visual components for the standard SuperReader.
final
readOnlyDefaultKeyboardActions → List<ReadOnlyDocumentKeyboardAction>
Keyboard actions for the standard SuperReader.
final
readOnlyDefaultStylesheet → Stylesheet
Stylesheet applied to all SuperReaders by default.
final
removeCollapsedSelectionWhenShiftIsReleased → ReadOnlyDocumentKeyboardAction
Shortcut to remove a document selection when the shift key is released and the selection is collapsed.
final
schedulerLog → Logger
final
scrollDownWithArrowKey → ReadOnlyDocumentKeyboardAction
final
scrollingTextFieldLog → Logger
final
scrollUpWithArrowKey → ReadOnlyDocumentKeyboardAction
final
selectAllWhenCmdAIsPressedOnMac → ReadOnlyDocumentKeyboardAction
final
selectAllWhenCtlAIsPressedOnWindowsAndLinux → ReadOnlyDocumentKeyboardAction
final
taskStyles → StyleRule
Styles all task components to apply top padding
final
textFieldLog → Logger
final

Functions

anyCharacterOrDestructiveKeyToDeleteSelection({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
anyCharacterToInsertInParagraph({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
anyCharacterToInsertInTextContent({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
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.
cmdBToToggleBold({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
cmdIToToggleItalics({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
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({required MutableDocument document, required 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 = true, bool onKeyDown = false, 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) → Widget
Builds a standard editor-style Android floating toolbar.
defaultAttributionsToExtendToNewParagraph(Attribution attribution) → bool
The default Attributions, 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.
defaultHintStyleBuilder(Set<Attribution> attributions) → TextStyle
Creates default TextStyles for hint text in a super text field.
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.
defaultIosReaderToolbarBuilder(BuildContext context, Key floatingToolbarKey, LeaderLink focalPoint, Document document, ValueListenable<DocumentSelection?> selection, SuperReaderIosControlsController editorControlsController) → Widget
Builds a standard reader-style iOS floating toolbar.
defaultListItemIndentCalculator(TextStyle textStyle, int indent) → double
The standard TextBlockIndentCalculator used by list items in SuperEditor.
defaultParagraphIndentCalculator(TextStyle textStyle, int indent) → double
The standard TextBlockIndentCalculator used by paragraphs in SuperEditor.
defaultSelectedTextColorStrategy({required Color originalTextColor, required Color selectionHighlightColor}) → Color
Default SelectedTextColorStrategy, which retains the original text color, regardless of selection color.
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.
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
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.
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.
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.
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
insertNewLine(SuperEditorContext context) → void
insertNewlineInBlockquote({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
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.
mergeNodeWithNextWhenDeleteIsPressed({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
moveCaretDown({required Document document, required DocumentLayout documentLayout, required ValueNotifier<DocumentSelection?> selectionNotifier, 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 Document document, required DocumentLayout documentLayout, required ValueNotifier<DocumentSelection?> selectionNotifier, 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 Document document, required ValueNotifier<DocumentSelection?> selectionNotifier, 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 Document document, required DocumentLayout documentLayout, required ValueNotifier<DocumentSelection?> selectionNotifier, 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(Document document, DocumentLayout documentLayout, ValueNotifier<DocumentSelection?> selection, String nodeId, DocumentComponent<StatefulWidget> component) → void
moveToRightEndOfLine(SuperEditorContext context) → void
moveToRightEndOfLineAndModifySelection(SuperEditorContext context) → void
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.
Parses the text as Uri, prepending "https://" if it doesn't start with "http://" or "https://".
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(Document document, ValueNotifier<DocumentSelection?> selection) → 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
selectParagraphAt({required DocumentPosition docPosition, required DocumentLayout docLayout, required ValueNotifier<DocumentSelection?> selection}) → bool
selectRegion({required DocumentLayout documentLayout, required Offset baseOffsetInDocument, required Offset extentOffsetInDocument, required SelectionType selectionType, bool expandSelection = false, required ValueNotifier<DocumentSelection?> selection}) → 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
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
splitBlockquoteWhenEnterPressed({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
splitListItemWhenEnterPressed({required SuperEditorContext editContext, required KeyEvent keyEvent}) → ExecutionInstruction
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
unIndentListItem(SuperEditorContext context) → void

Typedefs

AttributionBoundsBuilder = Widget? Function(BuildContext context, Attribution attribution)
Builder that (optionally) returns a widget that 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)
DocumentChangeListener = void Function(DocumentChangeLog changeLog)
Listener that's notified when a document changes.
DocumentCollapsedHandleBuilder = Widget Function(BuildContext, Key handleKey, LeaderLink focalPoint)
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, Key upstreamHandleKey, LeaderLink upstreamFocalPoint, Key downstreamHandleKey, LeaderLink downstreamFocalPoint)
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(EditRequest)
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()
HeaderAttributionMapping = Attribution Function(int level)
MagnifierBuilder = Widget Function(BuildContext, IosMagnifierViewModel magnifierInfo, [Key? magnifierKey])
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.
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.
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.