mirror of
https://github.com/codex-team/editor.js
synced 2024-05-07 00:46:45 +02:00
581289c03e
* Default tunes to popover * Add the rest of default tunes * Add popover * Cleanup * Rename custom content * Cleanup * Add ability to open block settings upwards * Fix tests * Cleanup default tunes * Rename and cleanup * Add ability to display rendered custom tunes * cleanup * Rename * Add flag to close tunes popover * Cleanup * i18n * Cleanup * Fix build and tests * Fix for iframe * Add comments * Display active item, move closeOnActivate to popover * Add confirmation support to popover * Handle boolean value in confirmation param * Clarify flippable logic in popover * Comments * Pass editor element as a param of popover constructor * Fix readability * Tests * Fix flipper for confirmation element * Update confirmation config structure * Rename onClick to onActivate * Fix tests and build * Make confirmation props optional * Simplify processing tunes * Renamings * Fix text block tunes * Docs * Update event type * Move enabling confirmation state to separate method * move popover types * Unhardcode color * Support toggling * Add support of disabled items * Fix tab in empty block leading to selecting second item in popover * Remove margins for styles api settings button class * Fix arrow navigation between blocks after opening block tunes * Cleaup in default tunes code * Fix chaining confirmations * Colors * Types * Change the way flippable elements of popover custom area are set * Remove borders around popover icons * Fix untabbable inline toolbar * Fix locked scroll after closing tunes popover on mobile * Cleanup * Set max popover width * Make popover icon's border outside * Fix tab issue * Fix focus/hover issue * Reformat * Cleanup * Fix opening block tunes via keyboard * Add disableSpecialHoverAndFocusBehavior * Add deprecated comment * Cleanup * Fix popover active state * Fix checklist deletion with confirmation * Fix checklist deletion 2 * Fix popover focus * Fix popover items being impossible to flip after searching * Fix popover item highlighting issue * Update flipper.spec.ts * Fixes after review * Add Tunes Api tests * Fix multiple popover entries configured by one tune * Add tool's renderSettings() tests * Add popover confirmation state test * Fix popover width on mobile * Add popover tests * Add changelog and update version * Update changelog * Fix block tunes being unable to open after tune activation Co-authored-by: Peter Savchenko <specc.dev@gmail.com>
331 lines
8 KiB
TypeScript
331 lines
8 KiB
TypeScript
import Header from '@editorjs/header';
|
|
import Code from '@editorjs/code';
|
|
import Delimiter from '@editorjs/delimiter';
|
|
import { BlockMutationType } from '../../../types/events/block/mutation-type';
|
|
|
|
/**
|
|
* @todo Add checks that correct block API object is passed to onChange
|
|
* @todo Add cases for native inputs changes
|
|
* @todo debug onChange firing on Block Tune toggling (see below)
|
|
*/
|
|
describe('onChange callback', () => {
|
|
/**
|
|
* Creates Editor instance
|
|
*
|
|
* @param blocks - list of blocks to prefill the editor
|
|
*/
|
|
function createEditor(blocks = null): void {
|
|
const config = {
|
|
tools: {
|
|
header: Header,
|
|
code: Code,
|
|
},
|
|
onChange: (api, event): void => {
|
|
console.log('something changed', api, event);
|
|
},
|
|
data: blocks ? {
|
|
blocks,
|
|
} : null,
|
|
};
|
|
|
|
cy.spy(config, 'onChange').as('onChange');
|
|
|
|
cy.createEditor(config).as('editorInstance');
|
|
}
|
|
|
|
/**
|
|
* Creates Editor instance with save inside the onChange event.
|
|
*
|
|
* @param blocks - list of blocks to prefill the editor
|
|
*/
|
|
function createEditorWithSave(blocks = null): void {
|
|
const config = {
|
|
tools: {
|
|
header: Header,
|
|
code: Code,
|
|
delimiter: Delimiter,
|
|
},
|
|
onChange: (api, event): void => {
|
|
console.log('something changed', api, event);
|
|
api.saver.save();
|
|
},
|
|
data: blocks ? {
|
|
blocks,
|
|
} : null,
|
|
};
|
|
|
|
cy.spy(config, 'onChange').as('onChange');
|
|
|
|
cy.createEditor(config).as('editorInstance');
|
|
}
|
|
|
|
/**
|
|
* EditorJS API is passed as the first parameter of the onChange callback
|
|
*/
|
|
const EditorJSApiMock = Cypress.sinon.match.any;
|
|
|
|
it('should fire onChange callback with correct index on block insertion above the current (by pressing Enter at the start)', () => {
|
|
createEditor();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click()
|
|
.type('{enter}');
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Added,
|
|
detail: {
|
|
target: {
|
|
name: 'paragraph',
|
|
},
|
|
index: 0,
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange callback with correct index on block insertion below the current (by pressing enter at the end)', () => {
|
|
createEditor();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click()
|
|
.type('some text')
|
|
.type('{enter}');
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Added,
|
|
detail: {
|
|
target: {
|
|
name: 'paragraph',
|
|
},
|
|
index: 1,
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange callback on typing into block', () => {
|
|
createEditor();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click()
|
|
.type('some text');
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Changed,
|
|
detail: {
|
|
index: 0,
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange callback on block insertion with save inside onChange', () => {
|
|
createEditorWithSave();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-toolbar__plus')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-popover__item[data-item-name=delimiter]')
|
|
.click();
|
|
|
|
cy.get('@onChange').should('be.calledThrice');
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Removed,
|
|
detail: {
|
|
index: 0,
|
|
target: {
|
|
name: 'paragraph',
|
|
},
|
|
},
|
|
}));
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Added,
|
|
detail: {
|
|
index: 0,
|
|
target: {
|
|
name: 'delimiter',
|
|
},
|
|
},
|
|
}));
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Added,
|
|
detail: {
|
|
index: 1,
|
|
target: {
|
|
name: 'paragraph',
|
|
},
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange callback on block replacement for both of blocks', () => {
|
|
createEditor();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-toolbar__plus')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-popover__item[data-item-name=header]')
|
|
.click();
|
|
|
|
cy.get('@onChange').should('be.calledTwice');
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Removed,
|
|
detail: {
|
|
index: 0,
|
|
target: {
|
|
name: 'paragraph',
|
|
},
|
|
},
|
|
}));
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Added,
|
|
detail: {
|
|
index: 0,
|
|
target: {
|
|
name: 'header',
|
|
},
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange callback on tune modifying', () => {
|
|
createEditor([
|
|
{
|
|
type: 'header',
|
|
data: {
|
|
text: 'Header block',
|
|
},
|
|
},
|
|
]);
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('span.ce-toolbar__settings-btn')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('span.cdx-settings-button[data-level=4]')
|
|
.click()
|
|
/**
|
|
* For some reason, the first click fires the mutation of removeFakeCursor only, so we need to click again.
|
|
* Reproduced only in Cypress.
|
|
*
|
|
* @todo debug it later
|
|
*/
|
|
.click();
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Changed,
|
|
detail: {
|
|
index: 0,
|
|
target: {
|
|
name: 'header',
|
|
},
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange callback when block is removed', () => {
|
|
createEditor();
|
|
|
|
/**
|
|
* The only block does not have Tune menu, so need to create at least 2 blocks to test deleting
|
|
*/
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click()
|
|
.type('some text');
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('span.ce-toolbar__settings-btn')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div[data-item-name=delete]')
|
|
.click();
|
|
|
|
/** Second click for confirmation */
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div[data-item-name=delete]')
|
|
.click();
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Removed,
|
|
detail: {
|
|
index: 0,
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange callback when block is moved', () => {
|
|
createEditor();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.click()
|
|
.type('{enter}');
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div.ce-block')
|
|
.last()
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('span.ce-toolbar__settings-btn')
|
|
.click();
|
|
|
|
cy.get('[data-cy=editorjs]')
|
|
.get('div[data-item-name=move-up]')
|
|
.click();
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Moved,
|
|
detail: {
|
|
fromIndex: 1,
|
|
toIndex: 0,
|
|
},
|
|
}));
|
|
});
|
|
|
|
it('should fire onChange if something changed inside native input', () => {
|
|
createEditor([ {
|
|
type: 'code',
|
|
data: {
|
|
code: '',
|
|
},
|
|
} ]);
|
|
|
|
cy.get('[data-cy=editorjs')
|
|
.get('textarea')
|
|
.type('Some input to the textarea');
|
|
|
|
cy.get('@onChange').should('be.calledWithMatch', EditorJSApiMock, Cypress.sinon.match({
|
|
type: BlockMutationType.Changed,
|
|
detail: {
|
|
index: 0,
|
|
},
|
|
}));
|
|
});
|
|
});
|