feat(v2): Provide typing to most of the theme-classic components #3348
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for docusaurus-2 ready! Built with commit 7b346e5 |
|
Looks nice thanks ;) |
This was referenced Aug 28, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
This PR adds type definitions for almost all theme classic components. I only left
@theme/MDXPageuntyped because we need to add types to page plugin first, which can be done in another PR.@theme/NavbarItem/DefaultNavbarItem,@theme/NavbarItem/DocsVersionDropdownNavbarItem,@theme/NavbarItem/DocsVersionNavbarItemand@theme/NavbarItemuntyped, because the usage is too dynamic. Maybe I will setup some function overload definition in another PR.The rest of the changes are mostly moving from existing in-file props definition into the centralized typed.d.ts. In this way, we can test the accuracy of types by their usages in theme-classic and provide them to the end users.
I also make the type definition available in the v2 website package, and now it has nice type hovers:
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
This PR only contains type changes. Everything still type checks.
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)