[base-ui] Create hooks contribution guide #38679
Conversation
michaldudak
added
docs
Netlify deploy previewhttps://deploy-preview-38679--material-ui.netlify.app/ Bundle size report |
packages/mui-base/CONTRIBUTING.md
Outdated
| Example: | ||
|
|
||
| ```tsx | ||
| const getRootProps = <OtherProps extends EventHandlers>( |
There was a problem hiding this comment.
Why is the parameter named otherProps here and otherHandlers on the next example?
There was a problem hiding this comment.
Ah, sorry, my bad. I should have made it consistent.
Although it actually reflects the reality - we used to accept only event handlers in this parameter, but we're changing this to accept arbitrary props (#38186). So ultimately, it will be otherProps.
There was a problem hiding this comment.
OK
This is clearly a small issue 😆
Co-authored-by: Diego Andai <[email protected]> Signed-off-by: Michał Dudak <[email protected]>
| #### Parameters destructuring | ||
|
|
||
| The parameters type must be called `[HookName]Parameters`. | ||
| There are docs generation scripts that require this pattern. |
There was a problem hiding this comment.
I think we need more explanation here and an example. Where and how should the parameters be destructured?
There was a problem hiding this comment.
We can likely even drop this, contributors don't need this information at this point. It's an overhead that will not make them implement the hook itself better.
There was a problem hiding this comment.
IMO it does no harm to have this piece of information - it could help someone find a problem when the docs are not generated properly. Plus, MUIers can also use this doc.
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Michał Dudak <[email protected]>
|
|
||
| #### Parameters destructuring | ||
|
|
||
| The parameters type must be called `[HookName]Parameters`. |
There was a problem hiding this comment.
| The parameters type must be called `[HookName]Parameters`. | |
| The parameters type must be called `[HookName]Parameters`, for e.g. for the above mentioned hook, they would be called `UseAwesomeControlParemeters`. |
There was a problem hiding this comment.
We can likely drop this as we anyway talk about it in the last section
Co-authored-by: Diego Andai <[email protected]> Co-authored-by: Sam Sycamore <[email protected]>
Co-authored-by: Diego Andai <[email protected]> Co-authored-by: Sam Sycamore <[email protected]>
Co-authored-by: Diego Andai <[email protected]> Co-authored-by: Sam Sycamore <[email protected]>
Technical documentation for authoring Base UI hooks.