fix: use ReactElement | null for Text and AnimatedText return type (fixes #4871)#4877
Open
krishnamanieee wants to merge 1 commit intocallstack:mainfrom
Open
fix: use ReactElement | null for Text and AnimatedText return type (fixes #4871)#4877krishnamanieee wants to merge 1 commit intocallstack:mainfrom
krishnamanieee wants to merge 1 commit intocallstack:mainfrom
Conversation
|
Hey @krishnamanieee, thank you for your pull request 🤗. The documentation from this branch can be viewed here. |
This file contains hidden or 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
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.
Motivation
After upgrading to react-native-paper v5.15.0, consumers see TypeScript errors when using
Text(and when usingstyled(Text)):Textas JSX:'Text' cannot be used as a JSX component. Its return type 'ReactNode' is not a valid JSX element.styled(Text):Argument of type 'TextComponent<never>' is not assignable to parameter of type 'NativeTarget' | 'WebTarget'.This happens because the exported component types declared a return type of
ReactNode. In current React/TypeScript, a component used as JSX must returnReact.ReactElement | null. This change updates theTextComponentandcustomAnimatedTexttypings to returnReact.ReactElement | nullso thatTextandAnimatedTextare valid JSX components and compatible withstyled().Related issue
Fixes #4871
Test plan
yarn typescriptin the repo root (and in a consumer app usingTextand optionallystyled(Text)) and confirm no type errors.yarn lintandyarn testto ensure nothing else is broken.<Text>,<AnimatedText>, andstyled(Text)in a TypeScript project;tsc --noEmit(orbun run tsc:check) should pass.