HtmlEditorOptions class

Options that modify the editor and its behavior

Constructors

HtmlEditorOptions({bool autoAdjustHeight = true, bool androidUseHybridComposition = true, bool adjustHeightForKeyboard = true, int? characterLimit, String customOptions = '', bool? darkMode, bool disabled = false, String? filePath, String? hint, String? initialText, HtmlInputType inputType = HtmlInputType.text, ContextMenu? mobileContextMenu, Duration? mobileLongPressDuration, UnmodifiableListView<UserScript>? mobileInitialScripts, UnmodifiableListView<WebScript>? webInitialScripts, bool shouldEnsureVisible = false, bool spellCheck = false})

const

Properties

adjustHeightForKeyboard → bool

The editor will automatically adjust its height when the keyboard is active to prevent the keyboard overlapping the editor.

final

androidUseHybridComposition → bool

ALlows devs to set hybrid composition off in case they would like to prioritize animation smoothness over text input experience.

final

autoAdjustHeight → bool

The editor will automatically adjust its height once the page is loaded to ensure there is no vertical scrolling or empty space. It will only perform the adjustment when the summernote editor is the loaded page.

final

characterLimit → int?

Adds a character limit to the editor.

final

customOptions → String

Set custom options for the summernote editor by using their syntax.

final

darkMode → bool?

Sets the editor to dark mode. null - switches with system, false - always light, true - always dark.

final

disabled → bool

Disable the editor immediately after startup. You can re-enable the editor by calling controller.enable().

final

filePath → String?

Specify the file path to your custom html editor code.

final

hashCode → int

The hash code for this object.

no setter, inherited

hint → String?

Sets the Html editor's hint (text displayed when there is no text in the editor).

final

initialText → String?

The initial text that is be supplied to the Html editor.

final

inputType → HtmlInputType

Changes the display of the virtual keyboard on mobile devices.

final

mobileContextMenu → ContextMenu?

Customize the context menu for selected text on mobile

final

mobileInitialScripts → UnmodifiableListView<UserScript>?

Initial JS to inject into the editor.

final

mobileLongPressDuration → Duration?

Set the duration until a long-press is recognized.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shouldEnsureVisible → bool

Specifies whether the widget should scroll to reveal the HTML editor when it is focused or the text content is changed. See the README examples for the best way to implement this.

final

spellCheck → bool

Specify whether or not the editor should spellcheck its contents.

final

webInitialScripts → UnmodifiableListView<WebScript>?

Initial JS to add to the editor. These can be called at any time using controller.evaluateJavascriptWeb

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited