flutter_quill library
Classes
- AlignAttribute
-
Attribute<
T> - BackgroundAttribute
- Block
- Represents a group of adjacent Lines with the same block style.
- BlockEmbed
- There are two built-in embed types supported by Quill documents, however the document model itself does not make any assumptions about the types of embedded objects and allows users to define their own types.
- BlockQuoteAttribute
- BoldAttribute
- CharacterShortcutEvent
- Defines the implementation of shortcut event based on character.
- ClipboardMonitor
- CodeBlockAttribute
- ColorAttribute
- CopyCutService
- An abstraction to make it easy to provide different implementations For copy or cut actions from a Line (just for embeddable blocks)
- CopyCutServiceProvider
- CursorCont
- Controls the cursor of an editable widget.
- CursorPainter
- Paints the editing cursor.
- CursorStyle
- Style properties of editing cursor.
- CustomBlockEmbed
- DefaultCopyCutService
- Default implementation for CopyCutService
- DefaultListBlockStyle
- DefaultStyles
- DefaultTextBlockStyle
- Style theme applied to a block of rich text, including single-line paragraphs.
- DirectionAttribute
- DocChange
- Document
- The rich text document
- EditableContainerParentData
- EditorState
- Base interface for the editor state which defines contract used by various mixins.
- Embed
- An embed node inside of a line in a Quill document.
- EmbedBuilder
- Embeddable
- An object which can be embedded into a Quill document.
- FontAttribute
- HeaderAttribute
- HeightAttribute
- HorizontalSpacing
- IconButtonData
- ImageAttribute
- ImageUrl
- IndentAttribute
- InlineCodeAttribute
- InlineCodeStyle
- Theme data for inline code.
- ItalicAttribute
- LeadingConfigurations
- This class contains all necessary values to build the leading for lists and codeblocks
- Leaf
- A leaf in Quill document tree.
- Line
- A line of rich text in a Quill document.
- LineHeightAttribute
- This attribute represents the space between text lines. The line height can be adjusted using predefined constants or custom values
- LinkAttribute
- LinkDialogAction
- LinkStyleDialog
- ListAttribute
- Node
- An abstract node in a document tree.
-
OffsetValue<
T> - OptionalSize
- PlaceholderAttribute
- This is custom attribute for hint
- QuillCheckboxBuilder
- QuillController
- QuillControllerConfigurations
- QuillDialogTheme
- Used to configure the dialog's look and feel.
- QuillEditor
- QuillEditorBulletPoint
- QuillEditorCheckboxPoint
- QuillEditorCheckboxPointState
- QuillEditorCodeBlockElementOptions
- QuillEditorConfigurations
- The configurations for the quill editor widget of flutter quill
- QuillEditorElementOptions
- QuillEditorGlyphHeights
- QuillEditorNumberPoint
- QuillEditorOrderedListElementOptions
- QuillEditorProvider
- QuillEditorState
- QuillEditorUnOrderedListElementOptions
- QuillIconTheme
- QuillRawEditor
- QuillRawEditorConfigurations
- QuillRawEditorState
- QuillSearchConfigurations
- The configurations for the quill editor widget of flutter quill
-
QuillSelectAlignmentValues<
T> - A helper class which hold all the values for the alignments of the QuillToolbarSelectAlignmentButtonOptions it's not really related to the toolbar so we called it just Quill without toolbar but the name might change in the future
- The shared configurations between QuillEditorConfigurations and QuillSimpleToolbarConfigurations so we don't duplicate things
- QuillSimpleToolbar
- QuillSimpleToolbarButtonOptions
- The configurations for the buttons of the toolbar widget of flutter quill
- QuillSimpleToolbarConfigurations
- The configurations for the toolbar widget of flutter quill
- QuillSimpleToolbarProvider
- QuillSingleChildScrollView
-
Very similar to
SingleChildView
but with a ViewportBuilder argument instead of a Widget - QuillStyles
- QuillText
- A span of formatted text within a line in a Quill document.
- QuillTextLink
- Contains information about link and text.
- QuillToolbar
- QuillToolbarBaseButtonExtraOptions
- QuillToolbarBaseButtonExtraOptionsIsToggled
-
QuillToolbarBaseButtonOptions<
T, I> -
The
T
is the options for the button, usually should refresnce itself it's used in childBuilder so the developer can customize this when using it TheI
is extra options for the button, usually for it's state - QuillToolbarClearFormatButton
- QuillToolbarClearFormatButtonExtraOptions
- QuillToolbarClearFormatButtonOptions
- QuillToolbarClipboardButton
- QuillToolbarClipboardButtonState
- QuillToolbarColorButton
- Controls color styles.
- QuillToolbarColorButtonExtraOptions
- QuillToolbarColorButtonOptions
- QuillToolbarColorButtonState
- QuillToolbarConfigurations
- QuillToolbarCustomButton
- QuillToolbarCustomButtonExtraOptions
- QuillToolbarCustomButtonOptions
- QuillToolbarDivider
- The divider which is used for separation of buttons in the toolbar.
- QuillToolbarFontFamilyButton
- QuillToolbarFontFamilyButtonExtraOptions
- QuillToolbarFontFamilyButtonOptions
- QuillToolbarFontFamilyButtonState
- QuillToolbarFontSizeButton
- QuillToolbarFontSizeButtonExtraOptions
- QuillToolbarFontSizeButtonOptions
- QuillToolbarFontSizeButtonState
- QuillToolbarHistoryButton
- QuillToolbarHistoryButtonExtraOptions
- QuillToolbarHistoryButtonOptions
- QuillToolbarHistoryButtonState
- QuillToolbarIconButton
- QuillToolbarIndentButton
- QuillToolbarIndentButtonExtraOptions
- QuillToolbarIndentButtonOptions
- QuillToolbarIndentButtonState
- QuillToolbarLegacySearchButton
- We suggest to see QuillToolbarSearchButton before using this widget.
- QuillToolbarLinkStyleButton
- QuillToolbarLinkStyleButton2
-
Alternative version of QuillToolbarLinkStyleButton. This widget has more
customization
and uses dialog similar to one which is used on
http://quilljs.com
. - QuillToolbarLinkStyleButton2ExtraOptions
- QuillToolbarLinkStyleButton2Options
- QuillToolbarLinkStyleButtonExtraOptions
- QuillToolbarLinkStyleButtonOptions
- QuillToolbarLinkStyleButtonState
- QuillToolbarProvider
- QuillToolbarSearchButton
- QuillToolbarSearchButtonExtraOptions
- QuillToolbarSearchButtonOptions
- QuillToolbarSearchDialog
- QuillToolbarSearchDialogChildBuilderExtraOptions
- QuillToolbarSearchDialogState
- QuillToolbarSelectAlignmentButton
- Dropdown button
- QuillToolbarSelectAlignmentButtonExtraOptions
- QuillToolbarSelectAlignmentButtonOptions
- QuillToolbarSelectHeaderStyleButtons
- QuillToolbarSelectHeaderStyleButtonsExtraOptions
- QuillToolbarSelectHeaderStyleButtonsOptions
- QuillToolbarSelectHeaderStyleButtonsState
- QuillToolbarSelectHeaderStyleDropdownButton
- QuillToolbarSelectHeaderStyleDropdownButtonExtraOptions
- QuillToolbarSelectHeaderStyleDropdownButtonOptions
- QuillToolbarSelectLineHeightStyleDropdownButton
- QuillToolbarToggleCheckListButton
- QuillToolbarToggleCheckListButtonExtraOptions
- QuillToolbarToggleCheckListButtonOptions
- QuillToolbarToggleCheckListButtonState
- QuillToolbarToggleStyleButton
- QuillToolbarToggleStyleButtonExtraOptions
- QuillToolbarToggleStyleButtonOptions
- QuillToolbarToggleStyleButtonState
- QuillVerticalCaretMovementRun
- RenderAbstractEditor
- Base interface for editable render objects.
- RenderEditableContainerBox
- Multi-child render box of editable content.
- RenderEditor
- Displays a document as a vertical list of document segments (lines and blocks).
- Root
- Root node of document tree.
- ScriptAttribute
- SizeAttribute
- SmallAttribute
- SpaceShortcutEvent
- Defines the implementation of shortcut events for space key calls.
-
SpellCheckerService<
T> - A representation a custom SpellCheckService.
- SpellCheckerServiceProvider
- StrikeThroughAttribute
- Style
- StyleAttribute
- TextBlockUtils
- TokenAttribute
- UnderlineAttribute
- VerticalSpacing
- VideoAttribute
- WidthAttribute
Enums
- AttributeScope
- ChangeSource
-
Source of a
Change
. - ClipboardAction
- HeaderStyleType
- LinkMenuAction
- List of possible actions returned from LinkActionPickerDelegate.
- LinkStyleType
- ScriptAttributes
- SearchButtonType
- SearchEmbedMode
Extensions
Constants
- kDefaultIconButtonFactor → const double
- The factor of how much larger the button is in relation to the icon.
- kDefaultIconSize → const double
- The default size of the icon of a button.
- kDefaultToolbarSize → const double
- The default size for the toolbar (width, height)
- kToolbarSectionSpacing → const double
- The horizontal margin between the contents of each toolbar section.
-
linkPrefixes
→ const List<
String>
Properties
- formatAsterisksToItalic → CharacterShortcutEvent
-
final
- formatCodeCharToInlineCode → CharacterShortcutEvent
-
final
- formatDoubleAsterisksToBold → CharacterShortcutEvent
-
final
- formatDoubleUnderscoresToBold → CharacterShortcutEvent
-
final
- formatHeader2ToHeaderStyle → SpaceShortcutEvent
-
final
- formatHeader3ToHeaderStyle → SpaceShortcutEvent
-
final
- formatHeaderToHeaderStyle → SpaceShortcutEvent
-
final
- formatHyphenToBulletList → SpaceShortcutEvent
-
final
- formatOrderedNumberToList → SpaceShortcutEvent
-
final
- formatStrikeToStrikethrough → CharacterShortcutEvent
-
final
-
standardCharactersShortcutEvents
→ List<
CharacterShortcutEvent> -
These all the common CharacterShortcutEvents that are implemented
by the package and correspond with markdown syntax
final
-
standardSpaceShorcutEvents
→ List<
SpaceShortcutEvent> -
These all the common SpaceShortcutEvent that are implemented
by the package and correspond with markdown syntax
final
Functions
-
colorToHex(
Color color) → String -
defaultLinkActionPickerDelegate(
BuildContext context, String link, Node node) → Future< LinkMenuAction> -
defaultToggleStyleButtonBuilder(
BuildContext context, Attribute attribute, IconData icon, bool? isToggled, VoidCallback? onPressed, VoidCallback? afterPressed, [double iconSize = kDefaultIconSize, double iconButtonFactor = kDefaultIconButtonFactor, QuillIconTheme? iconTheme]) → Widget -
getEmbedNode(
QuillController controller, int offset) → OffsetValue< Embed> -
getLinkRange(
Node node) → TextRange -
hexToColor(
String? hexString) → Color
Typedefs
- CharacterShortcutEventHandler = bool Function(QuillController controller)
- CopyCutAction = Object? Function(dynamic data)
- DeleteCallback = void Function(int cursorPosition, bool forward)
- EmbedButtonBuilder = Widget Function(QuillController controller, double toolbarIconSize, QuillIconTheme? iconTheme, QuillDialogTheme? dialogTheme)
- EmbedsBuilder = EmbedBuilder Function(Embed node)
- LeadingBlockIndentWidth = HorizontalSpacing Function(Block block, BuildContext context, int count, LeadingBlockNumberPointWidth numberPointWidthDelegate)
- LeadingBlockNodeBuilder = Widget? Function(Node, LeadingConfigurations)
- LeadingBlockNumberPointWidth = double Function(double fontSize, int count)
-
LinkActionPicker
= Future<
LinkMenuAction> Function(Node linkNode) - Used internally by widget layer.
-
LinkActionPickerDelegate
= Future<
LinkMenuAction> Function(BuildContext context, String link, Node node) -
QuillBaseToolbarChildrenBuilder
= List<
Widget> Function(BuildContext context) - QuillEditorContextMenuBuilder = Widget Function(BuildContext context, QuillRawEditorState rawEditorState)
- Signature for a widget builder that builds a context menu for the given QuillRawEditorState.
-
QuillToolbarButtonOptionsChildBuilder<
T, I> = Widget Function(T options, I extraOptions)? -
QuillToolbarColorBaseButton
= QuillToolbarBaseButton<
QuillToolbarColorButtonOptions, QuillToolbarColorButtonExtraOptions> -
QuillToolbarColorBaseButtonState<
W extends QuillToolbarColorButton> = QuillToolbarCommonButtonState< W, QuillToolbarColorButtonOptions, QuillToolbarColorButtonExtraOptions> -
QuillToolbarColorPickerOnPressedCallback
= Future<
void> Function(QuillController controller, bool isBackground) -
QuillToolbarHistoryBaseButton
= QuillToolbarBaseButton<
QuillToolbarHistoryButtonOptions, QuillToolbarHistoryButtonExtraOptions> -
QuillToolbarHistoryBaseButtonState<
W extends QuillToolbarHistoryButton> = QuillToolbarCommonButtonState< W, QuillToolbarHistoryButtonOptions, QuillToolbarHistoryButtonExtraOptions> -
QuillToolbarIndentBaseButton
= QuillToolbarBaseButton<
QuillToolbarIndentButtonOptions, QuillToolbarIndentButtonExtraOptions> -
QuillToolbarIndentBaseButtonState<
W extends QuillToolbarIndentButton> = QuillToolbarCommonButtonState< W, QuillToolbarIndentButtonOptions, QuillToolbarIndentButtonExtraOptions> -
QuillToolbarLinkStyleBaseButton
= QuillToolbarBaseButton<
QuillToolbarLinkStyleButtonOptions, QuillToolbarLinkStyleButtonExtraOptions> -
QuillToolbarLinkStyleBaseButton2
= QuillToolbarBaseButton<
QuillToolbarLinkStyleButton2Options, QuillToolbarLinkStyleButton2ExtraOptions> -
QuillToolbarLinkStyleBaseButton2State<
W extends QuillToolbarLinkStyleBaseButton2> = QuillToolbarCommonButtonState< W, QuillToolbarLinkStyleButton2Options, QuillToolbarLinkStyleButton2ExtraOptions> -
QuillToolbarLinkStyleBaseButtonState<
W extends QuillToolbarLinkStyleBaseButton> = QuillToolbarCommonButtonState< W, QuillToolbarLinkStyleButtonOptions, QuillToolbarLinkStyleButtonExtraOptions> -
QuillToolbarSearchButtonOnPressedCallback
= Future<
void> Function(QuillController controller) - QuillToolbarSearchDialogChildBuilder = Widget Function(QuillToolbarSearchDialogChildBuilderExtraOptions extraOptions)
-
QuillToolbarSelectHeaderStyleBaseButtons
= QuillToolbarBaseButton<
QuillToolbarSelectHeaderStyleButtonsOptions, QuillToolbarSelectHeaderStyleButtonsExtraOptions> -
QuillToolbarSelectHeaderStyleBaseButtonsState<
W extends QuillToolbarSelectHeaderStyleBaseButtons> = QuillToolbarCommonButtonState< W, QuillToolbarSelectHeaderStyleButtonsOptions, QuillToolbarSelectHeaderStyleButtonsExtraOptions> -
QuillToolbarSelectHeaderStyleDropdownBaseButton
= QuillToolbarBaseButton<
QuillToolbarSelectHeaderStyleDropdownButtonOptions, QuillToolbarSelectHeaderStyleDropdownButtonExtraOptions> -
QuillToolbarSelectHeaderStyleDropdownBaseButtonsState<
W extends QuillToolbarSelectHeaderStyleDropdownButton> = QuillToolbarCommonButtonState< W, QuillToolbarSelectHeaderStyleDropdownButtonOptions, QuillToolbarSelectHeaderStyleDropdownButtonExtraOptions> -
QuillToolbarSelectLineHeightStyleDropdownBaseButton
= QuillToolbarBaseButton<
QuillToolbarSelectLineHeightStyleDropdownButtonOptions, QuillToolbarSelectLineHeightStyleDropdownButtonExtraOptions> -
QuillToolbarSelectLineHeightStyleDropdownBaseButtonsState<
W extends QuillToolbarSelectLineHeightStyleDropdownButton> = QuillToolbarCommonButtonState< W, QuillToolbarSelectLineHeightStyleDropdownButtonOptions, QuillToolbarSelectLineHeightStyleDropdownButtonExtraOptions> - ReplaceTextCallback = bool Function(int index, int len, Object? data)
- SpaceShortcutEventHandler = bool Function(QuillText node, QuillController controller)
- TextSelectionChangedHandler = void Function(TextSelection selection, SelectionChangedCause cause)
- Signature for the callback that reports when the user changes the selection (including the cursor location).
- TextSelectionCompletedHandler = void Function()
- Signature for the callback that reports when a selection action is actually completed and ratified. Completion is defined as when the user input has concluded for an entire selection action. For simple taps and keyboard input events that change the selection, this callback is invoked immediately following the TextSelectionChangedHandler. For long taps, the selection is considered complete at the up event of a long tap. For drag selections, the selection completes once the drag/pan event ends or is interrupted.
- ToggleStyleButtonBuilder = Widget Function(BuildContext context, Attribute attribute, IconData icon, bool? isToggled, VoidCallback? onPressed, VoidCallback? afterPressed, [double iconSize, QuillIconTheme? iconTheme])