Skip to content

docs(dom): add API usage examples - #1013

Open
cerredz wants to merge 1 commit into
cyclejs:masterfrom
cerredz:issuehunt-851-dom-api-docs
Open

docs(dom): add API usage examples#1013
cerredz wants to merge 1 commit into
cyclejs:masterfrom
cerredz:issuehunt-851-dom-api-docs

Conversation

@cerredz

@cerredz cerredz commented May 16, 2026

Copy link
Copy Markdown

Contributes to #851.

What changed

  • Adds a first-use @cycle/dom API example showing makeDOMDriver(), a DOM sink, and event selection with select().events().
  • Documents that the driver accepts either a selector or an Element render target.
  • Notes the document.body top-level VNode requirement for body-mounted apps.
  • Keeps the checked-in rendered docs/api/dom.html in sync with docs/content/api/dom.md.

Verification

  • node --check .scripts/make-api-docs.js
  • git diff --check

Note

I attempted to regenerate the DOM API page with node .scripts/make-api-docs.js dom, but the existing docs toolchain fails before writing output because the installed dox dependency throws TypeError: parse is not a function. I therefore mirrored the Markdown addition into the rendered HTML without changing the existing generated API block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant