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

[Tabs] Improve useTab() API page #36725

Merged
merged 1 commit into from
Apr 5, 2023

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Mar 31, 2023

Noticed in #36715

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation component: tabs This is the name of the generic UI component, not the React module! package: base-ui Specific to @mui/base labels Mar 31, 2023
@mui-bot
Copy link

mui-bot commented Mar 31, 2023

Netlify deploy preview

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

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against ca8c506

*/
value?: number | string;
/**
* Callback invoked when new value is being set.
*/
onChange?: (event: React.SyntheticEvent, value: number | string) => void;
onClick?: React.MouseEventHandler;
/**
* If `true`, the component is disabled.
* @default false
Copy link
Member Author

@oliviertassinari oliviertassinari Mar 31, 2023

Choose a reason for hiding this comment

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

This is inherited from useButton().

export interface UseButtonParameters {
/**
* If `true`, the component is disabled.
* @default false
*/
disabled?: boolean;

Ideally, we would document hooks inheritance, but in the meantime, we can continue to duplicate.

@@ -3,14 +3,18 @@ import { UseButtonRootSlotProps } from '../useButton';

export interface UseTabParameters {
/**
* You can provide your own value. Otherwise, we fall back to the child position index.
* You can provide your own value. Otherwise, it falls back to the child position index.
Copy link
Member Author

@oliviertassinari oliviertassinari Mar 31, 2023

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: tabs 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants