Skip to content

API reference

Two complementary references, both generated from the source:

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

Entry points

ImportExports
@uploadcare/ai-enhancer<uc-ai-enhancer> registration, the editor types, the aspect-ratio helpers, and the localization helpers.
@uploadcare/ai-enhancer/pluginAiEnhancerPlugin, AiEditorActivityParams, aspectRatiosFromCropPreset.
@uploadcare/ai-enhancer/errorsAiEnhancerError, AiEnhancerErrorCode, AiEnhancerErrorOptions — side-effect-free (safe in server code).