fix: declarations of ContentSwitcher, Switch, Slider, SkeletonIcon #15382
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!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
wkeese
changed the title
Addresses errors like:
TS2305: Module '"@carbon/react"' has no exported member 'ContentSwitcher'.
12 import { ContentSwitcher } from "@carbon/react";
This contains two types of fixes:
Whenever the underlying component is written in Typescript, the index file needs
to be named index.ts. If it's named index.js, the build won't even generate an
index.d.ts file. (The index file can also be named index.tsx, but that doesn't
make sense unless it contains React markup.)
I updated createClassWrapper() so that Typescript knows the type of the returned
functional component:
export function createClassWrapper<Props>(
Component: ComponentClass<Props>
): FunctionComponent<Props> {
...
}
Note that the generated index.d.ts are a bit weird, for example
/// <reference types="react" />
declare const Slider:
import("react").FunctionComponent<import("./Slider").SliderProps>;
If I add casting to the index.ts files themselves, ex:
const Slider = createClassWrapper(SliderComponent) as FC<SliderProps>;
That generates more canonical index.d.ts files:
import { FC } from "react";
import { SliderProps } from './Slider';
declare const Slider: FC<SliderProps>;
(So I can do that if you like.)
Of course, the createClassWrapper() calls should be temporary, as all remaining
class components should be converted to functional components.
Refs #13550, #12557, #13574.
wkeese
force-pushed
the
fix/typescript-for-class-components
branch
from
a26cadc
to
80761f2
Compare
tay1orjones
approved these changes
Dec 13, 2023
|
Yeah I agree. I haven't finished converting our project to Carbon 11 yet but after this change, I don't get the error about |
alisonjoseph
approved these changes
Dec 18, 2023
alisonjoseph
added
status: ready to merge 🎉
and removed
status: one more review 👀
labels
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
Merged
via the queue into
carbon-design-system:main
with commit Dec 19, 2023
b2cc298
22 checks passed
danoro96
pushed a commit
to danoro96/carbon
that referenced
this pull request
Jan 18, 2024
…sign-system#15382) Addresses errors like: TS2305: Module '"@carbon/react"' has no exported member 'ContentSwitcher'. 12 import { ContentSwitcher } from "@carbon/react"; This contains two types of fixes: Whenever the underlying component is written in Typescript, the index file needs to be named index.ts. If it's named index.js, the build won't even generate an index.d.ts file. (The index file can also be named index.tsx, but that doesn't make sense unless it contains React markup.) I updated createClassWrapper() so that Typescript knows the type of the returned functional component: export function createClassWrapper<Props>( Component: ComponentClass<Props> ): FunctionComponent<Props> { ... } Note that the generated index.d.ts are a bit weird, for example /// <reference types="react" /> declare const Slider: import("react").FunctionComponent<import("./Slider").SliderProps>; If I add casting to the index.ts files themselves, ex: const Slider = createClassWrapper(SliderComponent) as FC<SliderProps>; That generates more canonical index.d.ts files: import { FC } from "react"; import { SliderProps } from './Slider'; declare const Slider: FC<SliderProps>; (So I can do that if you like.) Of course, the createClassWrapper() calls should be temporary, as all remaining class components should be converted to functional components. Refs carbon-design-system#13550, carbon-design-system#12557, carbon-design-system#13574.
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.
Addresses errors like:
This contains two types of fixes:
Whenever the underlying component is written in Typescript, the index file needs to be named index.ts. If it's named index.js, the build won't even generate an index.d.ts file. (The index file can also be named index.tsx, but that doesn't make sense unless it contains React markup.)
I updated
createClassWrapper()so that Typescript knows the type of the returned functional component:Note that the generated index.d.ts are a bit weird, for example
If I add casting to the index.ts files themselves, ex:
That generates more canonical index.d.ts files:
(So I can do that if you like.)
Of course, the
createClassWrapper()calls should be temporary, as all remaining class components should be converted to functional components.Refs #13550, #12557, #13574.