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.

Sign up for GitHub

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

Jump to bottom

[useBadge] Add interface for the return value #36042

Merged
merged 7 commits into from
Mar 7, 2023
Merged

[useBadge] Add interface for the return value #36042

merged 7 commits into from
Mar 7, 2023

Conversation

skevprog
Copy link
Contributor

@skevprog skevprog commented Feb 3, 2023

Add a UseBadgeReturnValue interface with the types that the UseBadge hook is returning

@skevprog
Copy link
Contributor Author

skevprog commented Feb 3, 2023 •
edited
Loading

part of #35933 (useBadge item)
@mnajdova

@skevprog skevprog changed the title Add a UseBadgeReturnValue interface with the types that the UseBadg… [useBadge]: Add a UseBadgeReturnValue interface with the types that the UseBadg… Feb 3, 2023
@mui-bot
Copy link

mui-bot commented Feb 3, 2023 •
edited
Loading

Netlify deploy preview

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

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 8bc0657

@zannager zannager added the component: badge This is the name of the generic UI component, not the React module! label Feb 6, 2023
@skevprog
chore
4ee44d5 
* Prettier lint
mnajdova
mnajdova reviewed Feb 8, 2023
View reviewed changes
Copy link
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.

We need to add a JSDocs description on this props, so that the documentation can include them in the API page. See fore xample #36046

@mnajdova
Copy link
Member

Looks like on the descriptions was changed, we need to run yarn docs:api once again.

@mnajdova mnajdova mentioned this pull request Feb 15, 2023
Closed
15 tasks
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 21, 2023
@skevprog
Copy link
Contributor Author

skevprog commented Mar 2, 2023

Looks like on the descriptions was changed, we need to run yarn docs:api once again.

Sorry for the delay @mnajdova . That script deletes my changes is this ok?

@ZeeshanTamboli ZeeshanTamboli added typescript package: base-ui Specific to @mui/base docs Improvements or additions to the documentation labels Mar 7, 2023
@ZeeshanTamboli ZeeshanTamboli changed the title [useBadge]: Add a UseBadgeReturnValue interface with the types that the UseBadg… [useBadge] Add interface for the return value Mar 7, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 7, 2023
ZeeshanTamboli
ZeeshanTamboli approved these changes Mar 7, 2023
View reviewed changes
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

I did the remaining things. It looks good now. @skevprog Thanks for the contribution!

@ZeeshanTamboli ZeeshanTamboli merged commit 4e47afe into mui:master Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mnajdova mnajdova mnajdova left review comments

@ZeeshanTamboli ZeeshanTamboli ZeeshanTamboli approved these changes

@siriwatknp siriwatknp Awaiting requested review from siriwatknp

Assignees
No one assigned
Labels
component: badge This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: base-ui Specific to @mui/base typescript
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@skevprog @mui-bot @mnajdova @ZeeshanTamboli @zannager