docs: add theme-common to API docs #7382
Open
+68
−38
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pre-flight checklist
Motivation
theme-common
is in a very, very awkward situation. Its APIs are not meant to be public, but are more or less so through ejecting theme components. Nevertheless, there are some very stable APIs that are worth documenting.For now, I've simply moved the
useColorMode
hook documentation here; in the near future, we can include more utilities that are stable. For example,usePluralForm
is also mentioned in the i18n tutorial and worth including in the future.@slorber Before the official release, we need to decide the subset of theme-common APIs to be made stable and documented. Those that rely on unstable theme-common APIs would not be safe for eject. This is related to #6116
I even think some hooks like
usePrevious
andReactContextError
can be in core because they may be useful to every user and plugin...Test Plan
Test links
Deploy preview: https://deploy-preview-7382--docusaurus-2.netlify.app/docs/api/misc/@docusaurus/theme-common/
Related issues/PRs