Events

Every callback and DOM event of the image editor, with its payload. See Events for examples.

CallbacksCopy Anchor Link

DOM eventsCopy Anchor Link

<media-editor-image> sends these events. They bubble, and they cross shadow DOM boundaries.

Callbacks that return a value, such as onSaveTemplate and onGetTemplates, have no DOM event. Pass them through the props property.

EditorExtrasCopy Anchor Link

The second argument of onExport.

Every field is optional, and so is the whole object. Read each field with a check, such as extras?.email?.to.

templatesave detailCopy Anchor Link

TemplateCopy Anchor Link

UploadAssetContextCopy Anchor Link

The second argument of onUploadAsset.

LicenseStateReportCopy Anchor Link

The argument of onLicenseState. It never contains the license key.

BlockedState, the argument of renderLicenseBlocked, is the blocked state: { status: 'blocked', reason, message }. See Error codes for every reason.

AI generationCopy Anchor Link

Pass generation observers inside ai, rather than as editor event props.

import type { EditorAIConfig } from '@layermetry/media-editor';

export const ai: EditorAIConfig = {
  endpointUrl: '/api/ai', image: true,
  onGenerationError: (error, context) => {
    console.warn(error.code, error.providerError?.requestId, context.attemptId);
  },
  onGenerationEvent: (event) => {
    if (event.type === 'progress') console.info(event.percent, event.stage);
  },
};

Hooks observe only. Returning a value does not recover a generation. Throwing does not change its outcome.

Error contextCopy Anchor Link

The error context identifies the attempt without copying request content.

The context contains no prompt, source, body, header values or license key. The accompanying error can contain providerError; see Provider errors.

Lifecycle eventsCopy Anchor Link

Every event contains type, attemptId and operation.

One attempt emits one start and one terminal success, failure or cancel. A success event confirms generation, not a later user choice to place a candidate.

Generated file receiptCopy Anchor Link

The context of onUploadAsset includes producedBy for generated media.

An omitted identity field stays absent. These fields record identity; they do not prove that a provider applied each requested setting.

CustomActionEventCopy Anchor Link