[core] Exclude documentation of Base props not used in styled libraries #35562
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
michaldudak
commented
Dec 21, 2022
| @@ -49,11 +49,13 @@ const Popper = React.forwardRef(function Popper( | |||
| ref: React.ForwardedRef<HTMLDivElement>, | |||
| ) { | |||
| const theme = useTheme<{ direction?: Direction }>(); | |||
| const { components, componentsProps, slots, slotProps, ...other } = useThemeProps({ | |||
| const props = useThemeProps({ | |||
There was a problem hiding this comment.
The API docs generation script requires a variable named props to be destructured to work properly.
There was a problem hiding this comment.
Yep, I remember this from when I was adding the useThemeProps. This is why the param in React.forwardRef are called inProps :))
|
michaldudak
force-pushed
the
exclude-base-props
branch
from
6061ec4
to
d1872d1
Compare
|
I am too slow 😅 |
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.
The Popper component has a
directionprop documented, even though this prop exists only in the PopperUnstyled props. This PR makes sure that omitted props are not taken into consideration when building the API docs.