Skip to content

Document the universal createRenderer API - #1694

Open
Janani-bn wants to merge 1 commit into
solidjs:mainfrom
Janani-bn:docs/create-renderer-universal-1222
Open

Janani-bn wants to merge 1 commit into
solidjs:mainfrom
Janani-bn:docs/create-renderer-universal-1222

Conversation

@Janani-bn

Copy link
Copy Markdown
Contributor
  • I have read the Contribution guide
  • This PR references an issue (except for typos, broken links, or other minor problems)

Description(required)

Adds a reference page for createRenderer under Reference > Rendering, closing the gap in #1222: the function is exported from solid-js/universal but has no documentation.

The page covers:

  • what a custom renderer is and when you would build one (native UI, canvas, terminal)
  • the compiler setup universal output needs (generate: "universal" and moduleName in babel-preset-solid)
  • the full RendererOptions interface with a per-option table
  • the returned Renderer object's runtime helpers (render, effect, memo, createComponent, insert, spread, setProp, mergeProps, use)
  • a complete DOM-backed example renderer that shows the build-a-renderer flow end to end, plus the control-flow re-exports a universal package needs

Content is grounded in the published solid-js@1.9.17 types (solid-js/universal).

Checks run on this branch against current main: pnpm build (page renders at /reference/rendering/create-renderer), pnpm check:types, pnpm check:lint, and prettier --check all pass.

Related issues & labels

Copilot AI balanced review requested due to automatic review settings November 12, 2026 05:54
@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify

netlify Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 8cc18ed
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs/deploys/6af554a5aa42da8b1b7257c8
😎 Deploy Preview https://deploy-preview-1694--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

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.

Add documentation for createRenderer and universal rendering

2 participants