AppFlowyEditor class

Inheritance

Constructors

AppFlowyEditor({Key? key, required EditorState editorState, Map<String, BlockComponentBuilder>? blockComponentBuilders, List<CharacterShortcutEvent>? characterShortcutEvents, List<CommandShortcutEvent>? commandShortcutEvents, List<List<ContextMenuItem>>? contextMenuItems, ContentInsertionConfiguration? contentInsertionConfiguration, bool editable = true, bool autoFocus = false, Selection? focusedSelection, bool shrinkWrap = false, bool showMagnifier = true, EditorScrollController? editorScrollController, EditorStyle editorStyle = const EditorStyle.desktop(), Widget? header, Widget? footer, FocusNode? focusNode, bool enableAutoComplete = false, AppFlowyAutoCompleteTextProvider? autoCompleteTextProvider})

Properties

autoCompleteTextProvider → AppFlowyAutoCompleteTextProvider?
final
autoFocus → bool
Set the value to true to focus the editor on the start of the document.
final
blockComponentBuilders → Map<String, BlockComponentBuilder>
Block component builders
final
characterShortcutEvents → List<CharacterShortcutEvent>
Character event handlers
final
commandShortcutEvents → List<CommandShortcutEvent>
Command event handlers
final
contentInsertionConfiguration → ContentInsertionConfiguration?
Configuration of handler for media content inserted via the system input method.
final
contextMenuItems → List<List<ContextMenuItem>>
The context menu items.
final
editable → bool
Set the value to false to disable editing.
final
editorScrollController → EditorScrollController?
Provide a editorScrollController to control the scroll behavior
final
editorState → EditorState
final
editorStyle → EditorStyle
final
enableAutoComplete → bool
If you want to enable the auto complete feature, you must set this value to true and provide the autoCompleteTextProvider.
final
focusedSelection → Selection?
Set the value to focus the editor on the specified selection.
final
focusNode → FocusNode?
final
final
hashCode → int
The hash code for this object.
no setterinherited
AppFlowy Editor use column as the root widget.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showMagnifier → bool
Show the magnifier or not.
final
shrinkWrap → bool
if true, the editor will be sized to its contents.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<AppFlowyEditor>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited