html_editor library

Classes

AdditionalTextTags
Summernote Additional Text Tags plugin - adds another toolbar item for more text items, such as , , and .
Callbacks
Manages all the callback functions the library provides
ColorBar
Color bar group
FileUpload
The FileUpload class stores any known data about a file. This class is used as an argument in some callbacks relating to image and file insertion.
Font
Font group
FontSetting
Font setting group
HtmlEditor
Fallback HtmlEditor class (should never be called)
HtmlEditorController
Fallback controller (should never be used)
HtmlEditorOptions
Options class for the html editor.
Insert
Insert group
Misc
Miscellaneous group
MiscFont
Miscellaneous font group
Paragraph
Paragraph group
Plugins
Abstract class that all the plguin classes extend
Style
Style group
SummernoteAtMention
Summernote @ Mention plugin - adds a dropdown to select the person to mention whenever the '@' character is typed into the editor. The list of people to mention is drawn from the getSuggestionsMobile (on mobile) or mentionsWeb (on Web) parameter. You can detect who was mentioned using the onSelect callback.
SummernoteCaseConverter
Summernote case converter plugin - adds a toolbar item that can convert any text between cases. The supported cases are upper, lower, sentence, and title.
SummernoteCodewrapper
Summernote codewrapper plugin - adds a button to the toolbar to wrap the selected text in a code box.
SummernoteEmoji
Summernote Emoji from Ajax plugin - loads emojis via Ajax and displays them in a nice dropdown with a search box. This can be useful in desktop environments where users may not know the Win + . shortcut for emojis (or are on an older platform), and want to be able to use those in the editor.
SummernoteFile
Summernote file plugin - adds a button to the toolbar to upload any type of file. By default it can handle picture files (jpg, png, gif, wvg, webp), audio files (mp3, ogg, oga), and video files (mp4, ogv, webm) without any upload in base64. If you want to handle other files, you must upload them into a server and insert it into the editor using the onFileUpload function.
SummernoteListStyles
Summernote list styles plugin - adds a toolbar item that allows the user to change the bulleted list style. Available styles: numbered, lowered alpha, upper alpha, lower roman, upper roman, disc, circle, and square.
SummernoteRTL
Summernote RTL plugin - adds two toolbar items that let you switch between LTR and RTL format, useful for languages like Hebrew and Arabic.
Toolbar
Abstract class that all the toolbar classes extend
ToolbarWidget
The toolbar widget at the bottom of the editor

Enums

ColorButtons
Enum for color bar group buttons
FontButtons
Enum for font group buttons
FontSettingButtons
Enum for font setting group buttons
InsertButtons
Enum for insert group buttons
MiscButtons
Enum for miscellaneous group buttons
MiscFontButtons
Enum for miscellaneous font buttons
NotificationType
Manages the notification type for a notification displayed at the bottom of the editor
ParagraphButtons
Enum for paragraph group buttons
StyleButtons
Enum for style group buttons
UploadError
Defines the 3 different cases for file insertion failing

Properties

controllerMap Map<HtmlEditorController, dynamic>
Global variable used to get the InAppWebViewController of the Html editor
getter/setter pair

Functions

fileUploadFromJson(String str) FileUpload
Function that creates an instance of FileUpload from a JSON string
toolbarIcon(BuildContext context, IconData icon, String title, {required dynamic onTap()}) Widget
Widget for the toolbar icon