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] Badge anchorOrigin should mention the required keys #43859

Closed
HussainAhmadDev opened this issue Sep 22, 2024 · 5 comments · Fixed by #43950
Closed

[docs] Badge anchorOrigin should mention the required keys #43859

HussainAhmadDev opened this issue Sep 22, 2024 · 5 comments · Fixed by #43950
Assignees
Labels
component: badge This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation

Comments

@HussainAhmadDev
Copy link

HussainAhmadDev commented Sep 22, 2024

Steps to reproduce

No steps needed just use badge component prop badge origin with one origin only horizontal or verticalare

Current behavior

if we use one origin at a time its gives us error the

Expected behavior

should allow one origin not both at the same time,

Context

No response

Your environment

npx @mui/envinfo
  Don't forget to mention which browser you used.
  Output from `npx @mui/envinfo` goes here.

Search keywords: badge origin

@HussainAhmadDev HussainAhmadDev added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Sep 22, 2024
@siriwatknp
Copy link
Member

It's required to provide both horizontal and vertical to anchorOrigin. Please see the demo https://mui.com/material-ui/react-badge/#badge-alignment

@siriwatknp siriwatknp added status: expected behavior Does not imply the behavior is intended. Just that we know about it and can't work around it and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Sep 23, 2024
Copy link

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Note

We value your feedback @HussainAhmadDev! How was your experience with our support team?
We'd love to hear your thoughts in this brief Support Satisfaction survey. Your insights help us improve!

@siriwatknp siriwatknp added the component: badge This is the name of the generic UI component, not the React module! label Sep 23, 2024
@siriwatknp siriwatknp reopened this Sep 23, 2024
@siriwatknp
Copy link
Member

I think the docs should mention this. PR welcome to add a callout that both keys are required.

@siriwatknp siriwatknp added docs Improvements or additions to the documentation and removed status: expected behavior Does not imply the behavior is intended. Just that we know about it and can't work around it labels Sep 23, 2024
@siriwatknp siriwatknp changed the title Badge origin error [docs] Badge anchorOrigin should mention the required keys Sep 23, 2024
@HussainAhmadDev
Copy link
Author

But @siriwatknp why we really need to give both I think it should be Partial to add one or both

Copy link

github-actions bot commented Oct 3, 2024

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Note

We value your feedback @HussainAhmadDev! How was your experience with our support team?
We'd love to hear your thoughts in this brief Support Satisfaction survey. Your insights help us improve!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: badge This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants