FroalaEditorBuilder
class FroalaEditorBuilder
Class FroalaEditorBuilder
This builder class is used for building the froala editor data structure which is used by the client side to create a froala object.
Properties
| protected string | $domId | ||
| protected FroalaOption[] | $options | ||
| protected FroalaInsertGroup[] | $previewInsertGroups | ||
| protected FroalaInsertGroup[] | $attachmentInsertGroups | ||
| protected Controller|null | $mod | ||
| protected DocumentIndex|null | $documentIndex | ||
| protected bool | $useMentions | ||
| protected bool | $useSubmitOnCtrlEnter | ||
| protected string | $allowHTML | ||
| protected bool | $useTags | ||
| protected string | $toolbarSet | ||
| protected bool | $toolbarAttached | Uses standard toolbar or inline toolbar? |
Methods
FroalaEditorBuilder constructor.
No description
Creates a new toolbar dropdown menu with custom entries.
Creates a new toolbar dropdown menu with custom entries.
Get Options as JSON Object StringFormat
Returns the setup of the toolbar based on the property simpleToolbar which defines the features used by the toolbar. If simpleToolbar is used, this method returns a setup which contains less buttons.
Reduce the amount of visible Toolbar Buttons for smaller versions of the standard toolbar
Sichtweise: Froala / Insert Plugin Aufgabe:Konvertierung von Daten in Plugin spezifische Formatierung (JSON, JS, API?).
The Input mode can be full, image-only, none
Add to or replace the color picker colors for text and background color
No description
No description
No description
No description
If enabled pressing CTRL+ENTER in the textarea will submit the form
Enables inline #tag Tags incl. autosuggest
Sets the set of toolbar buttons used for editor.
Details
at line 84
__construct(string $domId)
FroalaEditorBuilder constructor.
at line 378
string
buildJs()
No description
at line 213
FroalaInsertGroup
createAttachmentInsertGroup(string $key, string $label, string|null $icon = null)
Creates a new toolbar dropdown menu with custom entries.
at line 226
FroalaInsertGroup
createPreviewInsertGroup(string $key, string $label, string|null $icon = null)
Creates a new toolbar dropdown menu with custom entries.
at line 234
string
getOptions()
Get Options as JSON Object StringFormat
at line 415
protected array
getToolbarButtons()
Returns the setup of the toolbar based on the property simpleToolbar which defines the features used by the toolbar. If simpleToolbar is used, this method returns a setup which contains less buttons.
at line 447
protected array
getToolbarButtonsReduced(int $visibleButtons = 5)
Reduce the amount of visible Toolbar Buttons for smaller versions of the standard toolbar
at line 592
void
setPluginInsertData(array $pluginInsertData)
Sichtweise: Froala / Insert Plugin Aufgabe:Konvertierung von Daten in Plugin spezifische Formatierung (JSON, JS, API?).
..
at line 199
FroalaEditorBuilder
withAllowHTML(string $inputMode = 'full')
The Input mode can be full, image-only, none
at line 160
withColorsText(array $colors, bool $replace = false)
Add to or replace the color picker colors for text and background color
at line 124
FroalaEditorBuilder
withDocumentIndex(DocumentIndex|null $documentIndex)
No description
at line 130
FroalaEditorBuilder
withDocumentSelector($documentSelector)
No description
at line 140
FroalaEditorBuilder
withMentions(bool $bool)
No description
at line 114
FroalaEditorBuilder
withMod(Controller|null $mod)
No description
at line 104
FroalaEditorBuilder
withOptions(FroalaOption ...$options)
Adds a new option to froala editor.
at line 189
FroalaEditorBuilder
withSubmitOnCtrlEnter(bool $bool)
If enabled pressing CTRL+ENTER in the textarea will submit the form
at line 149
FroalaEditorBuilder
withTags(bool $bool)
Enables inline #tag Tags incl. autosuggest
at line 402
FroalaEditorBuilder
withToolbarSet(string $toolbarSet, bool $attachedToolbar = true)
Sets the set of toolbar buttons used for editor.