Skip to content

[utils] Add documentation to useForkRef#44410

Merged
JCQuintas merged 1 commit intomui:masterfrom
JCQuintas:document-use-fork-ref
Nov 15, 2024
Merged

[utils] Add documentation to useForkRef#44410
JCQuintas merged 1 commit intomui:masterfrom
JCQuintas:document-use-fork-ref

Conversation

@JCQuintas
Copy link
Copy Markdown
Member

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

@JCQuintas JCQuintas added docs Improvements or additions to the documentation. package: utils Specific to the utils package. labels Nov 14, 2024
@JCQuintas JCQuintas self-assigned this Nov 14, 2024
@mui-bot
Copy link
Copy Markdown

mui-bot commented Nov 14, 2024

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 🚫 dangerJS against d4c8de4

@JCQuintas JCQuintas requested a review from mnajdova November 14, 2024 18:09
Copy link
Copy Markdown
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! 👌

@JCQuintas JCQuintas merged commit 2224b22 into mui:master Nov 15, 2024
@oliviertassinari oliviertassinari added package: @mui/base Specific to @mui/base (legacy). internal Behind-the-scenes enhancement. Formerly called “core”. and removed docs Improvements or additions to the documentation. labels Nov 15, 2024
@oliviertassinari
Copy link
Copy Markdown
Member

oliviertassinari commented Nov 15, 2024

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
Copy link
Copy Markdown
Member Author

JCQuintas commented Nov 15, 2024

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
Copy link
Copy Markdown
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Behind-the-scenes enhancement. Formerly called “core”. package: @mui/base Specific to @mui/base (legacy). package: utils Specific to the utils package.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants