@trevixal/extension-embed

Documentation · Live editor · Changelog · Issues

Features

• Video, audio, YouTube, Vimeo and iframe embeds
• File attachments and link preview cards
• 5.8 kB minified and gzipped, with TypeScript types in the package

Media and links: video, audio, YouTube and Vimeo, allowlisted iframes, file attachments and link preview cards.

npm install @trevixal/extension-embed
Copy

Usage

Merge the nodes into your schema:

new Schema({ nodes: { ...defaultNodes(), ...embedNodes() }, marks: defaultMarks() })
Copy

import { insertEmbed, attachments, DEFAULT_IFRAME_HOSTS } from '@trevixal/extension-embed'

// One command for a pasted URL: it works out what the URL is.
editor.exec(insertEmbed('https://www.youtube.com/watch?v=…'))

const files = attachments(editor, {
  storage: myFileStorage,
  onUpload: (status) => showProgress(status),
})
Copy

embedNodes({ allowIframeHosts: [...DEFAULT_IFRAME_HOSTS, 'player.example.com'] }) widens the iframe allowlist.

One allowlist, checked before the node exists

Every URL (pasted, typed, or handed to a command) goes through safeEmbedSrc, safeMediaSrc or safeWebURL before a node is created, so the same rules vet pasted HTML and programmatic inserts alike. Credentials in a URL are refused outright, and https://youtube.com@evil.example/ is seen for what it is: its hostname is evil.example.

Exports and origins

A YouTube player will not start in a page opened from disk. A file:// page has no origin to send, and YouTube answers with its own error screen inside the frame. @trevixal/ui replaces a YouTube frame with a link when the page was not served over http(s). Vimeo and ordinary iframes were measured loading from a local file perfectly well, so they are left alone.

Commands

insertVideo, insertAudio, insertIframe, insertLinkCard, insertLinkCardFor, insertAttachment, insertEmbed, updateEmbedAttrs, deleteEmbed, embedAtSelection, plus parseEmbedURL and embedProviderFor if you want to decide for yourself.

License

Apache-2.0