openEditor()

const openEditor: (options?: Omit<EmbedEditorProps, 'layout'>) => EmbedEditorHandle & { close: () => void };

​

Parameters

​

Returns

​

Behavior

• The modal opens in its own host on document.body, as a dialog on a desktop and as a bottom sheet on a phone.
• Save closes it once onProcess returns. If onProcess throws, the modal stays open, so the user can save again.
• closeOnEscape decides whether Escape closes it. Close and Save always do.
• However it closes (close, its Close button, Escape, a Save that went through, the commands editor.close and output.save), its handle takes no more commands: every command waiting, and every one called after, rejects with NOT_AVAILABLE.
• openEditor touches the DOM, so call it from an event handler or an effect, never during a server render.

​

Example

import { openEditor } from '@embededitor/full/react';

const editPhoto = (file: File) => {
	const { close } = openEditor({
		onClose: () => {
			console.info('editor closed');
		},
		onProcess: ({ dest }) => {
			console.info('saved', dest.name);
		},
		src: file
	});

	return close;
};