mirror of
https://github.com/codex-team/editor.js
synced 2024-05-19 06:47:16 +02:00
ac93017c70
* 2.16.0 * [Refactor] Separate internal and external settings (#845) * Enable flipping tools via standalone class (#830) * Enable flipping tools via standalone class * use flipper to refactor (#842) * use flipper to refactor * save changes * update * fix flipper on inline toolbar * ready for testing * requested changes * update doc * updates * destroy flippers * some requested changes * update * update * ready * update * last changes * update docs * Hghl active button of CT, simplify activate/deactivate * separate dom iterator * unhardcode directions * fixed a link in readme.md (#856) * Fix Block selection via CMD+A (#829) * Fix Block selection via CMD+A * Delete editor.js.map * update * update * Update CHANGELOG.md * Improve style of selected blocks (#858) * Cross-block-selection style improved * Update CHANGELOG.md * Fix case when property 'observer' in modificationObserver is not defined (#866) * Bump lodash.template from 4.4.0 to 4.5.0 (#885) Bumps [lodash.template](https://github.com/lodash/lodash) from 4.4.0 to 4.5.0. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](https://github.com/lodash/lodash/compare/4.4.0...4.5.0) Signed-off-by: dependabot[bot] <support@github.com> * Bump eslint-utils from 1.3.1 to 1.4.2 (#886) Bumps [eslint-utils](https://github.com/mysticatea/eslint-utils) from 1.3.1 to 1.4.2. - [Release notes](https://github.com/mysticatea/eslint-utils/releases) - [Commits](https://github.com/mysticatea/eslint-utils/compare/v1.3.1...v1.4.2) Signed-off-by: dependabot[bot] <support@github.com> * Bump mixin-deep from 1.3.1 to 1.3.2 (#887) Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. - [Release notes](https://github.com/jonschlinkert/mixin-deep/releases) - [Commits](https://github.com/jonschlinkert/mixin-deep/compare/1.3.1...1.3.2) Signed-off-by: dependabot[bot] <support@github.com> * update bundle and readme * Update README.md * upd codeowners, fix funding * Minor Docs Fix according to main Readme (#916) * Inline Toolbar now contains Conversion Toolbar (#932) * Block lifecycle hooks (#906) * [Fix] Arrow selection (#964) * Fix arrow selection * Add docs * [issue-926]: fix dom iterator leafing when items are empty (#958) * [issue-926]: fix dom iterator leafing when items are empty * update Changelog * Issue 869 (#963) * Fix issue 943 (#965) * [Draft] Feature/tooltip enhancements (#907) * initial * update * make module standalone * use tooltips as external module * update * build via prod mode * add tooltips as external module * add declaration file and options param * add api tooltip * update * removed submodule * removed due to the incorrect setip * setup tooltips again * wip * update tooltip module * toolbox, inline toolbar * Tooltips in block tunes not uses shorthand * shorthand in a plus and block settings * fix doc * Update tools-inline.md * Delete tooltip.css * Update CHANGELOG.md * Update codex.tooltips * Update api.md * [issue-779]: Grammarly conflicts (#956) * grammarly conflicts * update * upd bundle * Submodule Header now on master * Submodule Marker now on master * Submodule Paragraph now on master * Submodule InlineCode now on master * Submodule Simple Image now on master * [issue-868]: Deleting multiple blocks triggers back button in Firefox (#967) * Deleting multiple blocks triggers back button in Firefox @evgenusov * Update editor.js * Update CHANGELOG.md * pass options on removeEventListener (#904) * pass options on removeEventListener by removeAll * rebuild * Merge branch 'release/2.16' into pr/904 * Update CHANGELOG.md * Update inline.ts * [Fix] Selection rangecount (#968) * Fix #952 (#969) * Update codex.tooltips * Selection bugfix (#970) * Selection bugfix * fix cross block selection * close inline toolbar when blocks selected via shift * remove inline toolbar closing on cross block selection mouse up due to the bug (#972) * [Feature] Log levels (#971) * Decrease margins (#973) * Decrease margins * Update editor.licenses.txt * Update src/components/domIterator.ts Co-Authored-By: Murod Khaydarov <murod.haydarov@gmail.com> * [Fix] Fix delete blocks api method (#974) * Update docs/usage.md Co-Authored-By: Murod Khaydarov <murod.haydarov@gmail.com> * rm unused * Update yarn.lock file * upd bundle, changelog
490 lines
11 KiB
TypeScript
490 lines
11 KiB
TypeScript
/**
|
|
* Class Util
|
|
*/
|
|
|
|
import Dom from './dom';
|
|
|
|
/**
|
|
* Possible log levels
|
|
*/
|
|
export enum LogLevels {
|
|
VERBOSE = 'VERBOSE',
|
|
INFO = 'INFO',
|
|
WARN = 'WARN',
|
|
ERROR = 'ERROR',
|
|
}
|
|
|
|
/**
|
|
* Allow to use global VERSION, that will be overwritten by Webpack
|
|
*/
|
|
declare const VERSION: string;
|
|
|
|
/**
|
|
* @typedef {Object} ChainData
|
|
* @property {Object} data - data that will be passed to the success or fallback
|
|
* @property {Function} function - function's that must be called asynchronically
|
|
*/
|
|
export interface ChainData {
|
|
data?: any;
|
|
function: (...args: any[]) => any;
|
|
}
|
|
|
|
/**
|
|
* Editor.js utils
|
|
*/
|
|
|
|
/**
|
|
* Returns basic keycodes as constants
|
|
* @return {{}}
|
|
*/
|
|
export const keyCodes = {
|
|
BACKSPACE: 8,
|
|
TAB: 9,
|
|
ENTER: 13,
|
|
SHIFT: 16,
|
|
CTRL: 17,
|
|
ALT: 18,
|
|
ESC: 27,
|
|
SPACE: 32,
|
|
LEFT: 37,
|
|
UP: 38,
|
|
DOWN: 40,
|
|
RIGHT: 39,
|
|
DELETE: 46,
|
|
META: 91,
|
|
};
|
|
|
|
/**
|
|
* Return mouse buttons codes
|
|
*/
|
|
export const mouseButtons = {
|
|
LEFT: 0,
|
|
WHEEL: 1,
|
|
RIGHT: 2,
|
|
BACKWARD: 3,
|
|
FORWARD: 4,
|
|
};
|
|
|
|
/**
|
|
* Custom logger
|
|
*
|
|
* @param {boolean} labeled — if true, Editor.js label is shown
|
|
* @param {string} msg - message
|
|
* @param {string} type - logging type 'log'|'warn'|'error'|'info'
|
|
* @param {*} [args] - argument to log with a message
|
|
* @param {string} style - additional styling to message
|
|
* @param labeled
|
|
*/
|
|
function _log(
|
|
labeled: boolean,
|
|
msg: string,
|
|
type: string = 'log',
|
|
args?: any,
|
|
style: string = 'color: inherit',
|
|
): void {
|
|
|
|
if ( !('console' in window) || !window.console[ type ] ) {
|
|
return;
|
|
}
|
|
|
|
const isSimpleType = ['info', 'log', 'warn', 'error'].includes(type);
|
|
const argsToPass = [];
|
|
|
|
switch (_log.logLevel) {
|
|
case LogLevels.ERROR:
|
|
if (type !== 'error') {
|
|
return;
|
|
}
|
|
break;
|
|
|
|
case LogLevels.WARN:
|
|
if (!['error', 'warn'].includes(type)) {
|
|
return;
|
|
}
|
|
break;
|
|
|
|
case LogLevels.INFO:
|
|
if (!isSimpleType || labeled) {
|
|
return;
|
|
}
|
|
break;
|
|
}
|
|
|
|
if (args) {
|
|
argsToPass.push(args);
|
|
}
|
|
|
|
const editorLabelText = `Editor.js ${VERSION}`;
|
|
const editorLabelStyle = `line-height: 1em;
|
|
color: #006FEA;
|
|
display: inline-block;
|
|
font-size: 11px;
|
|
line-height: 1em;
|
|
background-color: #fff;
|
|
padding: 4px 9px;
|
|
border-radius: 30px;
|
|
border: 1px solid rgba(56, 138, 229, 0.16);
|
|
margin: 4px 5px 4px 0;`;
|
|
|
|
if (labeled) {
|
|
if (isSimpleType) {
|
|
argsToPass.unshift(editorLabelStyle, style);
|
|
msg = `%c${editorLabelText}%c ${msg}`;
|
|
} else {
|
|
msg = `( ${editorLabelText} )${msg}`;
|
|
}
|
|
}
|
|
|
|
try {
|
|
if (!isSimpleType) {
|
|
console[type](msg);
|
|
} else if (args) {
|
|
console[type](`${msg} %o`, ...argsToPass);
|
|
} else {
|
|
console[type](msg, ...argsToPass);
|
|
}
|
|
} catch (ignored) {}
|
|
}
|
|
|
|
/**
|
|
* Current log level
|
|
*/
|
|
_log.logLevel = LogLevels.VERBOSE;
|
|
|
|
/**
|
|
* Set current log level
|
|
*
|
|
* @param {LogLevels} logLevel - log level to set
|
|
*/
|
|
export function setLogLevel(logLevel: LogLevels) {
|
|
_log.logLevel = logLevel;
|
|
}
|
|
|
|
/**
|
|
* _log method proxy without Editor.js label
|
|
*/
|
|
export const log = _log.bind(window, false);
|
|
|
|
/**
|
|
* _log method proxy with Editor.js label
|
|
*/
|
|
export const logLabeled = _log.bind(window, true);
|
|
|
|
/**
|
|
* Returns true if passed key code is printable (a-Z, 0-9, etc) character.
|
|
* @param {number} keyCode
|
|
* @return {boolean}
|
|
*/
|
|
export function isPrintableKey( keyCode: number ): boolean {
|
|
return (keyCode > 47 && keyCode < 58) || // number keys
|
|
keyCode === 32 || keyCode === 13 || // Spacebar & return key(s)
|
|
(keyCode > 64 && keyCode < 91) || // letter keys
|
|
(keyCode > 95 && keyCode < 112) || // Numpad keys
|
|
(keyCode > 185 && keyCode < 193) || // ;=,-./` (in order)
|
|
(keyCode > 218 && keyCode < 223); // [\]' (in order)
|
|
}
|
|
|
|
/**
|
|
* Fires a promise sequence asyncronically
|
|
*
|
|
* @param {ChainData[]} chains - list or ChainData's
|
|
* @param {Function} success - success callback
|
|
* @param {Function} fallback - callback that fires in case of errors
|
|
*
|
|
* @return {Promise}
|
|
*/
|
|
export async function sequence(
|
|
chains: ChainData[],
|
|
success: (data: any) => void = () => {},
|
|
fallback: (data: any) => void = () => {},
|
|
): Promise<void> {
|
|
/**
|
|
* Decorator
|
|
*
|
|
* @param {ChainData} chainData
|
|
*
|
|
* @param {Function} successCallback
|
|
* @param {Function} fallbackCallback
|
|
*
|
|
* @return {Promise}
|
|
*/
|
|
async function waitNextBlock(
|
|
chainData: ChainData,
|
|
successCallback: (data: any) => void,
|
|
fallbackCallback: (data: any) => void,
|
|
): Promise<void> {
|
|
try {
|
|
await chainData.function(chainData.data);
|
|
await successCallback(typeof chainData.data !== 'undefined' ? chainData.data : {});
|
|
} catch (e) {
|
|
fallbackCallback(typeof chainData.data !== 'undefined' ? chainData.data : {});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* pluck each element from queue
|
|
* First, send resolved Promise as previous value
|
|
* Each plugins "prepare" method returns a Promise, that's why
|
|
* reduce current element will not be able to continue while can't get
|
|
* a resolved Promise
|
|
*/
|
|
return await chains.reduce(async (previousValue, currentValue) => {
|
|
await previousValue;
|
|
return waitNextBlock(currentValue, success, fallback);
|
|
}, Promise.resolve());
|
|
}
|
|
|
|
/**
|
|
* Make array from array-like collection
|
|
*
|
|
* @param {ArrayLike} collection
|
|
*
|
|
* @return {Array}
|
|
*/
|
|
export function array(collection: ArrayLike<any>): any[] {
|
|
return Array.prototype.slice.call(collection);
|
|
}
|
|
|
|
/**
|
|
* Check if passed variable is a function
|
|
* @param {*} fn
|
|
* @return {boolean}
|
|
*/
|
|
export function isFunction(fn: any): boolean {
|
|
return typeof fn === 'function';
|
|
}
|
|
|
|
/**
|
|
* Check if passed function is a class
|
|
* @param {function} fn
|
|
* @return {boolean}
|
|
*/
|
|
export function isClass(fn: any): boolean {
|
|
return typeof fn === 'function' && /^\s*class\s+/.test(fn.toString());
|
|
}
|
|
|
|
/**
|
|
* Checks if object is empty
|
|
*
|
|
* @param {Object} object
|
|
* @return {boolean}
|
|
*/
|
|
export function isEmpty(object: object): boolean {
|
|
if (!object) {
|
|
return true;
|
|
}
|
|
|
|
return Object.keys(object).length === 0 && object.constructor === Object;
|
|
}
|
|
|
|
/**
|
|
* Check if passed object is a Promise
|
|
* @param {*} object - object to check
|
|
* @return {Boolean}
|
|
*/
|
|
export function isPromise(object: any): boolean {
|
|
return Promise.resolve(object) === object;
|
|
}
|
|
|
|
/**
|
|
* Delays method execution
|
|
*
|
|
* @param {Function} method
|
|
* @param {Number} timeout
|
|
*/
|
|
export function delay(method: (...args: any[]) => any, timeout: number) {
|
|
return function() {
|
|
const context = this,
|
|
args = arguments;
|
|
|
|
window.setTimeout(() => method.apply(context, args), timeout);
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Get file extension
|
|
*
|
|
* @param {File} file
|
|
* @return string
|
|
*/
|
|
export function getFileExtension(file: File): string {
|
|
return file.name.split('.').pop();
|
|
}
|
|
|
|
/**
|
|
* Check if string is MIME type
|
|
*
|
|
* @param {string} type
|
|
* @return boolean
|
|
*/
|
|
export function isValidMimeType(type: string): boolean {
|
|
return /^[-\w]+\/([-+\w]+|\*)$/.test(type);
|
|
}
|
|
|
|
/**
|
|
* Debouncing method
|
|
* Call method after passed time
|
|
*
|
|
* Note that this method returns Function and declared variable need to be called
|
|
*
|
|
* @param {Function} func - function that we're throttling
|
|
* @param {Number} wait - time in milliseconds
|
|
* @param {Boolean} immediate - call now
|
|
* @return {Function}
|
|
*/
|
|
export function debounce(func: () => void, wait?: number , immediate?: boolean): () => void {
|
|
let timeout;
|
|
|
|
return () => {
|
|
const context = this,
|
|
args = arguments;
|
|
|
|
const later = () => {
|
|
timeout = null;
|
|
if (!immediate) {
|
|
func.apply(context, args);
|
|
}
|
|
};
|
|
|
|
const callNow = immediate && !timeout;
|
|
|
|
window.clearTimeout(timeout);
|
|
timeout = window.setTimeout(later, wait);
|
|
if (callNow) {
|
|
func.apply(context, args);
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Copies passed text to the clipboard
|
|
* @param text
|
|
*/
|
|
export function copyTextToClipboard(text) {
|
|
const el = Dom.make('div', 'codex-editor-clipboard', {
|
|
innerHTML: text,
|
|
});
|
|
|
|
document.body.appendChild(el);
|
|
|
|
const selection = window.getSelection();
|
|
const range = document.createRange();
|
|
range.selectNode(el);
|
|
|
|
window.getSelection().removeAllRanges();
|
|
selection.addRange(range);
|
|
|
|
document.execCommand('copy');
|
|
document.body.removeChild(el);
|
|
}
|
|
|
|
/**
|
|
* Returns object with os name as key and boolean as value. Shows current user OS
|
|
*
|
|
* @return {[key: string]: boolean}
|
|
*/
|
|
export function getUserOS(): {[key: string]: boolean} {
|
|
const OS = {
|
|
win: false,
|
|
mac: false,
|
|
x11: false,
|
|
linux: false,
|
|
};
|
|
|
|
const userOS = Object.keys(OS).find((os: string) => navigator.appVersion.toLowerCase().indexOf(os) !== -1);
|
|
|
|
if (userOS) {
|
|
OS[userOS] = true;
|
|
return OS;
|
|
}
|
|
|
|
return OS;
|
|
}
|
|
|
|
/**
|
|
* Capitalizes first letter of the string
|
|
* @param {string} text
|
|
* @return {string}
|
|
*/
|
|
export function capitalize(text: string): string {
|
|
return text[0].toUpperCase() + text.slice(1);
|
|
}
|
|
|
|
/**
|
|
* Merge to objects recursively
|
|
* @param {object} target
|
|
* @param {object[]} sources
|
|
* @return {object}
|
|
*/
|
|
export function deepMerge(target, ...sources) {
|
|
const isObject = (item) => item && typeOf(item) === 'object';
|
|
|
|
if (!sources.length) { return target; }
|
|
const source = sources.shift();
|
|
|
|
if (isObject(target) && isObject(source)) {
|
|
for (const key in source) {
|
|
if (isObject(source[key])) {
|
|
if (!target[key]) {
|
|
Object.assign(target, { [key]: {} });
|
|
}
|
|
|
|
deepMerge(target[key], source[key]);
|
|
} else {
|
|
Object.assign(target, { [key]: source[key] });
|
|
}
|
|
}
|
|
}
|
|
|
|
return deepMerge(target, ...sources);
|
|
}
|
|
|
|
/**
|
|
* Return true if current device supports touch events
|
|
*
|
|
* Note! This is a simple solution, it can give false-positive results.
|
|
* To detect touch devices more carefully, use 'touchstart' event listener
|
|
* @see http://www.stucox.com/blog/you-cant-detect-a-touchscreen/
|
|
*
|
|
* @return {boolean}
|
|
*/
|
|
export const isTouchSupported: boolean = 'ontouchstart' in document.documentElement;
|
|
|
|
/**
|
|
* Return string representation of the object type
|
|
*
|
|
* @param {any} object
|
|
*/
|
|
export function typeOf(object: any): string {
|
|
return Object.prototype.toString.call(object).match(/\s([a-zA-Z]+)/)[1].toLowerCase();
|
|
}
|
|
|
|
/**
|
|
* Make shortcut command more human-readable
|
|
* @param {string} shortcut — string like 'CMD+B'
|
|
*/
|
|
export function beautifyShortcut(shortcut: string): string {
|
|
const OS = getUserOS();
|
|
|
|
shortcut = shortcut
|
|
.replace(/shift/gi, '⇧')
|
|
.replace(/backspace/gi, '⌫')
|
|
.replace(/enter/gi, '⏎')
|
|
.replace(/up/gi, '↑')
|
|
.replace(/left/gi, '→')
|
|
.replace(/down/gi, '↓')
|
|
.replace(/right/gi, '←')
|
|
.replace(/escape/gi, '⎋')
|
|
.replace(/insert/gi, 'Ins')
|
|
.replace(/delete/gi, '␡')
|
|
.replace(/\+/gi, ' + ');
|
|
|
|
if (OS.mac) {
|
|
shortcut = shortcut.replace(/ctrl|cmd/gi, '⌘').replace(/alt/gi, '⌥');
|
|
} else {
|
|
shortcut = shortcut.replace(/cmd/gi, 'Ctrl').replace(/windows/gi, 'WIN');
|
|
}
|
|
|
|
return shortcut;
|
|
}
|