RichTextField

An interface class designed to be used with rich text field editors such as TinyMCE, CKEditor or Quill.

This field uses a simple DIV as the input "field" which the libraries will use as their target element. To use this field, you should subclass this class and implement the onPaint method to initialize the rich text editor.

import RichTextField from './lib/Core/widget/RichTextField.js';

export default class TinyMceField extends RichTextField {
    static $name = 'TinyMceField';
    static type = 'tinymcefield';

    onPaint() {
        // Initialize TinyMCE when we have a target element
        globalThis.tinymce.init({
            target : this.input,
            inline : true,
            // Update the TinyMceField instance value silently when the TinyMCE content changes
            setup  : editor => editor.on('NodeChange', () => this.richText = editor.getContent())
        }).then(() => this.input.focus());
    }

    // Ensure the CellEdit feature is aware of our ownership of TinyMCEs floating toolbar element
    owns(target) {
        return super.owns(target) || target?.closest('.tox-tinymce');
    }
}

TinyMceField.initClass();

Configs

107

Common

listenersEvents

Accessibility

ariaLabelWidget
keyMapKeyMap

Container

inlineField

CSS

clsWidget
colorWidget
htmlClsWidget
styleWidget
uiWidget

DOM

adoptWidget
appendToWidget
contentWidget
datasetWidget
htmlWidget
idWidget
tagWidget
titleWidget

Float & align

alignWidget
anchorWidget
centeredWidget
draggableWidget
floatingWidget
xWidget
yWidget

Input element

Label

hintField
labelLabelable
labelClsLabelable
labelPositionLabelable
labelsField
labelWidthLabelable

Layout

alignSelfWidget
dockWidget
flexWidget
heightWidget
hiddenWidget
marginWidget
maxHeightWidget
maxWidthWidget
minHeightWidget
minWidthWidget
textAlignWidget
weightWidget
widthWidget

Misc

badgeBadge
dataFieldWidget
disabledWidget
localeClassLocalizable
localizableLocalizable
maskedWidget
ownerWidget
refWidget
rippleWidget
tabWidget
tooltipWidget

Other

columnWidget
nameField
rtlRTL
spanWidget
valueField

Scrolling

Properties

83

Class hierarchy

isRichTextField: Boolean= truereadonly
Identifies an object as an instance of RichTextField class, or subclass thereof.
isRichTextField: Boolean= truereadonlystatic
Identifies an object as an instance of RichTextField class, or subclass thereof.
isBadgeBadge
isDelayableDelayable
isEventsEvents
isFieldField
isKeyMapKeyMap
isLabelableLabelable
isLocalizableLocalizable
isValidatableValidatable
isWidgetWidget

Other

richText: Boolean

Use this property to update this field´s value silently while the rich text contents of this field is being edited. Otherwise, it would reset caret position and completely overwrite the context.

$namestaticWidget
columnWidget
inputField
isEmptyField
isValidField
rtlRTL
spanWidget
typestaticWidget
valueField

Accessibility

keyMapKeyMap

CSS

clsWidget

DOM

appendToWidget
contentWidget
datasetWidget
elementWidget
htmlWidget
idWidget
styleWidget

Float & align

xWidget
yWidget

Layout

alignSelfWidget
flexWidget
heightWidget
marginWidget
maxHeightWidget
maxWidthWidget
minHeightWidget
minWidthWidget
widthWidget

Lifecycle

configBase

Misc

badgeBadge
cellInfoWidget
disabledWidget
errorTipValidatable
labelLabelable
localeHelperLocalizable
localeManagerLocalizable
refWidget
tabWidget
tooltipWidget

Visibility

hiddenWidget
isVisibleWidget

Widget hierarchy

ownerWidget
parentWidget

Functions

64

Configuration

applyDefaultsstaticBase

Events

Float & align

alignToWidget
setXYWidget
showByWidget
toFrontWidget

Lifecycle

createstaticWidget
destroystaticBase
initClassstaticWidget

Misc

attachTooltipstaticWidget
fromElementstaticWidget
fromSelectorstaticWidget
getByIdstaticWidget
isOfTypeNamestaticBase
mixinstaticBase
optionalLstaticLocalizable

Other

clearField
clearErrorValidatable
composeWidget
createOnFrameDelayable
disableWidget
enableWidget
focusWidget
getErrorsValidatable
LstaticLocalizable
maskWidget
onEvents
recomposeWidget
relayAllEvents
selectField
setErrorValidatable
triggerEvents
unEvents
unmaskWidget

Visibility

hideWidget
showWidget

Widget hierarchy

closestWidget
containsWidget
ownsWidget
queryWidget
queryAllWidget
upWidget

Events

19
actionField
catchAllEvents
changeField
clearField
destroyEvents
focusInWidget
focusOutWidget
hideWidget
inputField
paintWidget
readOnlyWidget
recomposeWidget
resizeWidget
showWidget
triggerField

Event handlers

19

Typedefs

7

CSS variables

37

Inherited