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

Update swizzleAllowedComponents #5263

Closed
Josh-Cena opened this issue Aug 1, 2021 · 1 comment · Fixed by #6243
Closed

Update swizzleAllowedComponents #5263

Josh-Cena opened this issue Aug 1, 2021 · 1 comment · Fixed by #6243
Labels
bug An error in the Docusaurus core causing instability or issues with its execution

Comments

@Josh-Cena
Copy link
Collaborator

Josh-Cena commented Aug 1, 2021

🐛 Bug Report

The template doesn't really apply, but this issue is just a quick notice that the swizzleAllowedComponents in theme-classic hasn't been updated for long. A lot of small components should be swizzlable without the --danger flag.

Some components that almost certainly should be added:

  • BackToTopButton;
  • Details;
  • EditThisPage;
  • IconExternalLink;
  • IconLanguage;
  • ...
@Josh-Cena Josh-Cena added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Aug 1, 2021
@slorber
Copy link
Collaborator

slorber commented Aug 2, 2021

Yes, agree.

I'll update this list once I add the "slots/placeholders component" that I mentioned in another issue.

If you want to update it, feel free to submit a PR. As a general rule I'd say we should mark swizzle as not dangerous as long as the comp is purely UI-related, with a small and clean API (props/context usage) and does not contain complicated complex Docusaurus login. (DocSidebar should rather be moved to --danger for example)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants