applowy_editor_fork library
AppFlowyEditor library
Classes
- AFMobileIcon
- {@tool snippet} All the icons are from AFMobileIcons enum.
- AppFlowyClipboard
- AppFlowyClipboardData
- AppFlowyDropTargetStyle
-
Style for the Drop target which is rendered in the AppFlowyEditor
using the
DesktopSelectionServicespecifically therenderDropTargetForOffsetmethod. - AppFlowyEditor
- AppFlowyEditorHTMLCodec
- AppFlowyEditorL10n
- AppFlowyEditorLocalizations
- AppFlowyEditorLog
- For logging message in AppFlowyEditor
- AppFlowyEditorMarkdownCodec
- AppFlowyKeyboardService
- AppFlowyKeyboardService is responsible for processing shortcut keys, like command, shift, control keys.
- AppFlowyKeyboardServiceInterceptor
- AppFlowyKeyboardServiceInterceptor is used to intercept the keyboard service.
- AppFlowyLogConfiguration
- Manages log service for AppFlowyEditor
- AppFlowyRichText
- AppFlowyRichTextKeys
- AppFlowyScrollService
- AppFlowyScrollService is responsible for processing document scrolling.
- AppFlowySelectionService
- AppFlowySelectionService is responsible for processing the Selection changes and updates.
- AppLocalizationDelegate
- ApplyOptions
- Immutable transaction history and projection options; owns no resources.
- AtLeastOneEditableNodeRule
- This rule ensures that there is at least one editable node in the document.
- BackgroundColorOptionsWidgets
- BlockComponentActionState
- BlockComponentActionWrapper
- BlockComponentBuilder
- BlockComponentBuilder is used to build a BlockComponentWidget.
- BlockComponentConfiguration
- only for the common config of block component
- BlockComponentContainer
- BlockComponentContainer is a wrapper of block component
- BlockComponentContext
- BlockComponentRenderer
- BlockComponentRendererService
- BlockComponentStatefulWidget
- BlockComponentStatelessWidget
- BlockSelectionArea
- BlockSelectionArea is a widget that renders the selection area or the cursor of a block.
- BlockSelectionContainer
- BuiltInAttributeKey
- Supported partial rendering types: bold, italic, underline, strikethrough, textColor, highlightColor, href, formula
- BulletedListBlockComponentBuilder
- BulletedListBlockComponentWidget
- BulletedListBlockKeys
- BulletedListNodeParser
- CharacterShortcutEvent
- Defines the implementation of shortcut event based on character.
- CheckSingleFormatFormatResult
- ClearColorButton
- CodeBlockNodeParser
- ColorButton
- ColorOption
- ColorPicker
- ColumnBlockComponent
- ColumnBlockComponentBuilder
- ColumnBlockComponentState
- ColumnBlockKeys
- ColumnsBlockComponent
- ColumnsBlockComponentBuilder
- ColumnsBlockComponentState
- ColumnsBlockKeys
- CommandShortcutEvent
- Defines the implementation of shortcut event based on command.
- ContextMenu
- ContextMenuItem
- Counters
- Used by the WordCountService to contain count statistics in eg. a Document or in the current Selection.
- CustomColorItem
- CustomMarkdownParser
- Debounce
- DeleteOperation
- DeleteOperation represents a delete operation.
- Delta
- Deltas are a simple, yet expressive format that can be used to describe contents and changes. The format is JSON based, and is human readable, yet easily parsible by machines. Deltas can describe any rich text document, includes all text and formatting information, without the ambiguity and complexity of HTML.
- DeltaHTMLEncoder
- A Delta encoder that encodes a Delta to html.
- DeltaMarkdownDecoder
- DeltaMarkdownEncoder
- A Delta encoder that encodes a Delta to Markdown.
- DeltaTextInputService
- DividerBlockComponentBuilder
- DividerBlockComponentWidget
- DividerBlockKeys
- DividerNodeParser
- Document
- Document represents an AppFlowy Editor document structure.
- DocumentHTMLDecoder
- DocumentHTMLEncoder
- DocumentMarkdownDecoder
- DocumentMarkdownEncoder
- DocumentRule
- DocumentV0
- ⚠️ THIS FILE HAS BEEN DEPRECATED. ⚠️ THIS FILE HAS BEEN DEPRECATED. ⚠️ THIS FILE HAS BEEN DEPRECATED.
- DragAreaBuilderData
- DropTargetRenderData
- Data returned when calling AppFlowySelectionService.getDropTargetRenderData
- EditorHistoryDelegate
- Borrowed history commands for a host that owns durable collaboration history. The host handles asynchronous failures and releases its own resources. Local editors omit this delegate and retain the built-in path history.
- EditorScrollController
- This class controls the scroll behavior of the editor.
- EditorService
- EditorState
- The state of the editor.
- EditorStateDebugInfo
- EditorStyle
- The style of the editor.
- EditorSvg
- FindReplaceLocalizations
- FindReplaceStyle
- FloatingToolbar
- A floating toolbar that displays at the top of the editor when the selection and will be hidden when the selection is collapsed.
- FloatingToolbarStyle
- FloatingToolbarWidget
- FullScreenOverlayEntry
- HeadingBlockComponentBuilder
- HeadingBlockComponentWidget
- HeadingBlockKeys
- HeadingNodeParser
- HeadingUnit
- HTMLBulletedListNodeParser
- HTMLHeadingNodeParser
- HTMLImageNodeParser
- HTMLNodeParser
- HTMLNumberedListNodeParser
- HTMLQuoteNodeParser
- HtmlTableNodeParser
- HTMLTags
- HTMLTextNodeParser
- HTMLTodoListNodeParser
- ImageBlockComponentBuilder
- ImageBlockComponentWidget
- ImageBlockComponentWidgetState
- ImageBlockKeys
- ImageNodeParser
- InsertOperation
- InsertOperation represents an insert operation.
- KeepEditorFocusNotifier
- Keybinding
- KeyboardServiceWidget
- KeyboardServiceWidgetState
- LinkEditForm
- ListUnit
- MarkdownBlockQuoteParserV2
- MarkdownDividerParserV2
- MarkdownHeadingParserV2
- MarkdownImageParserV2
- MarkdownOrderedListItemParserV2
- MarkdownOrderedListParserV2
- MarkdownParagraphParserV2
- MarkdownTableListParserV2
- MarkdownTodoListParserV2
- MarkdownUnorderedListItemParserV2
- MarkdownUnorderedListParserV2
- MobileFloatingToolbar
- A mobile floating toolbar that displays at the top of the editor when the selection is not collapsed. and will be hidden when the selection is collapsed.
- MobileFloatingToolbarItem
- MobileLinkMenu
- MobileToolbar
- MobileToolbarItem
- MobileToolbarItemMenu
- MobileToolbarItemMenuBtn
- MobileToolbarTheme
- Style for the mobile toolbar.
- MobileToolbarV2
- MobileToolbarWidget
- MobileToolbarWidgetService
- To update the state of the MobileToolbarWidget
- MobileToolbarWidgetState
- NestedListWidget
- Node
- Node represents a node in the document tree.
- NodeExternalValues
- NodeIterator
- NodeIterator is used to traverse the nodes in visual order.
- NodeParser
- NodeV0
- ⚠️ THIS FILE HAS BEEN DEPRECATED. ⚠️ THIS FILE HAS BEEN DEPRECATED. ⚠️ THIS FILE HAS BEEN DEPRECATED.
- NumberedListBlockComponentBuilder
- NumberedListBlockComponentWidget
- NumberedListBlockKeys
- NumberedListNodeParser
- Operation
- Operation represents a change to a Document.
- PageBlockComponent
- Root renderer that borrows editor services and keeps footer space outside document nodes.
- PageBlockComponentBuilder
- Renders root pages with an optional minimum height before their footer.
- PageBlockKeys
- ParagraphBlockComponentBuilder
- ParagraphBlockComponentWidget
- ParagraphBlockKeys
- PdfHTMLEncoder
- This class handles conversion from html to pdf
- Position
-
PropertyValueNotifier<
T> - PropertyValueNotifier is a subclass of ValueNotifier.
- QuillDeltaEncoder
- QuoteBlockComponentBuilder
- QuoteBlockComponentWidget
- QuoteBlockKeys
- QuoteNodeParser
- RemoteBlockSelectionArea
- RemoteBlockSelectionArea is a widget that renders the selection area or the cursor of a block from remote.
- RemoteBlockSelectionsArea
- RemoteSelection
- ResetColorButton
- ResizableImage
- ScrollServiceWidget
- SearchServiceV3
- Selection
- Selection represents the selected area or the cursor area in the editor.
- SelectionGestureInterceptor
- SelectionMenu
- SelectionMenuIconWidget
- SelectionMenuItem
- Selection Menu Item
- SelectionMenuItemWidget
- SelectionMenuService
- SelectionMenuStyle
- SelectionMenuWidget
- SelectionServiceWidget
- SliverGridDelegateWithFixedCrossAxisCountAndFixedHeight
- SVGIconItemWidget
- TableActions
- TableBlockComponentBuilder
- TableBlockComponentWidget
- TableBlockKeys
- TableCelBlockWidget
- TableCellBlockComponentBuilder
- TableCellBlockKeys
- TableDefaults
- TableNode
- TableNodeParser
- TableStyle
- TextColorOptionsWidgets
- TextDecorationUnit
- TextDelete
- TextInsert
- TextNode
- TextNodeParser
- TextNodeV0
- TextOperation
- TextRetain
- TextStyleConfiguration
- only for the common config of text style
- TodoListBlockComponentBuilder
- TodoListBlockComponentWidget
- TodoListBlockKeys
- TodoListNodeParser
- ToggleColorsStyle
- ToolbarItem
- Transaction
- A Transaction has a list of Operation objects that will be applied to the editor.
- UpdateOperation
- UpdateOperation represents an attributes update operation.
- UpdateTextOperation
- UpdateTextOperation represents a text update operation.
- UploadImageMenu
- WordCountService
- A Word Counter service that runs based on the changes and updates to an EditorState.
Enums
- AFMobileIcons
- AppFlowyEditorLogLevel
- BlockSelectionType
- CursorStyle
- CursorUpdateReason
- DoubleCharacterFormatStyle
- FormatStyleByWrappingWithSingleChar
- ImageFromFileStatus
- MarkdownListType
- NestedListMode
- SelectionMoveDirection
- SelectionMoveRange
- SelectionRange
- SelectionType
- SelectionUpdateReason
- TableDirection
- TransactionTime
Mixins
- BlockComponentAlignMixin
- BlockComponentBackgroundColorMixin
-
BlockComponentConfigurable<
T extends StatefulWidget> -
BlockComponentSelectable<
T extends BlockComponentBuilder> - BlockComponentTextDirectionMixin
- BlockComponentWidget
- DefaultSelectableMixin
-
NestedBlockComponentStatefulWidgetMixin<
T extends BlockComponentStatefulWidget> -
SelectableMixin<
T extends StatefulWidget> - SelectableMixin is used for the editor to calculate the position and size of the selection.
Extensions
- AlignmentExtension on Alignment
- AppFlowyRichTextAttributes on Attributes
- AppFlowyTextAlign on Alignment
- AttributesDelta on Delta
- ColorExtension on String
- ColorExtension2 on Color
- EditorCopyPaste on EditorState
- EditorStateSelectable on EditorState
- FlowyObjectExtensions on Object
- HeaderSize on int
- HexExtension on Color
- InsertImage on EditorState
-
KeybindingsExtension
on List<
Keybinding> - NodeAttributesExtensions on Attributes
-
NodeEquality
on Iterable<
Node> - NodeExtensions on Node
-
NodesExtensions
on List<
T> -
NodeV0Equality
on Iterable<
NodeV0> - PathExtensions on Path
- PositionExtension on Position
- SelectionTransform on EditorState
- TextSpanExtensions on TextSpan
- TextStyleExtensions on TextStyle
- Combines text styles while preserving the receiving style's defaults.
- TextTransaction on Transaction
- TextTransforms on EditorState
-
ValidIndexedValueNotifier
on ValueNotifier<
(int, int)>
Constants
- appFlowyEditorAutoScrollEdgeOffset → const double
- The default value of the auto scroll edge offset on mobile The editor will scroll when the cursor is close to the edge of the screen
- blockComponentAlign → const String
- text align
- blockComponentBackgroundColor → const String
- the background of the block component
- blockComponentDelta → const String
- the delta of the block component
- blockComponentTextDirection → const String
- the text direction of the block component
- blockComponentTextDirectionAuto → const String
- blockComponentTextDirectionLTR → const String
- blockComponentTextDirectionRTL → const String
- errorBlockComponentBuilderKey → const String
- floatingToolbarContainerKey → const Key
- floatingToolbarItemPrefixKey → const String
- placeholderItemId → const String
- selectionExtraInfoDisableFloatingToolbar → const String
- selectionExtraInfoDisableMobileToolbarKey → const String
- selectionExtraInfoDisableToolbar → const String
- selectionExtraInfoDoNotAttachTextService → const String
- the type of this value is bool.
- standardBlockComponentConfiguration → const BlockComponentConfiguration
Properties
-
alignmentItems
→ List<
ToolbarItem> -
final
- appflowyEditorSliceAttributes ↔ AppFlowyEditorSliceAttributes?
-
Default slice attributes function.
getter/setter pair
-
arrowDownKeys
→ List<
CommandShortcutEvent> -
final
-
arrowLeftKeys
→ List<
CommandShortcutEvent> -
final
-
arrowRightKeys
→ List<
CommandShortcutEvent> -
final
-
arrowUpKeys
→ List<
CommandShortcutEvent> -
final
-
autoCompletableBlockTypes
→ Set<
String> -
final
- backspaceCommand → CommandShortcutEvent
-
Backspace key event.
final
- backSpaceInTableCell → CommandShortcutEvent
-
final
- blockComponentDecorator ↔ BlockComponentBackgroundColorDecorator?
-
getter/setter pair
- blocksMobileToolbarItem → MobileToolbarItem
-
The mobile menu for converting selected blocks to headings, lists, or quotes.
final
- bulletedListItem → ToolbarItem
-
final
- codeMobileToolbarItem → MobileToolbarItem
-
The mobile action that toggles inline code on the current selection.
final
-
convertibleBlockTypes
→ List<
String> -
final
- convertMinusesToDivider → CharacterShortcutEvent
-
insert divider into a document by typing three dashes (-)
or one em dash (—) and one dash (-)
final
- convertStarsToDivider → CharacterShortcutEvent
-
final
- convertToParagraphCommand → CommandShortcutEvent
-
Convert to paragraph command.
final
- convertUnderscoreToDivider → CharacterShortcutEvent
-
final
- copyCommand → CommandShortcutEvent
-
Copy.
final
- cutCommand → CommandShortcutEvent
-
cut.
final
- defaultAppFlowyEditorSliceAttributes ↔ AppFlowyEditorSliceAttributes?
-
Default slice attributes function.
getter/setter pair
- deleteCommand → CommandShortcutEvent
-
Delete key event.
final
- deleteLeftSentenceCommand → CommandShortcutEvent
-
Remove Line to the Left.
final
- deleteLeftWordCommand → CommandShortcutEvent
-
Delete key event.
final
- deleteRightWordCommand → CommandShortcutEvent
-
final
- deltaHTMLEncoder → DeltaHTMLEncoder
-
final
- dividerMenuItem ↔ SelectionMenuItem
-
The menu item that inserts a divider and paragraph at a collapsed selection.
getter/setter pair
- dividerMobileToolbarItem → MobileToolbarItem
-
The mobile action that inserts a divider at a collapsed selection.
final
- downInTableCell → CommandShortcutEvent
-
final
-
editorLaunchUrl
↔ Future<
bool> Function(String? href) -
getter/setter pair
- endCommand → CommandShortcutEvent
-
End key event.
final
- enterInTableCell → CommandShortcutEvent
-
final
- exitEditingCommand → CommandShortcutEvent
-
End key event.
final
- forceShowBlockAction ↔ bool
-
getter/setter pair
- formatAsteriskToBulletedList ↔ CharacterShortcutEvent
-
Convert '* ' to bulleted list
getter/setter pair
- formatAsteriskToItalic → CharacterShortcutEvent
-
format the text surrounded by single asterisk to italic
final
- formatBackquoteToCode → CharacterShortcutEvent
-
format the text surrounded by single backquote to code
final
- formatDoubleAsterisksToBold → CharacterShortcutEvent
-
format the text surrounded by double asterisks to bold
final
- formatDoubleHyphenEmDash → CharacterShortcutEvent
-
format two hyphens into an em dash
final
- formatDoubleQuoteToQuote ↔ CharacterShortcutEvent
-
Convert '" ' to quote
getter/setter pair
- formatDoubleTilesToStrikethrough → CharacterShortcutEvent
-
format the text surrounded by double asterisks to bold
final
- formatDoubleUnderscoresToBold → CharacterShortcutEvent
-
format the text surrounded by double underscores to bold
final
- formatEmptyBracketsToUncheckedBox ↔ CharacterShortcutEvent
-
Convert '[] ' to unchecked todo list
getter/setter pair
- formatFilledBracketsToCheckedBox ↔ CharacterShortcutEvent
-
Convert '
x' to checked todo listgetter/setter pair - formatGreaterEqual → CharacterShortcutEvent
-
format '=' + '>' into an ⇒
final
- formatGreaterHyphen → CharacterShortcutEvent
-
format '-' + '>' into an →
final
- formatHyphenEmptyBracketsToUncheckedBox ↔ CharacterShortcutEvent
-
Convert '-[] ' to unchecked todo list
getter/setter pair
- formatHyphenFilledBracketsToCheckedBox ↔ CharacterShortcutEvent
-
Convert '-
x' to checked todo listgetter/setter pair - formatMarkdownLinkToLink → CharacterShortcutEvent
-
format the markdown link syntax to hyperlink
final
- formatMinusToBulletedList ↔ CharacterShortcutEvent
-
Convert '- ' to bulleted list
getter/setter pair
- formatNumberToNumberedList ↔ CharacterShortcutEvent
-
Convert 'num. ' to bulleted list
getter/setter pair
- formatSignToHeading ↔ CharacterShortcutEvent
-
Convert '# ' to bulleted list
getter/setter pair
- formatTildeToStrikethrough ↔ CharacterShortcutEvent
-
format the text surrounded by single tilde to strikethrough
getter/setter pair
- formatUnderscoreToItalic ↔ CharacterShortcutEvent
-
format the text surrounded by single underscore to italic
getter/setter pair
-
headingItems
↔ List<
ToolbarItem> -
getter/setter pair
- headingMobileToolbarItem → MobileToolbarItem
-
The mobile menu for choosing a heading level for selected blocks.
final
- homeCommand → CommandShortcutEvent
-
Home key event.
final
-
indentableBlockTypes
→ Set<
String> -
final
- indentCommand → CommandShortcutEvent
-
Indent the current block
final
- insertNewLine → CharacterShortcutEvent
-
insert a new line block
final
- insertNewLineAfterBulletedList ↔ CharacterShortcutEvent
-
Insert a new block after the bulleted list block.
getter/setter pair
- insertNewLineAfterHeading ↔ CharacterShortcutEvent
-
Insert a new block after the heading block.
getter/setter pair
- insertNewLineAfterNumberedList ↔ CharacterShortcutEvent
-
Insert a new block after the numbered list block.
getter/setter pair
- insertNewLineAfterTodoList ↔ CharacterShortcutEvent
-
Insert a new block after the todo list block.
getter/setter pair
- keepEditorFocusNotifier ↔ KeepEditorFocusNotifier
-
getter/setter pair
-
keyToCodeMapping
↔ Map<
String, int> -
Keyboard key to keycode mapping table
getter/setter pair
- leftInTableCell → CommandShortcutEvent
-
final
- linkItem → ToolbarItem
-
final
- linkMobileToolbarItem → MobileToolbarItem
-
The mobile menu for editing a link at the current selection.
final
- listMobileToolbarItem → MobileToolbarItem
-
The mobile menu for switching selected blocks between bullet and number lists.
final
-
markdownFormatItems
→ List<
ToolbarItem> -
final
-
markdownSyntaxShortcutEvents
→ List<
CharacterShortcutEvent> -
final
- moveCursorBeginSelectCommand → CommandShortcutEvent
-
final
- moveCursorBottomCommand ↔ CommandShortcutEvent
-
arrow down + ctrl or cmd
move the cursor to the bottommost position of the document
getter/setter pair
- moveCursorBottomSelectCommand ↔ CommandShortcutEvent
-
arrow down + shift + ctrl or cmd
move the cursor to the bottommost position of the document and select everything in between
getter/setter pair
- moveCursorDownCommand → CommandShortcutEvent
-
Arrow down key events.
final
- moveCursorDownSelectCommand ↔ CommandShortcutEvent
-
arrow down + shift
moves vertically down one line and selects everything between
getter/setter pair
- moveCursorEndSelectCommand → CommandShortcutEvent
-
final
- moveCursorLeftCommand → CommandShortcutEvent
-
Arrow left key events.
final
- moveCursorLeftSelectCommand → CommandShortcutEvent
-
final
- moveCursorLeftWordSelectCommand → CommandShortcutEvent
-
final
- moveCursorRightCommand → CommandShortcutEvent
-
Arrow right key events.
final
- moveCursorRightSelectCommand → CommandShortcutEvent
-
final
- moveCursorRightWordSelectCommand → CommandShortcutEvent
-
final
- moveCursorToBeginCommand → CommandShortcutEvent
-
final
- moveCursorToEndCommand → CommandShortcutEvent
-
final
- moveCursorToLeftWordCommand → CommandShortcutEvent
-
final
- moveCursorTopCommand → CommandShortcutEvent
-
arrow up + ctrl or cmd
move the cursor to the topmost position of the document
final
- moveCursorTopSelectCommand → CommandShortcutEvent
-
arrow up + shift + ctrl or cmd
move the cursor to the topmost position of the document and select everything in between
final
- moveCursorToRightWordCommand → CommandShortcutEvent
-
final
- moveCursorUpCommand → CommandShortcutEvent
-
Arrow up key events.
final
- moveCursorUpSelectCommand → CommandShortcutEvent
-
arrow up + ctrl or cmd
moves vertically down one line and selects everything between
final
- numberedListItem → ToolbarItem
-
final
- openInlineLinkCommand → CommandShortcutEvent
-
Option/Alt + Enter: to open inline link
final
- openLinksCommand → CommandShortcutEvent
-
Option/Alt + Shift + Enter: to open links
final
- outdentCommand → CommandShortcutEvent
-
Outdent the current block
final
- pageDownCommand → CommandShortcutEvent
-
Page down key event.
final
- pageUpCommand → CommandShortcutEvent
-
Page up key event.
final
- paragraphItem → ToolbarItem
-
final
- pasteCommand → CommandShortcutEvent
-
Paste.
final
-
pasteCommands
→ List<
CommandShortcutEvent> -
final
- pasteTextWithoutFormattingCommand → CommandShortcutEvent
-
final
- placeholderItem → ToolbarItem
-
The always-visible vertical separator for desktop toolbar groups.
final
- quillDeltaEncoder → QuillDeltaEncoder
-
final
- quoteItem → ToolbarItem
-
final
- quoteMobileToolbarItem → MobileToolbarItem
-
The mobile action that toggles quote formatting on selected blocks.
final
- redoCommand → CommandShortcutEvent
-
Redo key event.
final
- rightInTableCell → CommandShortcutEvent
-
final
- selectAllCommand → CommandShortcutEvent
-
Select all key event.
final
- shiftTabInTableCell → CommandShortcutEvent
-
final
- showLinkMenuCommand → CommandShortcutEvent
-
Cmd / Ctrl + K: show link menu
final
-
singleColumnVisibleMenuItems
→ List<
SelectionMenuItem> -
The paragraph and heading insertion items available in a single column.
final
- slashCommand → CharacterShortcutEvent
-
Show the slash menu
final
-
standardBlockComponentBuilderMap
→ Map<
String, BlockComponentBuilder> -
final
-
standardCharacterShortcutEvents
→ List<
CharacterShortcutEvent> -
final
-
standardCommandShortcutEvents
→ List<
CommandShortcutEvent> -
final
-
standardContextMenuItems
→ List<
List< ContextMenuItem> > -
final
-
standardSelectionMenuItems
→ List<
SelectionMenuItem> -
The default block insertion items, with names resolved from the current locale.
final
- tabInTableCell → CommandShortcutEvent
-
final
-
tableCommands
→ List<
CommandShortcutEvent> -
final
- tableMenuItem ↔ SelectionMenuItem
-
The menu item that inserts a two-by-two table at a collapsed selection.
getter/setter pair
- tabToAutoCompleteCommand → CommandShortcutEvent
-
Auto complete the current block
final
- textDecorationMobileToolbarItem → MobileToolbarItem
-
The mobile menu for bold, italic, underline, and strikethrough formatting.
final
- textDecorationMobileToolbarItemV2 → MobileToolbarItem
-
The mobile text-formatting menu including inline code alongside decorations.
final
-
textDirectionItems
→ List<
ToolbarItem> -
final
- todoListMobileToolbarItem → MobileToolbarItem
-
The mobile action that toggles todo-list formatting on selected blocks.
final
- toggleBoldCommand → CommandShortcutEvent
-
Markdown key event.
final
- toggleCodeCommand → CommandShortcutEvent
-
final
- toggleHighlightCommand → CommandShortcutEvent
-
final
- toggleItalicCommand → CommandShortcutEvent
-
final
-
toggleMarkdownCommands
→ List<
CommandShortcutEvent> -
final
- toggleStrikethroughCommand → CommandShortcutEvent
-
final
- toggleTodoListCommand → CommandShortcutEvent
-
Arrow down key events.
final
- toggleUnderlineCommand → CommandShortcutEvent
-
final
-
toolbarItemWhiteList
→ Set<
String> -
final
- undoCommand → CommandShortcutEvent
-
Undo key event.
final
- upInTableCell → CommandShortcutEvent
-
final
Functions
-
buildHighlightColorItem(
{List< ColorOption> ? colorOptions}) → ToolbarItem -
buildMobileToolbarMenuGridDelegate(
{required MobileToolbarTheme mobileToolbarStyle, required int crossAxisCount}) → SliverGridDelegate -
buildTextAndBackgroundColorMobileToolbarItem(
{List< ColorOption> ? textColorOptions, List<ColorOption> ? backgroundColorOptions}) → MobileToolbarItem - Builds a toolbar menu for text and background colors.
-
buildTextColorItem(
{List< ColorOption> ? colorOptions}) → ToolbarItem -
bulletedListNode(
{String? text, Delta? delta, String? textDirection, Attributes? attributes, Iterable< Node> ? children}) → Node - Creates a bulleted list node and merges optional block data.
-
calculateNodeDirection(
{required Node node, required TextDirection layoutDirection, String? defaultTextDirection, TextDirection? lastDirection}) → TextDirection - Calculate the text direction of a node.
-
checkSingleCharacterFormatShouldBeApplied(
{required EditorState editorState, required Selection selection, required String character, required FormatStyleByWrappingWithSingleChar formatStyle}) → (bool, CheckSingleFormatFormatResult?) - Check if the single character format should be applied.
-
columnNode(
{List< Node> ? children, double? width}) → Node -
columnsNode(
{List< Node> ? children}) → Node -
composeAttributes(
Attributes? base, Attributes? other, {dynamic keepNull = false}) → Attributes? -
customSlashCommand(
List< SelectionMenuItem> items, {bool shouldInsertSlash = true, bool deleteKeywordsByDefault = false, bool singleColumn = true, SelectionMenuStyle style = SelectionMenuStyle.light, Set<String> supportSlashMenuNodeTypes = _defaultSupportSlashMenuNodeTypes}) → CharacterShortcutEvent -
customToggleHighlightCommand(
{required ToggleColorsStyle style}) → CommandShortcutEvent -
defaultTextSpanDecoratorForAttribute(
BuildContext context, Node node, int index, TextInsert text, TextSpan before, TextSpan after) → TextSpan - Support Desktop and Web platform
-
deleteSelectedContent(
EditorState editorState) → Future< void> -
determineTextDirection(
String text) → TextDirection? -
diffAttributes(
Map< String, dynamic> ? from, Map<String, dynamic> ? to) → Attributes? -
diffDocuments(
Document oldDocument, Document newDocument) → List< Operation> -
diffNodes(
Node oldNode, Node newNode) → List< Operation> -
dividerNode(
) → Node -
documentToHTML(
Document document, {List< HTMLNodeParser> customParsers = const []}) → String - Converts a Document to html.
-
documentToMarkdown(
Document document, {List< NodeParser> customParsers = const [], String lineBreak = ''}) → String - Converts a Document to markdown.
-
findAndReplaceCommands(
{FindReplaceLocalizations? localizations, required BuildContext context, FindReplaceStyle? style}) → List< CommandShortcutEvent> -
formatFontColor(
EditorState editorState, Selection? selection, String? color, {bool withUpdateSelection = false}) → void -
formatHighlightColor(
EditorState editorState, Selection? selection, String? color, {bool withUpdateSelection = false}) → void -
formatMarkdownSymbol(
EditorState editorState, bool shouldFormat(Node node), bool predicate(Node node, String text, Selection selection), List< Node> nodesBuilder(String text, Node node, Delta delta)) → Future<bool> - Formats the current node to specified markdown style.
-
generateHighlightColorOptions(
) → List< ColorOption> - Default background color options when no option is provided
-
generateTextColorOptions(
) → List< ColorOption> - Default text color options when no option is provided
-
handleCopy(
EditorState editorState) → void -
handleCut(
EditorState editorState) → void -
- delete selected content
-
handleFormatByWrappingWithDoubleCharacter(
{required EditorState editorState, required String character, required DoubleCharacterFormatStyle formatStyle}) → bool -
handleFormatByWrappingWithSingleCharacter(
{required EditorState editorState, required String character, required FormatStyleByWrappingWithSingleChar formatStyle}) → bool -
handleFormatMarkdownLinkToLink(
{required EditorState editorState}) → bool -
handlePaste(
EditorState editorState) → void -
handlePastePlainText(
EditorState editorState, String plainText) → void -
hashAttributes(
Attributes base) → int -
headingNode(
{required int level, String? text, Delta? delta, String? textDirection, Attributes? attributes}) → Node - Creates a heading node with a level from one through six.
-
htmlToDocument(
String html, {Map< String, ElementParser> customDecoders = const {}}) → Document - Converts a html to Document.
-
imageNode(
{required String url, String align = 'center', double? height, double? width}) → Node -
insertBulletedListAfterSelection(
EditorState editorState) → void -
insertCheckboxAfterSelection(
EditorState editorState) → void -
insertHeadingAfterSelection(
EditorState editorState, int level) → void -
insertNewLineInType(
EditorState editorState, String type, {Attributes attributes = const {}}) → Future< bool> -
insertNodeAfterSelection(
EditorState editorState, Node node) → bool -
insertNumberedListAfterSelection(
EditorState editorState) → void -
insertQuoteAfterSelection(
EditorState editorState) → void -
invertAttributes(
Attributes? from, Attributes? to) → Attributes -
isAttributesEqual(
Attributes? a, Attributes? b) → bool -
isIndentable(
EditorState editorState) → bool -
isOutdentable(
EditorState editorState) → bool -
isRTL(
EditorState editorState) → bool -
isValidPosition(
int col, int row, int numCols, int numRows) → bool -
markdownToDocument(
String markdown, {List< CustomMarkdownParser> markdownParsers = const [], List<InlineSyntax> inlineSyntaxes = const []}) → Document - Converts a markdown to Document.
-
mobileTextSpanDecoratorForAttribute(
BuildContext context, Node node, int index, TextInsert text, TextSpan before, TextSpan after) → TextSpan - Support mobile platform
-
newCellNode(
Node tableNode, dynamic n) → dynamic -
numberedListNode(
{Delta? delta, Attributes? attributes, int? number, String? textDirection, Iterable< Node> ? children}) → Node - Creates a numbered list node from optional attributes and child nodes.
-
onlyShowInSingleSelectionAndTextType(
EditorState editorState) → bool -
onlyShowInTextType(
EditorState editorState) → bool -
openFindDialog(
{FindReplaceLocalizations? localizations, required BuildContext context, required FindReplaceStyle style}) → CommandShortcutEvent - Show the slash menu
-
openReplaceDialog(
{FindReplaceLocalizations? localizations, required BuildContext context, required FindReplaceStyle style}) → CommandShortcutEvent -
pageNode(
{required Iterable< Node> children, Attributes attributes = const {}}) → Node -
paragraphNode(
{String? text, Delta? delta, String? textDirection, Attributes? attributes, Iterable< Node> children = const []}) → Node - Creates a paragraph node with optional structured text and nested nodes.
-
parseElementChildren(
List< Node> ? elementChildren, List<CustomMarkdownParser> parsers, {MarkdownListType listType = MarkdownListType.unknown, int? startNumber}) → List<Node> -
pasteHTML(
EditorState editorState, String html) → void -
quoteNode(
{Delta? delta, String? textDirection, Attributes? attributes, Iterable< Node> ? children}) → Node - Creates a quote node with optional structured text and nested nodes.
-
safeLaunchUrl(
String? href) → Future< bool> -
showColorMenu(
BuildContext context, EditorState editorState, Selection selection, {String? currentColorHex, List< ColorOption> ? textColorOptions, List<ColorOption> ? highlightColorOptions, required bool isTextColor, bool showClearButton = false}) → void -
showImageMenu(
OverlayState container, EditorState editorState, OnInsertImage? onInsertImage}) → void -
showLinkMenu(
BuildContext context, EditorState editorState, Selection selection, bool isHref) → void -
sliceNode(
Node node, int selectionIndex) → (Node, Node?) -
stringify(
Node node) → String -
tableCellNode(
String text, int rowPosition, int colPosition) → Node -
todoListNode(
{required bool checked, String? text, Delta? delta, String? textDirection, Attributes? attributes, Iterable< Node> ? children}) → Node - Creates a todo list node with its initial checked state.
-
toggleColorCommands(
{ToggleColorsStyle? style}) → List< CommandShortcutEvent> - Toggle Color Commands
-
transformOperation(
Operation a, Operation b) → Operation? -
transformPath(
Path preInsertPath, Path b, [int delta = 1]) → Path
Typedefs
- AppFlowyAutoCompleteTextProvider = String? Function(BuildContext context, Node node, TextSpan? textSpan)
- AppFlowyEditorLogHandler = void Function(String message)
- AppFlowyEditorSliceAttributes = Attributes? Function(Delta delta, int index)
- AppFlowyTextSpanDecorator = TextSpan Function(TextSpan textSpan)
-
AppFlowyTextSpanOverlayBuilder
= List<
Widget> Function(BuildContext context, Node node, SelectableMixin<StatefulWidget> delegate) -
Attributes
= Map<
String, dynamic> - Attributes is used to describe the Node's information.
- BlockActionBuilder = Widget Function(BlockComponentContext blockComponentContext, BlockComponentActionState state)
- BlockActionTrailingBuilder = Widget Function(BlockComponentContext blockComponentContext, BlockComponentActionState state)
- BlockComponentActionBuilder = Widget Function(BuildContext context, BlockComponentActionState state)
- BlockComponentActionTrailingBuilder = Widget Function(BuildContext context, BlockComponentActionState state)
- BlockComponentBackgroundColorDecorator = Decoration? Function(Node node, String colorString)
- If you want to customize the logic of how to convert a color string to a Color, you can set this variable.
- BlockComponentTextStyleBuilder = TextStyle Function(Node node, {TextSpan? textSpan})
- BlockComponentValidate = bool Function(Node node)
- BlockComponentWrapper = Widget Function(BuildContext context, {required Widget child, required Node node})
-
CharacterShortcutEventHandler
= Future<
bool> Function(EditorState editorState) -
CharacterShortcutEventHandlerWithCharacter
= Future<
bool> Function(EditorState editorState, String character) - CommandShortcutEventHandler = KeyEventResult Function(EditorState editorState)
- ContextMenuWidgetBuilder = Widget Function(BuildContext context, Offset position, EditorState editorState, VoidCallback onPressed)
- DividerBlockWrapper = Widget Function(BuildContext context, Node node, Widget child)
- DragAreaBuilder = Widget Function(BuildContext context, DragAreaBuilderData data)
- DragTargetNodeInterceptor = Node Function(BuildContext context, Node node)
- EditorTransactionValue = (TransactionTime, Transaction, ApplyOptions)
-
ElementParser
= Iterable<
Node> Function(Element element, (Delta, Iterable<Node> ) parseDeltaElement(Element element, {String? type})) - FloatingToolbarBuilder = Widget Function(BuildContext context, Widget child, VoidCallback onDismiss, bool isMetricsChanged)
- ImageBlockComponentMenuBuilder = Widget Function(Node node, ImageBlockComponentWidgetState state)
- MobileToolbarItemActionHandler = void Function(BuildContext context, EditorState editorState)
- MobileToolbarItemIconBuilder = Widget? Function(BuildContext context, EditorState editorState, MobileToolbarWidgetService service)
- NumberedListIconBuilder = Widget Function(BuildContext context, Node node, TextDirection direction)
- OnInsertImage = void Function(String url)
-
Path
= List<
int> - PlaceHolderItemBuilder = ToolbarItem Function(BuildContext context)
- SelectionMenuItemHandler = void Function(EditorState editorState, BuildContext context)
- SelectionMenuItemNameBuilder = Widget Function(String name, SelectionMenuStyle style, bool isSelected)
- ShowPlaceholder = bool Function(EditorState editorState, Node node)
- TableBlockCellComponentColorBuilder = Color? Function(BuildContext context, Node node)
- TableBlockComponentMenuBuilder = Widget Function(Node, EditorState, int, TableDirection, VoidCallback? , VoidCallback? )
- TextSpanDecoratorForAttribute = InlineSpan Function(BuildContext context, Node node, int index, TextInsert text, TextSpan before, TextSpan after)
- TodoListIconBuilder = Widget Function(BuildContext context, Node node, VoidCallback onCheck)
- ToolbarItemEventHandler = void Function(EditorState editorState, BuildContext context)
- ToolbarItemHighlightCallback = bool Function(EditorState editorState)
- ToolbarItemValidator = bool Function(EditorState editorState)
- ToolbarTooltipBuilder = Widget Function(BuildContext context, String id, String message, Widget child)