BoxControl: Auto-generate readme #67284
Conversation
mirka
added
[Type] Developer Documentation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
| * return ( | ||
| * <BoxControl | ||
| * values={ values } | ||
| * onChange={ ( nextValues ) => setValues( nextValues ) } |
|
|
||
| ### `onMouseOut`: `function` |
There was a problem hiding this comment.
What's the thing about those props like onMouseOut and onMouseOver that we previously documented in the README but we no longer do? Does that signal a gap in types perhaps?
There was a problem hiding this comment.
The types are correct, it's just the default behavior of react-docgen-typescript to suppress element props that are optional and don't have explicit descriptions. I think that makes sense, especially because onMouseOut and onMouseOver are highly unlikely to be used in common BoxControl use cases, and their inclusion is simply arbitrary (probably only happened because some weird edge case in Gutenberg required it).
What annoys me though is that there's quirk in the API where onMouseOut and onMouseOver should actually just be passed as part of the inputProps prop. That's basically what happens under the hood anyway. I'll address this in a separate PR — it should just be a change in TypeScript metadata.
There was a problem hiding this comment.
Sounds good, thanks for clarifying 👍
What?
Switch the README for
BoxControlto an auto-generated one (see also #66035).Why?
To improve accuracy and maintenance cost.
Testing Instructions
npm run docs:componentsto verify the changes to the README.