search

mui / material-ui

Material UI: Comprehensive React component library that implements Google's Material Design. Free forever.
https://mui.com/material-ui/
MIT License
94.02k stars 32.3k forks source link

[utils] Add documentation to `useForkRef` #44410

Closed JCQuintas closed 6 days ago

JCQuintas commented 1 week ago

Add documentation to explain what the useForkRef actually does and is useful for.

mui-bot commented 1 week ago

Netlify deploy preview

https://deploy-preview-44410--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad) No bundle size changes

Generated by :no_entry_sign: dangerJS against d4c8de4cbadad69bb5433b739faae406cd2e3c30

oliviertassinari commented 6 days ago

Fair enough. Per https://www.notion.so/mui-org/engineering-mui-utils-purpose-9a9fc9da3a004864b6c4e1f4d1f24f95?p=6af37c204f624505b8ef6b1fb571366a we likely want to keep it private cc @michaldudak, but having some docs for developer internally is cool 👍.

JCQuintas commented 6 days ago

Yeah, my goal was more for internal use, as I was using it by "copy/paste" and I had to go to the source to understand what it does exactly. This small doc should help future "me"s 😆

oliviertassinari commented 6 days ago

@JCQuintas I pushed the docs a bit further #44424, I was a bit confused with what I read.