WidgetTypeAround

class

A plugin that allows users to type around widgets where normally it is impossible to place the caret due to limitations of web browsers. These "tight spots" occur, for instance, before (or after) a widget being the first (or last) child of its parent or between two block widgets.

This plugin extends the Widget plugin and injects the user interface with two buttons into each widget instance in the editor. Each of the buttons can be clicked by the user if the widget is next to the "tight spot". Once clicked, a paragraph is created with the selection anchored in it so that users can type (or insert content, paste, etc.) straight away.

See source

Properties

editor : Editor
readonlyinherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#editor
The editor instance.
Note that most editors implement the ui property. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.
Because of above, to make plugins more universal, it is recommended to split features into:
- The "editing" part that uses the Editor class without ui property.
- The "UI" part that uses the Editor class and accesses ui property.
See source (with github icon)
isEnabled : boolean
readonlyinheritedobservable
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#isEnabled
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.
Plugin can be simply disabled like that:
```
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```
Copy code
You can also use forceDisabled method.
See source (with github icon)
_currentFakeCaretModelElement : null | ModelElement
private

A reference to the model widget element that has the fake caret active on either side of it. It is later used to remove CSS classes associated with the fake caret when the widget no longer needs it.
See source (with github icon)

Static properties

isContextPlugin : false
readonlyinheritedstatic

See source (with github icon)
pluginName : 'WidgetTypeAround'
readonlystatic

See source (with github icon)
requires : readonly tuple
readonlystatic

See source (with github icon)
isOfficialPlugin : true
internalreadonlystatic

See source (with github icon)
isPremiumPlugin : boolean
internalreadonlyinheritedstatic

See source (with github icon)

Methods

constructor( editor )
inherited

See source (with github icon)
Parameters
editor : Editor
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, WidgetTypeAround[ K1 ], K2, WidgetTypeAround[ K2 ]>
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#bind:DUAL_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
See source (with github icon)
Type parameters
K1
K2
Parameters
bindProperty1 : K1
Observable property that will be bound to other observable(s).
bindProperty2 : K2
Observable property that will be bound to other observable(s).
Returns
ObservableDualBindChain<K1, WidgetTypeAround[ K1 ], K2, WidgetTypeAround[ K2 ]>
The bind chain with the to() and toMany() methods.
bind( bindProperties ) → ObservableMultiBindChain
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#bind:MANY_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
See source (with github icon)
Parameters
bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>
Observable properties that will be bound to other observable(s).
Returns
ObservableMultiBindChain
The bind chain with the to() and toMany() methods.
bind( bindProperty ) → ObservableSingleBindChain<K, WidgetTypeAround[ K ]>
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#bind:SINGLE_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Copy code
See source (with github icon)
Type parameters
K
Parameters
bindProperty : K
Observable property that will be bound to other observable(s).
Returns
ObservableSingleBindChain<K, WidgetTypeAround[ K ]>
The bind chain with the to() and toMany() methods.
clearForceDisabled( id ) → void
inherited

Clears forced disable previously set through forceDisabled. See forceDisabled.
See source (with github icon)
Parameters
id : string
Unique identifier, equal to the one passed in forceDisabled call.
Returns
void
decorate( methodName ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#decorate
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.
Read more in the dedicated guide covering the topic of decorating methods with some additional examples.
Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.
For example, to cancel the method execution the event can be stopped:
```
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```
Copy code
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).
It is also possible to change the returned value:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Copy code
Finally, it is possible to access and modify the arguments the method is called with:
```
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```
Copy code
See source (with github icon)
Parameters
methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled'
Name of the method to decorate.
Returns
void
delegate( events ) → EmitterMixinDelegateChain
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
See source (with github icon)
Parameters
events : Array<string>
Event names that will be delegated to another emitter.
Returns
EmitterMixinDelegateChain
destroy() → void

Destroys the plugin.
Note: This method is optional. A plugin instance does not need to have it defined.
See source (with github icon)
Returns
void
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
inherited

Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
eventOrInfo : GetNameOrEventInfo<TEvent>
The name of the event or EventInfo object if event is delegated.
args : TEvent[ 'args' ]
Additional arguments to be passed to the callbacks.
Returns
GetEventInfo<TEvent>[ 'return' ]
By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
forceDisabled( id ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#forceDisabled
Disables the plugin.
Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when enabling back the plugin. The plugin becomes enabled only after all features enabled it back.
Disabling and enabling a plugin:
```
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Copy code
Plugin disabled by multiple features:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
```
Copy code
Multiple disabling with the same identifier is redundant:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Copy code
Note: some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after clearForceDisabled was used.
See source (with github icon)
Parameters
id : string
Unique identifier for disabling. Use the same id when enabling back the plugin.
Returns
void
init() → void

See source (with github icon)
Returns
void
listenTo( emitter, event, callback, [ options ] ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#listenTo:BASE_EMITTER
Registers a callback function to be executed when an event is fired in a specific (emitter) object.
Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
emitter : Emitter
The object that fires the event.
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
off( event, callback ) → void
inherited

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).
See source (with github icon)
Parameters
event : string
The name of the event.
callback : Function
The function to stop being called.
Returns
void
on( event, callback, [ options ] ) → void
inherited

Registers a callback function to be executed when an event is fired.
Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
once( event, callback, [ options ] ) → void
inherited

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
set( values ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#set:OBJECT
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.
It accepts a single object literal containing key/value pairs with properties to be set.
This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.
In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```
Copy code
See source (with github icon)
Parameters
values : object
An object with name=>value pairs.
Returns
void
set( name, value ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#set:KEY_VALUE
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.
This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.
In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```
Copy code
See source (with github icon)
Type parameters
K
Parameters
name : K
The property's name.
value : WidgetTypeAround[ K ]
The property's value.
Returns
void
stopDelegating( [ event ], [ emitter ] ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#stopDelegating
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
See source (with github icon)
Parameters
[ event ] : string
The name of the event to stop delegating. If omitted, stops it all delegations.
[ emitter ] : Emitter
(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.
Returns
void
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#stopListening:BASE_STOP
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
See source (with github icon)
Parameters
[ emitter ] : Emitter
The object to stop listening to. If omitted, stops it for all objects.
[ event ] : string
(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.
[ callback ] : Function
(Requires the event) The function to be removed from the call list for the given event.
Returns
void
unbind( unbindProperties ) → void
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#unbind
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Copy code
See source (with github icon)
Parameters
unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'init' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void
_enableDeleteContentIntegration() → void
private

Attaches the event-deleteContent event listener to block the event when the fake caret is active.
This is required for cases that trigger model.deleteContent() before calling model.insertContent() like, for instance, plain text pasting.
See source (with github icon)
Returns
void
_enableDeleteIntegration() → void
private

It creates a "delete" event listener on the view document to handle cases when the Delete or Backspace is pressed and the fake caret is currently active.
The fake caret should create an illusion of a real browser caret so that when it appears before or after a widget, pressing Delete or Backspace should remove a widget or delete the content before or after a widget (depending on the content surrounding the widget).
See source (with github icon)
Returns
void
_enableInsertContentIntegration() → void
private

Attaches the event-insertContent event listener that, for instance, allows the user to paste content near a widget when the fake caret is first activated using the arrow keys.
The content is inserted according to the widget-type-around selection attribute (see _handleArrowKeyPress).
See source (with github icon)
Returns
void
_enableInsertObjectIntegration() → void
private

Attaches the event-insertObject event listener that modifies the options.findOptimalPositionparameter to position of fake caret in relation to selected element to reflect user's intent of desired insertion position.
The object is inserted according to the widget-type-around selection attribute (see _handleArrowKeyPress).
See source (with github icon)
Returns
void
_enableInsertingParagraphsOnButtonClick() → void
private

Registers a mousedown listener for the view document which intercepts events coming from the widget type around UI, which happens when a user clicks one of the buttons that insert a paragraph next to a widget.
See source (with github icon)
Returns
void
_enableInsertingParagraphsOnEnterKeypress() → void
private
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#_enableInsertingParagraphsOnEnterKeypress
Creates the Enter key listener on the view document that allows the user to insert a paragraph near the widget when either:
- The fake caret was first activated using the arrow keys,
- The entire widget is selected in the model.
In the first case, the new paragraph is inserted according to the widget-type-around selection attribute (see _handleArrowKeyPress).
In the second case, the new paragraph is inserted based on whether a soft (Shift+Enter) keystroke was pressed or not.
See source (with github icon)
Returns
void
_enableInsertingParagraphsOnTypingKeystroke() → void
private

Similar to the _enableInsertingParagraphsOnEnterKeypress, it allows the user to insert a paragraph next to a widget when the fake caret was activated using arrow keys but it responds to typing instead of Enter.
Listener enabled by this method will insert a new paragraph according to the widget-type-around model selection attribute as the user simply starts typing, which creates the impression that the fake caret behaves like a real one rendered by the browser (AKA your text appears where the caret was).
Note: At the moment this listener creates 2 undo steps: one for the insertParagraph command and another one for actual typing. It is not a disaster but this may need to be fixed sooner or later.
See source (with github icon)
Returns
void
_enableTypeAroundFakeCaretActivationUsingKeyboardArrows() → void
private
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#_enableTypeAroundFakeCaretActivationUsingKeyboardArrows
Brings support for the fake caret that appears when either:
- the selection moves to a widget from a position next to it using arrow keys,
- the arrow key is pressed when the widget is already selected.
The fake caret lets the user know that they can start typing or just press Enter to insert a paragraph at the position next to a widget as suggested by the fake caret.
The fake caret disappears when the user changes the selection or the editor gets blurred.
The whole idea is as follows:
1. A user does one of the 2 scenarios described at the beginning.
2. The "keydown" listener is executed and the decision is made whether to show or hide the fake caret.
3. If it should show up, the widget-type-around model selection attribute is set indicating on which side of the widget it should appear.
4. The selection dispatcher reacts to the selection attribute and sets CSS classes responsible for the fake caret on the view widget.
5. If the fake caret should disappear, the selection attribute is removed and the dispatcher does the CSS class clean-up in the view.
6. Additionally, change:range and FocusTracker#isFocused listeners also remove the selection attribute (the former also removes widget CSS classes).
See source (with github icon)
Returns
void
_enableTypeAroundUIInjection() → void
private

Creates a listener in the editing conversion pipeline that injects the widget type around UI into every single widget instance created in the editor.
The UI is delivered as a ViewUIElement wrapper which renders DOM buttons that users can use to insert paragraphs.
See source (with github icon)
Returns
void
_handleArrowKeyPress( evt, domEventData ) → void
private

A listener executed on each "keydown" in the view document, a part of _enableTypeAroundFakeCaretActivationUsingKeyboardArrows.
It decides whether the arrow keypress should activate the fake caret or not (also whether it should be deactivated).
The fake caret activation is done by setting the widget-type-around model selection attribute in this listener, and stopping and preventing the event that would normally be handled by the widget plugin that is responsible for the regular keyboard navigation near/across all widgets (that includes inline widgets, which are ignored by the widget type around plugin).
See source (with github icon)
Parameters
evt : BubblingEventInfo<'arrowKey'>
domEventData : object
Returns
void
_handleArrowKeyPressOnSelectedWidget( isForward ) → boolean
private

Handles the keyboard navigation on "keydown" when a widget is currently selected and activates or deactivates the fake caret for that widget, depending on the current value of the widget-type-around model selection attribute and the direction of the pressed arrow key.
See source (with github icon)
Parameters
isForward : boolean
true when the pressed arrow key was responsible for the forward model selection movement as in isForwardArrowKeyCode.
Returns
boolean
Returns true when the keypress was handled and no other keydown listener of the editor should process the event any further. Returns false otherwise.
_handleArrowKeyPressWhenNonCollapsedSelection( isForward ) → boolean
private

Handles the keyboard navigation on "keydown" when a widget is currently selected (together with some other content) and the widget is the first or last element in the selection. It activates or deactivates the fake caret for that widget.
See source (with github icon)
Parameters
isForward : boolean
true when the pressed arrow key was responsible for the forward model selection movement as in isForwardArrowKeyCode.
Returns
boolean
Returns true when the keypress was handled and no other keydown listener of the editor should process the event any further. Returns false otherwise.
_handleArrowKeyPressWhenSelectionNextToAWidget( isForward ) → boolean
private

Handles the keyboard navigation on "keydown" when no widget is selected but the selection is directly next to one and upon the fake caret should become active for this widget upon arrow keypress (AKA entering/selecting the widget).
Note: This code mirrors the implementation from the widget plugin but also adds the selection attribute. Unfortunately, there is no safe way to let the widget plugin do the selection part first and then just set the selection attribute here in the widget type around plugin. This is why this code must duplicate some from the widget plugin.
See source (with github icon)
Parameters
isForward : boolean
true when the pressed arrow key was responsible for the forward model selection movement as in isForwardArrowKeyCode.
Returns
boolean
Returns true when the keypress was handled and no other keydown listener of the editor should process the event any further. Returns false otherwise.
_insertParagraph( widgetModelElement, position ) → void
private

Inserts a new paragraph next to a widget element with the selection anchored in it.
Note: This method is heavily user-oriented and will both focus the editing view and scroll the viewport to the selection in the inserted paragraph.
See source (with github icon)
Parameters
widgetModelElement : ModelElement
The model widget element next to which a paragraph is inserted.
position : 'after' | 'before'
The position where the paragraph is inserted. Either 'before' or 'after' the widget.
Returns
void
_insertParagraphAccordingToFakeCaretPosition() → boolean
private

Similar to _insertParagraph, this method inserts a paragraph except that it does not expect a position. Instead, it performs the insertion next to a selected widget according to the widget-type-around model selection attribute value (fake caret position).
Because this method requires the widget-type-around attribute to be set, the insertion can only happen when the widget's fake caret is active (e.g. activated using the keyboard).
See source (with github icon)
Returns
boolean
Returns true when the paragraph was inserted (the attribute was present) and false otherwise.
_listenToIfEnabled( emitter, event, callback, [ options ] ) → void
private

A wrapper for the listenTo method that executes the callbacks only when the plugin is enabled.
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
Parameters
emitter : Emitter
The object that fires the event.
event : TEvent[ 'name' ]
The name of the event.
callback : ( args: tuple ) => void
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void

Events

change:isEnabled( eventInfo, name, value, oldValue )
inherited

Fired when the isEnabled property changed value.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isEnabled).
value : boolean
New value of the isEnabled property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isEnabled property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#event:change:{property}
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
Copy code
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
The property name.
value : TValue
The new property value.
oldValue : TValue
The previous property value.
set:isEnabled( eventInfo, name, value, oldValue )
inherited

Fired when the isEnabled property is going to be set but is not set yet (before the change event is fired).
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isEnabled).
value : boolean
New value of the isEnabled property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isEnabled property with given key or null, if property was not set before.
set:{property}( eventInfo, name, value, oldValue )
inherited
module:widget/widgettypearound/widgettypearound~WidgetTypeAround#event:set:{property}
Fired when a property value is going to be set but is not set yet (before the change event is fired).
You can control the final value of the property by using the event's return property.
```
observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                     // -> 'Current property value is 1'
                     // -> 'Value has changed from 1 to 3'
```
Copy code
Note: The event is fired even when the new value is the same as the old value.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
The property name.
value : TValue
The new property value.
oldValue : TValue
The previous property value.

WidgetTypeAround

Properties

editor : Editorreadonlyinherited

isEnabled : booleanreadonlyinherited Eye iconobservable

_currentFakeCaretModelElement : null | ModelElement Lock iconprivate

Static properties

isContextPlugin : falsereadonlyinheritedstatic

pluginName : 'WidgetTypeAround'readonlystatic

requires : readonly tuplereadonlystatic

isOfficialPlugin : trueinternalreadonlystatic

isPremiumPlugin : booleaninternalreadonlyinheritedstatic

Methods

constructor( editor )inherited

Parameters

bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, WidgetTypeAround[ K1 ], K2, WidgetTypeAround[ K2 ]>inherited

Type parameters

Parameters

Returns

bind( bindProperties ) → ObservableMultiBindChaininherited

Parameters

Returns

bind( bindProperty ) → ObservableSingleBindChain<K, WidgetTypeAround[ K ]>inherited

Type parameters

Parameters

Returns

clearForceDisabled( id ) → voidinherited

Parameters

Returns

decorate( methodName ) → voidinherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChaininherited

Parameters

Returns

destroy() → void

Returns

fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]inherited

Type parameters

Parameters

Returns

forceDisabled( id ) → voidinherited

Parameters

Returns

init() → void

Returns

listenTo( emitter, event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

off( event, callback ) → voidinherited

Parameters

Returns

on( event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

once( event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

set( values ) → voidinherited

Parameters

Returns

set( name, value ) → voidinherited

Type parameters

Parameters

Returns

stopDelegating( [ event ], [ emitter ] ) → voidinherited

Parameters

Returns

stopListening( [ emitter ], [ event ], [ callback ] ) → voidinherited

Parameters

Returns

unbind( unbindProperties ) → voidinherited

Parameters

Returns

_enableDeleteContentIntegration() → void Lock iconprivate

Returns

_enableDeleteIntegration() → void Lock iconprivate

Returns

`editor : Editor`
readonlyinherited

`isEnabled : boolean`
readonlyinheritedobservable

`_currentFakeCaretModelElement : null | ModelElement`
private

`isContextPlugin : false`
readonlyinheritedstatic

`pluginName : 'WidgetTypeAround'`
readonlystatic

`requires : readonly tuple`
readonlystatic

`isOfficialPlugin : true`
internalreadonlystatic

`isPremiumPlugin : boolean`
internalreadonlyinheritedstatic

`constructor( editor )`
inherited

`bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, WidgetTypeAround[ K1 ], K2, WidgetTypeAround[ K2 ]>`
inherited

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

`bind( bindProperty ) → ObservableSingleBindChain<K, WidgetTypeAround[ K ]>`
inherited

`clearForceDisabled( id ) → void`
inherited

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`destroy() → void`

`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`
inherited

`forceDisabled( id ) → void`
inherited

`init() → void`

`listenTo( emitter, event, callback, [ options ] ) → void`
inherited

`off( event, callback ) → void`
inherited

`on( event, callback, [ options ] ) → void`
inherited

`once( event, callback, [ options ] ) → void`
inherited

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`stopDelegating( [ event ], [ emitter ] ) → void`
inherited

`stopListening( [ emitter ], [ event ], [ callback ] ) → void`
inherited

`unbind( unbindProperties ) → void`
inherited

`_enableDeleteContentIntegration() → void`
private

`_enableDeleteIntegration() → void`
private

`_enableInsertContentIntegration() → void`
private

`_enableInsertObjectIntegration() → void`
private

`_enableInsertingParagraphsOnButtonClick() → void`
private

`_enableInsertingParagraphsOnEnterKeypress() → void`
private

`_enableInsertingParagraphsOnTypingKeystroke() → void`
private

`_enableTypeAroundFakeCaretActivationUsingKeyboardArrows() → void`
private

`_enableTypeAroundUIInjection() → void`
private

`_handleArrowKeyPress( evt, domEventData ) → void`
private

`_handleArrowKeyPressOnSelectedWidget( isForward ) → boolean`
private

`_handleArrowKeyPressWhenNonCollapsedSelection( isForward ) → boolean`
private

`_handleArrowKeyPressWhenSelectionNextToAWidget( isForward ) → boolean`
private

`_insertParagraph( widgetModelElement, position ) → void`
private

`_insertParagraphAccordingToFakeCaretPosition() → boolean`
private

`_listenToIfEnabled( emitter, event, callback, [ options ] ) → void`
private

`change:isEnabled( eventInfo, name, value, oldValue )`
inherited

`change:{property}( eventInfo, name, value, oldValue )`
inherited

`set:isEnabled( eventInfo, name, value, oldValue )`
inherited

`set:{property}( eventInfo, name, value, oldValue )`
inherited