AI Image Editor

Appearance

API reference ​

Two complementary references, both generated from the source:

  • Components covers the web-component API for <uc-ai-image-editor>: attributes, properties, events, slots, and CSS custom properties.
  • TypeScript API covers every exported symbol: the editor element, its event and resolver types, the aspect-ratio helpers, and the localization helpers.

Entry points ​

ImportExports
@uploadcare/ai-image-editor<uc-ai-image-editor> registration, the editor types, the aspect-ratio helpers, and the localization helpers.
@uploadcare/ai-image-editor/pluginAiImageEditorPlugin, AiEditorActivityParams, aspectRatiosFromCropPreset.
@uploadcare/ai-image-editor/errorsAiImageEditorError, AiImageEditorErrorCode, AiImageEditorErrorOptions. Side-effect-free, so it's safe in server code.