Vizel API / core/src / VizelEmbedOptions

Interface: VizelEmbedOptions

Defined in: packages/core/src/extensions/embed.ts:51

Embed extension options

Properties

encoding?

optional encoding?: VizelMarkdownLossyEncodingMode;

Defined in: packages/core/src/extensions/embed.ts:89

Markdown encoding mode.

• "default" emits the lossy form [title || url](url). Metadata such as type and provider is lost on round-trip.
• "metadata-comment" emits the lossless form [title || url](url)<!-- vizel:embed type="..." provider="..." --> so the metadata survives round-trips through plain markdown.

Default

"default"

---

fetchEmbedData?

optional fetchEmbedData?: VizelFetchEmbedDataFn;

Defined in: packages/core/src/extensions/embed.ts:61

Function to fetch embed data from URL

By default, uses createVizelDefaultFetchEmbedData() which fetches oEmbed data for CORS-enabled providers (YouTube, Vimeo, Spotify, etc.)

For full OGP/metadata support, provide a custom function that uses a server-side proxy to fetch page metadata.

---

HTMLAttributes?

optional HTMLAttributes?: Record<string, unknown>;

Defined in: packages/core/src/extensions/embed.ts:65

HTML attributes for the embed wrapper

---

inline?

optional inline?: boolean;

Defined in: packages/core/src/extensions/embed.ts:69

Inline embeds (rendered inline with text) vs block embeds

---

onFetchError?

optional onFetchError?: (error, url) => void;

Defined in: packages/core/src/extensions/embed.ts:77

Called when embed data fetch fails. If not provided, errors are logged to console.

Parameters

Parameter	Type	Description
error	Error	The error that occurred
url	string	The URL that failed to fetch

Returns

void

---

pasteHandler?

optional pasteHandler?: boolean;

Defined in: packages/core/src/extensions/embed.ts:67

Enable paste handler for URL detection

---

providers?

optional providers?: readonly VizelEmbedProvider[];

Defined in: packages/core/src/extensions/embed.ts:63

Custom providers to add or override