> ## Documentation Index
> Fetch the complete documentation index at: https://docs.embededitor.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> The package's two entries, what each one exports, and how the editor reports a value it can't take.

The API reference lists every component, function, prop and type the package exports.

## Entries

The package has two entries and no root. Import one of them: `import '@embededitor/full'` fails on purpose.

| Entry | Values | Use it for |
| - | - | - |
| `@embededitor/full/react` | `EmbedEditor`, `openEditor`, `processImage`, `EmbedEditorError` | React apps. Needs `react` and `react-dom` 18.3 or 19 as peers. |
| `@embededitor/full/standalone` | `mountEditor`, `openEditor`, `processImage`, `EmbedEditorError` | Any other page or framework. React is inside it. |

There is no CSS to import. The Lite and Free packages have the same entries under their own names.

## Types

Both entries export the same types. The standalone entry's `.d.ts` imports nothing, not even React's types.

| Type | What it describes |
| - | - |
| `EmbedEditorProps` | The props of `EmbedEditor`, and the options of `mountEditor` and `openEditor`. |
| `EditState` | The saved edits `onProcess` hands back and the `state` prop takes. |
| `PinturaState` | A state saved by the legacy Pintura editor, which `state` also reads. |
| `ProcessImageOptions` | The options of `processImage`. |
| `EmbedEditorColors` | The `colors` prop. |
| `EmbedEditorWatermark`, `EmbedEditorSignature`, `EmbedEditorMarkSource` | The `watermark` and `signature` props, and the image a mark takes. |
| `EmbedEditorHandle` | The editor's commands, reads and events: a `ref` on `EmbedEditor`, and what `mountEditor` and `openEditor` return. |
| `EmbedEditorEvents`, `EmbedEditorCommand`, `EmbedEditorMenuItem`, `EmbedEditorTool`, `EmbedEditorSelection` | What each event hands its handler, an entry of `commands()`, a menu item, a tool and a selection. |
| `EmbedEditorErrorCode`, `EmbedEditorCommandErrorCode` | The `code` of an `EmbedEditorError`: the editor's own, and a command's. |
| `Lang`, `LangTexts`, `MessageKey` | The built-in language codes and your own texts. |
| `Rect`, `Size` | A rectangle and a size, in px. |

Every public type carries its documentation, so your IDE shows each prop's meaning, range and default.

## Dictionaries

The built-in dictionaries are published as JSON, with every message key and its text:

```ts dictionaries.ts theme={"dark"}
import enUs from '@embededitor/full/i18n/en-us.json';
// also '@embededitor/full/i18n/es-es.json' and '@embededitor/full/i18n/pt-br.json'
```

Copy one to start a new language. See [Languages](https://docs.embededitor.com/customization/languages.md).

## Invalid Props

Invalid props never pass silently. A value the editor can't take, a misspelt prop or a removed one shows the error screen naming it and calls `onLoadError` with an `INVALID_PROPS` error. The image still loads underneath, and the editor comes back as soon as the props are valid.

Nothing throws from a render. The one exception to the check is a `lang` code outside the list, which reads `'en-us'`. See [EmbedEditorError](https://docs.embededitor.com/api-reference/errors.md).

## Reference

> [card] [EmbedEditor](https://docs.embededitor.com/api-reference/embed-editor.md)
>
> The React component.

> [card] [mountEditor()](https://docs.embededitor.com/api-reference/mount-editor.md)
>
> The editor inline, on any element.

> [card] [openEditor()](https://docs.embededitor.com/api-reference/open-editor.md)
>
> The editor as a modal.

> [card] [processImage()](https://docs.embededitor.com/api-reference/process-image.md)
>
> Crop, resize and convert with no UI.

> [card] [Commands](https://docs.embededitor.com/api-reference/commands/overview.md)
>
> Run the editor from code.

> [card] [Props](https://docs.embededitor.com/api-reference/props.md)
>
> Every prop, its type and default.

> [card] [EditState](https://docs.embededitor.com/api-reference/state.md)
>
> The saved edits.

> [card] [Annotation Fields](https://docs.embededitor.com/api-reference/annotations.md)
>
> What a saved annotation holds.

> [card] [EmbedEditorError](https://docs.embededitor.com/api-reference/errors.md)
>
> The error and its codes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.