Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.18 KB

README.md

File metadata and controls

46 lines (34 loc) · 2.18 KB

Hosting <editor-wc>

Guides for apps that embed the editor web component. These pages describe the host-facing APIs on <editor-wc> itself - what to call, when, and how - in plain JavaScript and HTML. React hosts can use the same APIs; where helpful we point at real usage in editor-standalone.

For mounting, attributes, events, and styling, start with the README and Web Component notes.

Sizing the component

<editor-wc> fills the height its host gives it, so give it a definite one - and add min-block-size: 0 to any flex or grid wrapper in between, or that wrapper will grow to fit its content instead of staying in its track.

.editor-wrapper {
  min-block-size: 0;
}

editor-wc {
  block-size: 100%;
}

Skip this and the editor still renders, but long instructions make the whole component grow instead of scrolling inside it. web-component.html is a working example.

Host APIs

Guide What it covers
Sidebar plugins Add a host-owned panel (and optional header buttons) to the editor sidebar
Autosave flush Force-save dirty work before SPA or page navigation leaves the editor

Design notes

Background from the feedback-panel / host-integration investigation. Useful context for the team; not required reading to call the APIs above.

Note What it covers
Feedback panel investigation Why React-across-the-WC-boundary is unsafe, the options we considered, and what shipped (1a) vs what was only explored (Alt 4)