Align FlagsmithProvider children prop type with React.ReactNode in declaration file
#317
Conversation
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
…ctNode Ensures the `children` prop in `FlagsmithProvider`'s type definition (`FlagsmithContextType`) is correctly set to `React.ReactNode` in both the implementation (`react.tsx`) and the declaration file (`react.d.ts`). Adds a type test to verify that `FlagsmithProvider` compiles successfully when provided with a plain string child, which is a valid `React.ReactNode`. This test would fail compilation if the type were incorrectly restricted (e.g., to `ReactElement | ReactElement[]`).
|
Thank you for your contribution! |
tiagoapolo
approved these changes
Jun 2, 2025
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.
This PR resolves a remaining type inconsistency related to issue #268 and PR #270 regarding the
FlagsmithProvidercomponent, where itschildrenprop in the TypeScript declaration file (react.d.ts) mismatched theReact.ReactNodetype used in the implementation (react.tsx).Also added a test to
test/react-types.test.tsxto assert thatFlagsmithProviderrenders aReact.ReactNodecorrectly and the TS declaration file types match the implementation file (otherwise the test itself fails to compile).