fix(react): Add children prop type to ErrorBoundary component

[cameronaziz]

To support React 18, which removed children as an optional prop for functional components, this adds children as an option prop for the ErrorBoundary component.

Fixes #4904

[lforst]

Hi @cameronaziz, thank you so much for submitting this PR. We would like to fix this type error and release a patch.

Would you be willing to get rid of the React.PropsWithChildren helper here and instead add a children?: React.ReactNode prop to ErrorBoundaryProps, just like one of the maintainers of react suggests here? If that's done we're good to go!

[cameronaziz]

@lforst Are you thinking more on the direction of what my original commit was: ea99673

The issue was it would not build with the children render as a function.

[lforst]

1a575e6 without the | undefined would be perfect imo.

That should be fine typewise. Seems weird that it's not building. Can you update the code? I'll take a look at the build output afterwards.

[cameronaziz]

I can, but that ends up making the children within this block a never.

sentry-javascript/packages/react/src/errorboundary.tsx

Lines 153 to 155 in cafec74

	if (typeof children === 'function') {
	return children();
	}

[lforst]

You're right. Apparently @types/react@18 changed the ReactNode type not to be callable anymore. I think up to v17 it had a constructor type of some sort. For me, when using the types from @type/react@18 neither children?: ReactNode nor React.PropsWithChildren works. I think it's best if we go with the changes from ea99673.

Sorry for flip-flopping around. Thank you very much for helping out 🙏

[lforst]

@cameronaziz I took the liberty of taking this over and merging. We'll include the changes in our next patch. Thank you for your contribution!