Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Tooltip documentation missing componentProps added in #28679 #36184

Open
1 task done
jukkahuuskonen opened this issue Feb 14, 2023 · 4 comments
Open
1 task done
Assignees
Labels
component: tooltip This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation

Comments

@jukkahuuskonen
Copy link

Duplicates

  • I have searched the existing issues

Related page

https://mui.com/material-ui/api/tooltip/

Kind of issue

Missing information

Issue description

Missing and incorrect documentation:

I was looking for a way to use sx-prop to edit tooltip popper css and it appears that componentProps-prop that was added in PR 28692 is still missing the documentation.

It took me several hours to find the problem and correct issue with the solution to it.

Also the description of the sx-prop gives incorrect information about how it works with Tooltip-component.

Context 🔦

No response

@jukkahuuskonen jukkahuuskonen added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Feb 14, 2023
@zannager zannager added docs Improvements or additions to the documentation component: tooltip This is the name of the generic UI component, not the React module! labels Feb 14, 2023
@ZeeshanTamboli
Copy link
Member

componentProps-prop that was added in #28692 is still missing the documentation.

I can see componentsProp prop in the API documentation.

sx-prop gives incorrect information about how it works with Tooltip-component.

What is incorrect in the description?

Please provide more information.

@ZeeshanTamboli ZeeshanTamboli added status: waiting for author Issue with insufficient information and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Feb 16, 2023
@jukkahuuskonen
Copy link
Author

I can see componentsProp prop in the API documentation.

I must have mistyped that when I was searching for it in the API-page. Sorry.

sx-prop gives incorrect information about how it works with Tooltip-component.

What is incorrect in the description?

Please provide more information.

sx-prop documentation says you can modify a component with sx-prop. In case of Tooltip (and probably some others) the sx-prop is actually forwarded to child component (at least it seamed so, in any case it can't be used to modify Tooltip) which hasn't been mentioned anywhere. There should be a mention of this behavior on the Tooltip-documentation on the sx-prop.

@github-actions github-actions bot removed the status: waiting for author Issue with insufficient information label Feb 16, 2023
@ZeeshanTamboli
Copy link
Member

ZeeshanTamboli commented Feb 16, 2023

sx-prop documentation says you can modify a component with sx-prop. In case of Tooltip (and probably some others) the sx-prop is actually forwarded to child component (at least it seamed so, in any case it can't be used to modify Tooltip) which hasn't been mentioned anywhere. There should be a mention of this behavior on the Tooltip-documentation on the sx-prop.

Please provide a CodeSandbox. The issue template is a good starting point. It would us both to be on the same page.

@ZeeshanTamboli ZeeshanTamboli added the status: waiting for author Issue with insufficient information label Feb 16, 2023
@jukkahuuskonen
Copy link
Author

sx-prop documentation says you can modify a component with sx-prop. In case of Tooltip (and probably some others) the sx-prop is actually forwarded to child component (at least it seamed so, in any case it can't be used to modify Tooltip) which hasn't been mentioned anywhere. There should be a mention of this behavior on the Tooltip-documentation on the sx-prop.

Please provide a CodeSandbox. The issue template is a good starting point. It would us both to be on the same page.

Sorry, I figured that sandbox wouldn't be needed, since the problem was kind of already fixed at #28692, just the documentation was faulty.
In any case here is a link to a sandbox edited from one of MUI examples.

I actually noticed an other problem regarding hovering and open-prop. They seem to work/not work a bit strangely.

With first 2 Tooltips, the hovering doesn't open the tooltip. With 3rd (using slotProps) open-prop doesn't show tooltip, but hovering works and in forth giving open-prop through slotProps keeps tooltip open.

@github-actions github-actions bot removed the status: waiting for author Issue with insufficient information label Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: tooltip This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

No branches or pull requests

4 participants