fix(Tearsheet): add missing declaration for headerActions prop #6114
Conversation
headerActions was defined for TearsheetShell but not for Tearsheet. This caused Typescript errors as well as PropTypes warnings for anyone using headerActions. Note that ideally Tearsheet.tsx and TearsheetNarrow.tsx would not repeat the type declarations from TearsheetShell.tsx. But that's an orthogonal issue. Refs carbon-design-system#546.
wkeese
requested review from
elycheea and
amal-k-joy
and removed request for
a team
✅ Deploy Preview for carbon-for-ibm-products ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| * wide tearsheets. | ||
| */ | ||
| headerActions?: ReactNode; | ||
|
|
There was a problem hiding this comment.
Hey @wkeese ,
Thanks for the changes.
I was trying to see this prop type warning in the story Tearsheet with all header items and influencer which passes headerActions prop and couldn't find any. Could you please help me to reproduce this issue ?
There was a problem hiding this comment.
@amal-k-joy - I guess PropTypes doesn't warn about having extra parameters. I updated the ticket description to just say that we don't have proper PropTypes validation, i.e. something like headerActions={567} would not currently be flagged.
Note that this PR is mainly for fixing the Typescript declaration, or at least that's my main goal.
Refs #546.
headerActionswas defined forTearsheetShellbut not forTearsheet.This caused Typescript errors, and you were also missing
PropTypesvalidation for any plain Javascript code usingheaderActions.Note that ideally, Tearsheet.tsx and TearsheetNarrow.tsx would not repeat the type declarations from TearsheetShell.tsx. But that's no addressed in this PR.
What did you change?
Added Tearsheet
headerActionsTypescript declaration, and also added it to thePropTypes.How did you test and verify your work?
Built locally.