Skip to content

docs: flatten content script UI options - #2618

Open
dvd233 wants to merge 2 commits into
wxt-dev:mainfrom
dvd233:codex/contrib-wxt-1452-inline-ui-options
Open

dvd233 wants to merge 2 commits into
wxt-dev:mainfrom
dvd233:codex/contrib-wxt-1452-inline-ui-options

Conversation

@dvd233

@dvd233 dvd233 commented Sep 8, 2026

Copy link
Copy Markdown

Overview

The factory-specific options pages currently render as ContentScriptUiOptions<T> & object, so shared options—especially append—are still hidden behind another API page after #2497.

  • Render the integrated, iframe, and shadow-root option aliases as TypeDoc interfaces so shared and factory-specific properties appear together.
  • Keep every positioning key present on each discriminated-union branch with optional never fields. This lets TypeDoc retain zIndex and alignment without accepting unsupported position/option combinations.
  • Inherit the shared options summary and correct the alignment docs to reference position: "overlay".
  • Redirect the previous type-alias URLs to the new interface pages so existing links keep working.

The generated pages now expose all 8 integrated, 9 iframe, and 12 shadow-root options directly. TypeDoc 0.25 emits its generic union-to-interface warning for these aliases, so I also verified the generated Markdown and rendered HTML to ensure no properties are discarded.

Manual Testing

  • bun run check
  • bun run docs:build
  • Type-checked valid inline/overlay/modal configurations and invalid inline zIndex / modal alignment configurations.
  • Asserted the complete property set in all three generated Markdown pages and their rendered HTML output.
  • Verified the legacy URL redirects are included in the built site.

Related Issue

Closes #1452

@netlify

netlify Bot commented Sep 8, 2026

Copy link
Copy Markdown

Deploy Preview for creative-fairy-df92c4 ready!

Name Link
🔨 Latest commit 9075701
🔍 Latest deploy log https://app.netlify.com/projects/creative-fairy-df92c4/deploys/6aa068c7cc860500088f95ad
😎 Deploy Preview https://deploy-preview-2618--creative-fairy-df92c4.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.

@github-actions github-actions Bot added the pkg/wxt Includes changes to the `packages/wxt` directory label Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg/wxt Includes changes to the `packages/wxt` directory

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Content script UI options API reference is hard to follow

1 participant