ButtonImage Class
The ButtonImage class inserts an image to the content.
Index
Methods
Events
Methods
_onInputChange
()
protected
On input change, reads the chosen file and fires an event beforeImageAdd with the image which will be added
to the content. The image file will be passed in the imageFiles property.
If any of the listeners returns false or cancels the event, the image won't be added to the content.
Otherwise, an event imageAdd will be fired with the inserted element into the editable area.
The passed params will be:
el- the created img elementfile- the original image file from the input element
handleClick
-
event
Simulates click on the input element. This will open browser's native file open dialog.
Parameters:
-
eventSyntheticEventThe received click event on the button.
render
()
Object
Lifecycle. Renders the UI of the button.
Returns:
The content which should be rendered.
Properties
editor
Object
The editor instance where the component is being used.
key
String
static
The name which will be used as an alias of the button in the configuration.
Default: image
label
String
The label that should be used for accessibility purposes.
tabIndex
Number
The tabIndex of the button in its toolbar current state. A value other than -1 means that the button has focus and is the active element.
Events
beforeImageAdd
Fired before adding images to the editor.
Event Payload:
-
imageFilesArrayArray of image files
imageAdd
Fired when an image is being added to the editor successfully.
Event Payload:
-
elCKEDITOR.dom.elementThe created image with src as Data URI
-
fileFileThe image file