Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Content script UI options API reference is hard to follow #1452

Open
5 tasks done
aklinker1 opened this issue Feb 21, 2025 · 0 comments
Open
5 tasks done

Content script UI options API reference is hard to follow #1452

aklinker1 opened this issue Feb 21, 2025 · 0 comments
Labels
bug Something isn't working contribution welcome docs Improvements or additions to documentation

Comments

@aklinker1
Copy link
Collaborator

aklinker1 commented Feb 21, 2025

Describe the bug

Try to find the docs for the append option here: https://wxt.dev/api/reference/wxt/client/functions/createShadowRootUi.html

You can't lol. Well, you can, but people will give up before finding it.

We could duplicate the JSDoc between the three options, but then they'd get out of sync. Maybe that's worth it for ease of use. Here's where the types are located: https://github.com/wxt-dev/wxt/blob/a38e3c27330ab82f9c136191fc85b9b101516915/packages/wxt/src/client/content-scripts/ui/types.ts

Originally reported here: https://discord.com/channels/1212416027611365476/1296842665249472614/1342135208220299274

Reproduction

https://wxt.dev/api/reference/wxt/client/functions/createShadowRootUi.html

Steps to reproduce

N/A

System Info

N/A

Used Package Manager

npm

Validations

@aklinker1 aklinker1 added bug Something isn't working contribution welcome docs Improvements or additions to documentation labels Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working contribution welcome docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant