[useTabs] Add explicit return type #36047
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Netlify deploy previewhttps://deploy-preview-36047--material-ui.netlify.app/ Bundle size report |
sai6855
commented
Feb 4, 2023
docs/pages/base/api/use-tabs.json
Outdated
| "returnValue": { | ||
| "tabsContextValue": { | ||
| "type": { | ||
| "name": "{\n /**\n * Id used as a prefix for the current Tabs.\n */\n idPrefix: string | undefined\n /**\n * The value of the currently selected `Tab`.\n * If you don't want any selected `Tab`, you can set this prop to `false`.\n */\n value: string | number | false\n /**\n * Callback for setting new value.\n */\n onSelected: (e: React.SyntheticEvent, newValue: string | number | false) => void\n /**\n * The component orientation (layout flow direction).\n */\n orientation?: 'horizontal' | 'vertical'\n /**\n * The direction of the text.\n */\n direction: 'ltr' | 'rtl' | undefined\n /**\n * If `true` the selected tab changes on focus. Otherwise it only\n * changes on activation.\n */\n selectionFollowsFocus: boolean | undefined\n}", |
There was a problem hiding this comment.
Not sure how to extract descriptions from nested objects
zannager
added
the
component: tabs
mnajdova
reviewed
Feb 8, 2023
| } | ||
|
|
||
| export interface UseTabsReturnValue { | ||
| tabsContextValue: { |
There was a problem hiding this comment.
Let's add a JSDocs description please.
15 tasks
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
ZeeshanTamboli
requested changes
Mar 7, 2023
ZeeshanTamboli
added
docs
ZeeshanTamboli
approved these changes
Mar 7, 2023
|
Thanks a lot, sorry I missed your message on changes requested |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
UseTabs return value interface
closes useTabs in #35933
preview: https://deploy-preview-36047--material-ui.netlify.app/base/api/use-tabs/#return-value