discontinuedPackage super_editor_quill has been discontinued and replaced by super_editor.
super_editor_quill
library
Classes
-
AlignDeltaFormat
-
A BlockDeltaFormat that applies an alignment to a paragraph.
-
AudioEmbedBlockDeltaFormat
-
-
AudioNode
-
DocumentNode that represents an audio source at a URL.
-
BackgroundColorDeltaFormat
-
An inline Quill Delta format that applies a background color (highlight) to text.
-
BlockDeltaFormat
-
A block-level format for a text block, e.g., header, blockquote, code.
-
BlockquoteDeltaFormat
-
A BlockDeltaFormat that applies a blockquote block type to a paragraph.
-
CodeBlockDeltaFormat
-
A BlockDeltaFormat that applies a code block type to a paragraph.
-
ColorDeltaFormat
-
An inline Quill Delta format that applies a color to text.
-
DeltaBlockMergeRule
-
A rule that decides whether a given
DocumentNode should be merged into
the node before it, when creating a Document from Quill Deltas.
-
DeltaSerializer
-
Serializes some part of a
MutableDocument to a Quill Delta document.
-
FileEmbedBlockDeltaFormat
-
-
FileNode
-
DocumentNode that represents a file at a URL.
-
FilterByNameBlockDeltaFormat
-
A BlockDeltaFormat that filters out any operation that doesn't have
an attribute with the given name.
-
FilterByNameInlineDeltaFormat
-
An InlineDeltaFormat that filters out any operation that doesn't have
an attribute with the given name.
-
FontFamilyDeltaFormat
-
An inline Quill Delta format that applies a font family to text.
-
FunctionalDeltaSerializer
-
A DeltaSerializer that forwards to a given delegate function.
-
A BlockDeltaFormat that applies a header block type to a paragraph.
-
ImageEmbedBlockDeltaFormat
-
-
IndentParagraphDeltaFormat
-
A BlockDeltaFormat that applies an indent to a paragraph.
-
InlineDeltaFormat
-
Given a Quill Delta text insertion operation, inspects the delta's attributes and then
returns an attribution that should be applied to the
AttributedText created by the
insertion operation.
-
InlineEmbed
-
-
InlineEmbedDeltaSerializer
-
Serializes pieces of text to Quill Deltas.
-
InlineEmbedFormat
-
-
LinkDeltaFormat
-
An inline Quill Delta format that applies a link to text.
-
ListDeltaFormat
-
A BlockDeltaFormat that converts a paragraph to a list item or a task.
-
ListItemDeltaSerializer
-
-
MergeBlock
-
A DeltaBlockMergeRule that chooses to merge blocks whose type
==
the given block type.
-
NamedFontSizeAttribution
-
An
Attribution that sets the font size of text based on a given size
name, e.g., "huge", "large", "normal", "small".
-
NamedInlineDeltaFormat
-
An InlineDeltaFormat that applies a given attribution to text whenever
that text insertion includes an attribute with the given name.
-
ParagraphDeltaSerializer
-
-
ScriptDeltaFormat
-
An inline Quill Delta format that makes text superscript or subscript.
-
SizeDeltaFormat
-
An inline Quill Delta format that applies a named or numerical size to text.
-
StandardEmbedBlockDeltaFormat
-
-
TaskDeltaSerializer
-
-
TextBlockDeltaSerializer
-
A DeltaSerializer that includes standard Quill Delta rules for
serializing text blocks, e.g., paragraphs, lists, and tasks.
-
UrlMediaNode
-
DocumentNode that represents a media source that exists a given url.
-
VideoEmbedBlockDeltaFormat
-
-
VideoNode
-
DocumentNode that represents a video at a URL.
Extensions
-
DeltaSerialization
on Operation
-
-
NewlineCharacter
on String
-
-
OperationParser
on Operation
-
An extension on Quill Delta
Operations that adds the ability for an operation to
apply itself to a Super Editor document through an Editor.
-
QuillDelta
on MutableDocument
-
Extensions on
MutableDocument for serializing a MutableDocument
to a Quill Delta document.
-
Split
on AttributedText
-
Constants
-
audioDeltaSerializer
→ const FunctionalDeltaSerializer
-
A DeltaSerializer that serializes AudioNodes to deltas.
-
defaultBlockFormats
→ const List<FilterByNameBlockDeltaFormat>
-
The standard block-level text formats that are parsed from Quill Deltas,
e.g., headers, blockquotes, list items.
-
defaultBlockMergeRules
→ const List<MergeBlock>
-
The standard set of DeltaBlockMergeRules used when parsing Quill Deltas.
-
defaultDeltaSerializers
→ const List<DeltaSerializer>
-
The serializers the are used by default to convert a Super Editor
Document to a
Quill Delta document.
-
defaultEmbedBockFormats
→ const List<StandardEmbedBlockDeltaFormat>
-
The standard block-level embed formats that are parsed from Quill Deltas,
e.g., images, audio, video.
-
defaultInlineFormats
→ const List<InlineDeltaFormat>
-
The standard inline text formats that are parsed from Quill Deltas, e.g.,
bold, italics, underline, links.
-
fileDeltaSerializer
→ const FunctionalDeltaSerializer
-
A DeltaSerializer that serializes FileNodes into deltas.
-
imageDeltaSerializer
→ const FunctionalDeltaSerializer
-
A DeltaSerializer that serializes
ImageNodes into deltas.
-
listItemDeltaSerializer
→ const ListItemDeltaSerializer
-
A
DataSerializer that serializes ListItemNodes into deltas.
-
paragraphDeltaSerializer
→ const ParagraphDeltaSerializer
-
A DeltaSerializer that serializes
ParagraphNodes into deltas.
-
taskDeltaSerializer
→ const TaskDeltaSerializer
-
A DeltaSerializer that serializes
TaskNodes into deltas.
-
videoDeltaSerializer
→ const FunctionalDeltaSerializer
-
A DeltaSerializer that serializes VideoNodes into deltas.
Functions
-
parseQuillDeltaDocument(Map<String, dynamic> deltaDocument, {Editor? customEditor, List<BlockDeltaFormat> blockFormats = defaultBlockFormats, List<DeltaBlockMergeRule> blockMergeRules = defaultBlockMergeRules, List<InlineDeltaFormat> inlineFormats = defaultInlineFormats, List<InlineEmbedFormat> inlineEmbedFormats = const [], List<BlockDeltaFormat> embedBlockFormats = defaultEmbedBockFormats})
→ MutableDocument
-
Parses a fully formed Quill Delta document (as JSON) into a
MutableDocument.
-
parseQuillDeltaOps(List deltaOps, {Editor? customEditor, List<BlockDeltaFormat> blockFormats = defaultBlockFormats, List<DeltaBlockMergeRule> blockMergeRules = defaultBlockMergeRules, List<InlineDeltaFormat> inlineFormats = defaultInlineFormats, List<InlineEmbedFormat> inlineEmbedFormats = const [], List<BlockDeltaFormat> embedBlockFormats = defaultEmbedBockFormats})
→ MutableDocument
-
Parses a list of Quill Delta operations (as JSON) into a
MutableDocument.