Extensions

youtube

Node 0.77 kB gzipped

A YouTube video, embedded.

Only the id is stored. The frame's address is built from it here, on the privacy-preserving domain, so a document can never carry a frame pointing anywhere else — an embed whose `src` is trusted from JSON is an `<iframe>` to any page an attacker likes.

1 · Install

One package for every extension · there is no @matrajs/youtube to install.

npm i @matrajs/core

2 · Add it to the editor

Import it and put it in the extensions array. That array is the whole feature list: what is not in it is not in your bundle and not in the document's schema.

import { createEditor, document, paragraph, text, youtube } from '@matrajs/core'

const editor = createEditor({
  extensions: [document, paragraph, text, youtube],
  element: document.querySelector('#editor'),
})

3 · Use it

Run a command, and give focus back · a click on a button takes it away.

editor.commands.insertYoutube({ src: 'https://example.com/media' })
editor.focus()

Wired to a button, with the pressed state kept in step:

const button = document.querySelector('#insertYoutube')

button.addEventListener('click', () => {
  editor.commands.insertYoutube({ src: 'https://example.com/media' })
  editor.focus()
})

const read = () => button.setAttribute('aria-pressed', String(editor.isActive('youtube')))
editor.on('selectionChange', read)
editor.on('change', read)
read()

Both events, not one. selectionChange covers the caret moving into it; change covers the command that changed it without moving anything. A toolbar wired to only the first goes stale the moment someone uses the keyboard.

Commands

Every one returns true if it changed the document and false if it could not · a command that does not apply where the caret is says so rather than throwing.

Command Call
insertYoutube editor.commands.insertYoutube(attrs: YoutubeAttrs)

Styling

This one needs CSS to look right, and ships the minimum as a string rather than a file · nothing loads unless you load it, and you can ignore it and write your own.

import { youtubeCSS } from '@matrajs/core'

const style = document.createElement('style')
style.textContent = youtubeCSS
document.head.append(style)

In the document

Attribute Default
src none
width 640
height 360
start 0

← All 83 extensions

Edit this page on GitHub