refactor(containedlist): added typescript types to containedlist #16115
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
✅ Deploy Preview for v11-carbon-react ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
tay1orjones
requested changes
Apr 10, 2024
| /** | ||
| * A label describing the contained list. | ||
| */ | ||
| label: ReactNode; |
There was a problem hiding this comment.
This accepts a string too, right?
Suggested change
| label: ReactNode; | |
| label: string | ReactNode; |
There was a problem hiding this comment.
Yes, I overlooked it, will make the changes.
| import PropTypes from 'prop-types'; | ||
| import classNames from 'classnames'; | ||
| import { LayoutConstraint } from '../Layout'; | ||
| import { useId } from '../../internal/useId'; | ||
| import { usePrefix } from '../../internal/usePrefix'; | ||
|
|
||
| const variants = ['on-page', 'disclosed']; | ||
| const variants: ('on-page' | 'disclosed')[] = ['on-page', 'disclosed']; |
There was a problem hiding this comment.
Is there a way to use this root definition for both the proptypes and the TS interface? Something like this maybe
const variants = ['on-page', 'disclosed'] as const;
// I think this will be typed as 'on-page' | 'disclosed' because the typeof operator returns the inferred type?
type Variants = typeof variants[number];
// ...then below in the interface:
kind?: Variants;
Comment on lines
116
to
123
| const isActionSearch = | ||
| React.isValidElement(action) && | ||
| (typeof action.type === 'string' | ||
| ? ['Search', 'ExpandableSearch'].includes(action.type) | ||
| : typeof action.type === 'function' && | ||
| 'displayName' in action.type && | ||
| (action.type.displayName === 'Search' || | ||
| action.type.displayName === 'ExpandableSearch')); |
There was a problem hiding this comment.
Is there any way to simplify this? It's really dense and hard to read. Is there another spot in the codebase we validate/check displayName/type?
There was a problem hiding this comment.
I will to simplify this and make it more readable.
alisonjoseph
approved these changes
Apr 16, 2024
tay1orjones
approved these changes
Apr 30, 2024
tay1orjones
added
status: ready to merge 🎉
and removed
status: ready for review 👀
status: one more review 👀
labels
Merged
via the queue into
carbon-design-system:main
with commit Apr 30, 2024
b6e8253
20 checks passed
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.
Closes #16019
Added typescript types to ContainedList component
Changelog
New
Changed
Testing / Reviewing
This new PR holds the review comments from #16047
No new observations on testing.