mirror of
https://github.com/codex-team/editor.js
synced 2024-05-06 00:23:23 +02:00
526 lines
14 KiB
TypeScript
526 lines
14 KiB
TypeScript
import Module from '../../__module';
|
|
import $ from '../../dom';
|
|
|
|
import BoldInlineTool from '../../inline-tools/inline-tool-bold';
|
|
import ItalicInlineTool from '../../inline-tools/inline-tool-italic';
|
|
import LinkInlineTool from '../../inline-tools/inline-tool-link';
|
|
import SelectionUtils from '../../selection';
|
|
import _ from '../../utils';
|
|
import {InlineTool, InlineToolConstructable, ToolConstructable, ToolSettings} from '../../../../types';
|
|
|
|
/**
|
|
* Inline toolbar with actions that modifies selected text fragment
|
|
*
|
|
* |¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|
|
|
* | B i [link] [mark] |
|
|
* |________________________|
|
|
*/
|
|
export default class InlineToolbar extends Module {
|
|
|
|
/**
|
|
* CSS styles
|
|
*/
|
|
public CSS = {
|
|
inlineToolbar: 'ce-inline-toolbar',
|
|
inlineToolbarShowed: 'ce-inline-toolbar--showed',
|
|
buttonsWrapper: 'ce-inline-toolbar__buttons',
|
|
actionsWrapper: 'ce-inline-toolbar__actions',
|
|
inlineToolButton: 'ce-inline-tool',
|
|
inlineToolButtonLast: 'ce-inline-tool--last',
|
|
inputField: 'cdx-input',
|
|
focusedButton: 'ce-inline-tool--focused',
|
|
};
|
|
|
|
/**
|
|
* State of inline toolbar
|
|
* @type {boolean}
|
|
*/
|
|
public opened: boolean = false;
|
|
|
|
/**
|
|
* Inline Toolbar elements
|
|
*/
|
|
private nodes: { wrapper: HTMLElement, buttons: HTMLElement, actions: HTMLElement } = {
|
|
wrapper: null,
|
|
buttons: null,
|
|
/**
|
|
* Zone below the buttons where Tools can create additional actions by 'renderActions()' method
|
|
* For example, input for the 'link' tool or textarea for the 'comment' tool
|
|
*/
|
|
actions: null,
|
|
};
|
|
|
|
/**
|
|
* Margin above/below the Toolbar
|
|
*/
|
|
private readonly toolbarVerticalMargin: number = 20;
|
|
|
|
/**
|
|
* Tools instances
|
|
*/
|
|
private toolsInstances: Map<string, InlineTool>;
|
|
|
|
/**
|
|
* Buttons List
|
|
* @type {NodeList}
|
|
*/
|
|
private buttonsList: NodeList = null;
|
|
|
|
/**
|
|
* Visible Buttons
|
|
* Some Blocks might disable inline tools
|
|
* @type {HTMLElement[]}
|
|
*/
|
|
private visibleButtonsList: HTMLElement[] = [];
|
|
|
|
/**
|
|
* Focused button index
|
|
* @type {number}
|
|
*/
|
|
private focusedButtonIndex: number = -1;
|
|
|
|
/**
|
|
* Inline Toolbar Tools
|
|
*
|
|
* @returns Map<string, InlineTool>
|
|
*/
|
|
get tools(): Map<string, InlineTool> {
|
|
if (!this.toolsInstances || this.toolsInstances.size === 0) {
|
|
const allTools = this.inlineTools;
|
|
|
|
this.toolsInstances = new Map();
|
|
for (const tool in allTools) {
|
|
if (allTools.hasOwnProperty(tool)) {
|
|
this.toolsInstances.set(tool, allTools[tool]);
|
|
}
|
|
}
|
|
}
|
|
|
|
return this.toolsInstances;
|
|
}
|
|
|
|
/**
|
|
* Making DOM
|
|
*/
|
|
public make() {
|
|
this.nodes.wrapper = $.make('div', this.CSS.inlineToolbar);
|
|
this.nodes.buttons = $.make('div', this.CSS.buttonsWrapper);
|
|
this.nodes.actions = $.make('div', this.CSS.actionsWrapper);
|
|
|
|
// To prevent reset of a selection when click on the wrapper
|
|
this.Editor.Listeners.on(this.nodes.wrapper, 'mousedown', (event) => {
|
|
const isClickedOnActionsWrapper = (event.target as Element).closest(`.${this.CSS.actionsWrapper}`);
|
|
|
|
// If click is on actions wrapper,
|
|
// do not prevent default behaviour because actions might include interactive elements
|
|
if (!isClickedOnActionsWrapper) {
|
|
event.preventDefault();
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Append Inline Toolbar to the Editor
|
|
*/
|
|
$.append(this.nodes.wrapper, [this.nodes.buttons, this.nodes.actions]);
|
|
$.append(this.Editor.UI.nodes.wrapper, this.nodes.wrapper);
|
|
|
|
/**
|
|
* Append Inline Toolbar Tools
|
|
*/
|
|
this.addTools();
|
|
|
|
}
|
|
|
|
/**
|
|
* Moving / appearance
|
|
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
*/
|
|
|
|
/**
|
|
* Shows Inline Toolbar by keyup/mouseup
|
|
* @param {KeyboardEvent|MouseEvent} event
|
|
*/
|
|
public handleShowingEvent(event): void {
|
|
if (!this.allowedToShow()) {
|
|
this.close();
|
|
return;
|
|
}
|
|
|
|
this.move();
|
|
this.open();
|
|
|
|
/** Check Tools state for selected fragment */
|
|
this.checkToolsState();
|
|
|
|
/** Clear selection */
|
|
this.Editor.BlockSelection.clearSelection();
|
|
}
|
|
|
|
/**
|
|
* Move Toolbar to the selected text
|
|
*/
|
|
public move(): void {
|
|
const selectionRect = SelectionUtils.rect as DOMRect;
|
|
const wrapperOffset = this.Editor.UI.nodes.wrapper.getBoundingClientRect();
|
|
const newCoords = {
|
|
x: selectionRect.x - wrapperOffset.left,
|
|
y: selectionRect.y
|
|
+ selectionRect.height
|
|
// + window.scrollY
|
|
- wrapperOffset.top
|
|
+ this.toolbarVerticalMargin,
|
|
};
|
|
|
|
/**
|
|
* If we know selections width, place InlineToolbar to center
|
|
*/
|
|
if (selectionRect.width) {
|
|
newCoords.x += Math.floor(selectionRect.width / 2);
|
|
}
|
|
|
|
this.nodes.wrapper.style.left = Math.floor(newCoords.x) + 'px';
|
|
this.nodes.wrapper.style.top = Math.floor(newCoords.y) + 'px';
|
|
}
|
|
|
|
/**
|
|
* Leaf Inline Tools
|
|
* @param {string} direction
|
|
*/
|
|
public leaf(direction: string = 'right'): void {
|
|
this.visibleButtonsList = (Array.from(this.buttonsList)
|
|
.filter((tool) => !(tool as HTMLElement).hidden) as HTMLElement[]);
|
|
|
|
if (this.visibleButtonsList.length === 0) {
|
|
return;
|
|
}
|
|
|
|
this.focusedButtonIndex = $.leafNodesAndReturnIndex(
|
|
this.visibleButtonsList, this.focusedButtonIndex, direction, this.CSS.focusedButton,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Drops focused button index
|
|
*/
|
|
public dropFocusedButtonIndex(): void {
|
|
if (this.focusedButtonIndex === -1) {
|
|
return;
|
|
}
|
|
|
|
this.visibleButtonsList[this.focusedButtonIndex].classList.remove(this.CSS.focusedButton);
|
|
this.focusedButtonIndex = -1;
|
|
}
|
|
|
|
/**
|
|
* Returns Focused button Node
|
|
* @return {HTMLElement}
|
|
*/
|
|
public get focusedButton(): HTMLElement {
|
|
if (this.focusedButtonIndex === -1) {
|
|
return null;
|
|
}
|
|
|
|
return this.visibleButtonsList[this.focusedButtonIndex];
|
|
}
|
|
|
|
/**
|
|
* Hides Inline Toolbar
|
|
*/
|
|
public close(): void {
|
|
this.nodes.wrapper.classList.remove(this.CSS.inlineToolbarShowed);
|
|
this.tools.forEach((toolInstance) => {
|
|
if (typeof toolInstance.clear === 'function') {
|
|
toolInstance.clear();
|
|
}
|
|
});
|
|
|
|
this.opened = false;
|
|
|
|
if (this.focusedButtonIndex !== -1) {
|
|
this.visibleButtonsList[this.focusedButtonIndex].classList.remove(this.CSS.focusedButton);
|
|
this.focusedButtonIndex = -1;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Shows Inline Toolbar
|
|
*/
|
|
public open(): void {
|
|
/**
|
|
* Check if inline toolbar is allowed to show or not
|
|
*/
|
|
if (!this.allowedToShow()) {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Filter inline-tools and show only allowed by Block's Tool
|
|
*/
|
|
this.filterTools();
|
|
|
|
/**
|
|
* Show Inline Toolbar
|
|
*/
|
|
this.nodes.wrapper.classList.add(this.CSS.inlineToolbarShowed);
|
|
|
|
/**
|
|
* Call 'clear' method for Inline Tools (for example, 'link' want to clear input)
|
|
*/
|
|
this.tools.forEach((toolInstance: InlineTool) => {
|
|
if (typeof toolInstance.clear === 'function') {
|
|
toolInstance.clear();
|
|
}
|
|
});
|
|
|
|
this.buttonsList = this.nodes.buttons.querySelectorAll(`.${this.CSS.inlineToolButton}`);
|
|
this.opened = true;
|
|
}
|
|
|
|
/**
|
|
* Need to show Inline Toolbar or not
|
|
*/
|
|
private allowedToShow(): boolean {
|
|
/**
|
|
* Tags conflicts with window.selection function.
|
|
* Ex. IMG tag returns null (Firefox) or Redactors wrapper (Chrome)
|
|
*/
|
|
const tagsConflictsWithSelection = ['IMG', 'INPUT'];
|
|
const currentSelection = SelectionUtils.get();
|
|
const selectedText = SelectionUtils.text;
|
|
|
|
// old browsers
|
|
if (!currentSelection || !currentSelection.anchorNode) {
|
|
return false;
|
|
}
|
|
|
|
// empty selection
|
|
if (currentSelection.isCollapsed || selectedText.length < 1) {
|
|
return false;
|
|
}
|
|
|
|
const target = !$.isElement(currentSelection.anchorNode )
|
|
? currentSelection.anchorNode.parentElement
|
|
: currentSelection.anchorNode;
|
|
|
|
if (currentSelection && tagsConflictsWithSelection.includes(target.tagName)) {
|
|
return false;
|
|
}
|
|
|
|
// The selection of the element only in contenteditable
|
|
const contenteditable = target.closest('[contenteditable="true"]');
|
|
if (contenteditable === null) {
|
|
return false;
|
|
}
|
|
|
|
// is enabled by current Block's Tool
|
|
const currentBlock = this.Editor.BlockManager.getBlock(currentSelection.anchorNode as HTMLElement);
|
|
|
|
if (!currentBlock) {
|
|
return false;
|
|
}
|
|
|
|
const toolSettings = this.Editor.Tools.getToolSettings(currentBlock.name);
|
|
|
|
return toolSettings && toolSettings[this.Editor.Tools.apiSettings.IS_ENABLED_INLINE_TOOLBAR];
|
|
}
|
|
|
|
/**
|
|
* Show only allowed Tools
|
|
*/
|
|
private filterTools(): void {
|
|
const currentSelection = SelectionUtils.get(),
|
|
currentBlock = this.Editor.BlockManager.getBlock(currentSelection.anchorNode as HTMLElement);
|
|
|
|
const toolSettings = this.Editor.Tools.getToolSettings(currentBlock.name),
|
|
inlineToolbarSettings = toolSettings && toolSettings[this.Editor.Tools.apiSettings.IS_ENABLED_INLINE_TOOLBAR];
|
|
|
|
/**
|
|
* All Inline Toolbar buttons
|
|
* @type {HTMLElement[]}
|
|
*/
|
|
const buttons = Array.from(this.nodes.buttons.querySelectorAll(`.${this.CSS.inlineToolButton}`)) as HTMLElement[];
|
|
|
|
/**
|
|
* Show previously hided
|
|
*/
|
|
buttons.forEach((button) => {
|
|
button.hidden = false;
|
|
button.classList.remove(this.CSS.inlineToolButtonLast);
|
|
});
|
|
|
|
/**
|
|
* Filter buttons if Block Tool pass config like inlineToolbar=['link']
|
|
*/
|
|
if (Array.isArray(inlineToolbarSettings)) {
|
|
buttons.forEach((button) => {
|
|
button.hidden = !inlineToolbarSettings.includes(button.dataset.tool);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Tick for removing right-margin from last visible button.
|
|
* Current generation of CSS does not allow to filter :visible elements
|
|
*/
|
|
const lastVisibleButton = buttons.filter((button) => !button.hidden).pop();
|
|
|
|
if (lastVisibleButton) {
|
|
lastVisibleButton.classList.add(this.CSS.inlineToolButtonLast);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Working with Tools
|
|
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
*/
|
|
|
|
/**
|
|
* Fill Inline Toolbar with Tools
|
|
*/
|
|
private addTools(): void {
|
|
this.tools.forEach((toolInstance, toolName) => {
|
|
this.addTool(toolName, toolInstance);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Add tool button and activate clicks
|
|
*/
|
|
private addTool(toolName: string, tool: InlineTool): void {
|
|
const {
|
|
Listeners,
|
|
Tools,
|
|
} = this.Editor;
|
|
|
|
const button = tool.render();
|
|
|
|
if (!button) {
|
|
_.log('Render method must return an instance of Node', 'warn', toolName);
|
|
return;
|
|
}
|
|
|
|
button.dataset.tool = toolName;
|
|
this.nodes.buttons.appendChild(button);
|
|
|
|
if (typeof tool.renderActions === 'function') {
|
|
const actions = tool.renderActions();
|
|
this.nodes.actions.appendChild(actions);
|
|
}
|
|
|
|
Listeners.on(button, 'click', (event) => {
|
|
this.toolClicked(tool);
|
|
event.preventDefault();
|
|
});
|
|
|
|
/**
|
|
* Enable shortcuts
|
|
* Ignore tool that doesn't have shortcut or empty string
|
|
*/
|
|
const toolSettings = Tools.getToolSettings(toolName);
|
|
|
|
let shortcut = null;
|
|
|
|
/**
|
|
* Get internal inline tools
|
|
*/
|
|
const internalTools: string[] = Object
|
|
.entries(Tools.internalTools)
|
|
.filter(([name, toolClass]: [string, ToolConstructable | ToolSettings]) => {
|
|
if (_.isFunction(toolClass)) {
|
|
return toolClass[Tools.apiSettings.IS_INLINE];
|
|
}
|
|
|
|
return (toolClass as ToolSettings).class[Tools.apiSettings.IS_INLINE];
|
|
})
|
|
.map(([name]: [string, InlineToolConstructable | ToolSettings]) => name);
|
|
|
|
/**
|
|
* 1) For internal tools, check public getter 'shortcut'
|
|
* 2) For external tools, check tool's settings
|
|
*/
|
|
if (internalTools.includes(toolName)) {
|
|
shortcut = this.inlineTools[toolName].shortcut;
|
|
} else if (toolSettings && toolSettings[Tools.apiSettings.SHORTCUT]) {
|
|
shortcut = toolSettings[Tools.apiSettings.SHORTCUT];
|
|
}
|
|
|
|
if (shortcut) {
|
|
this.enableShortcuts(tool, shortcut);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enable Tool shortcut with Editor Shortcuts Module
|
|
* @param {InlineTool} tool - Tool instance
|
|
* @param {string} shortcut - shortcut according to the ShortcutData Module format
|
|
*/
|
|
private enableShortcuts(tool: InlineTool, shortcut: string): void {
|
|
this.Editor.Shortcuts.add({
|
|
name: shortcut,
|
|
handler: (event) => {
|
|
const {currentBlock} = this.Editor.BlockManager;
|
|
|
|
/**
|
|
* Editor is not focused
|
|
*/
|
|
if (!currentBlock) {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* We allow to fire shortcut with empty selection (isCollapsed=true)
|
|
* it can be used by tools like «Mention» that works without selection:
|
|
* Example: by SHIFT+@ show dropdown and insert selected username
|
|
*/
|
|
// if (SelectionUtils.isCollapsed) return;
|
|
|
|
const toolSettings = this.Editor.Tools.getToolSettings(currentBlock.name);
|
|
|
|
if (!toolSettings || !toolSettings[this.Editor.Tools.apiSettings.IS_ENABLED_INLINE_TOOLBAR]) {
|
|
return;
|
|
}
|
|
|
|
event.preventDefault();
|
|
this.toolClicked(tool);
|
|
},
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Inline Tool button clicks
|
|
* @param {InlineTool} tool - Tool's instance
|
|
*/
|
|
private toolClicked(tool: InlineTool): void {
|
|
const range = SelectionUtils.range;
|
|
|
|
tool.surround(range);
|
|
this.checkToolsState();
|
|
}
|
|
|
|
/**
|
|
* Check Tools` state by selection
|
|
*/
|
|
private checkToolsState(): void {
|
|
this.tools.forEach((toolInstance) => {
|
|
toolInstance.checkState(SelectionUtils.get());
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get inline tools tools
|
|
* Tools that has isInline is true
|
|
*/
|
|
private get inlineTools(): { [name: string]: InlineTool } {
|
|
const result = {};
|
|
|
|
for (const tool in this.Editor.Tools.inline) {
|
|
if (this.Editor.Tools.inline.hasOwnProperty(tool)) {
|
|
const toolSettings = this.Editor.Tools.getToolSettings(tool);
|
|
|
|
result[tool] = this.Editor.Tools.constructInline(this.Editor.Tools.inline[tool], toolSettings);
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
}
|