0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 05:02:57 +01:00

Add ability for Draftail to be initialized via a dispatched CustomEvent

This commit is contained in:
Chiemezuo 2024-02-22 14:25:25 +01:00 committed by LB (Ben Johnston)
parent 514a0aab9f
commit 9ae45aab50
2 changed files with 77 additions and 0 deletions

View File

@ -45,3 +45,18 @@ const entityTypes = [
]; ];
entityTypes.forEach((type) => draftail.registerPlugin(type, 'entityTypes')); entityTypes.forEach((type) => draftail.registerPlugin(type, 'entityTypes'));
/**
* Initialize a Draftail editor on a given element when the w-draftail:init event is fired.
*/
document.addEventListener('w-draftail:init', ({ detail = {}, target }) => {
const id = target.id;
if (!id) {
// eslint-disable-next-line no-console
console.error('`w-draftail:init` event must have a target with an id.');
return;
}
window.draftail.initEditor(`#${id}`, detail, document.currentScript);
});

View File

@ -47,3 +47,65 @@ describe('draftail', () => {
).toEqual(['DOCUMENT', 'LINK', 'IMAGE', 'EMBED', 'undefined']); ).toEqual(['DOCUMENT', 'LINK', 'IMAGE', 'EMBED', 'undefined']);
}); });
}); });
describe('Calling initEditor via event dispatching', () => {
const initEditor = window.draftail.initEditor;
beforeAll(() => {
/* eslint-disable no-console */
// mock console.error to ensure it does not bubble to the logs
jest.spyOn(console, 'error').mockImplementation(() => {});
jest.spyOn(window.draftail, 'initEditor').mockImplementation(() => {});
});
beforeEach(() => {
jest.resetAllMocks();
});
it.only('should support creating a new editor with event dispatching', async () => {
expect(window.draftail.initEditor).not.toHaveBeenCalled();
document.body.innerHTML = '<main><input id="editor"></main>';
document.getElementById('editor').dispatchEvent(
new CustomEvent('w-draftail:init', {
bubbles: true,
cancelable: false,
detail: { some: 'detail' },
}),
);
expect(console.error).toHaveBeenCalledTimes(0);
expect(window.draftail.initEditor).toHaveBeenCalledTimes(1);
expect(window.draftail.initEditor).toHaveBeenLastCalledWith(
'#editor',
{ some: 'detail' },
null,
);
});
it('should not call initEditor & show an error in the console if the event has been dispatched incorrectly', async () => {
expect(window.draftail.initEditor).not.toHaveBeenCalled();
document.dispatchEvent(
new CustomEvent('w-draftail:init', {
bubbles: true,
cancelable: false,
detail: { some: 'detail' },
}),
);
expect(console.error).toHaveBeenCalledTimes(1);
expect(console.error).toHaveBeenCalledWith(
'`w-draftail:init` event must have a target with an id.',
);
expect(window.draftail.initEditor).not.toHaveBeenCalled();
});
afterAll(() => {
console.error.mockRestore();
window.draftail.initEditor.mockRestore();
/* eslint-enable no-console */
});
});