Skip to content

[react] Allow React context in ReactNode #69304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eps1lon merged 2 commits into from
Apr 11, 2024
Merged

[react] Allow React context in ReactNode #69304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02404b6
[react] Allow React context in ReactNode
eps1lon Apr 8, 2024
1ae65a0
We don't need to resurively unwrap the context value
eps1lon Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions types/react/canary.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ export {};
declare const UNDEFINED_VOID_ONLY: unique symbol;
type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };

/**
* @internal
*/
interface ReactContextAsReactNode extends React.Context<React.ReactNode> {}

declare module "." {
interface ThenableImpl<T> {
then(onFulfill: (value: T) => unknown, onReject: (error: unknown) => unknown): void | PromiseLike<unknown>;
Expand Down Expand Up @@ -141,4 +146,23 @@ declare module "." {
onTransitionStart?: TransitionEventHandler<T> | undefined;
onTransitionStartCapture?: TransitionEventHandler<T> | undefined;
}

/**
* @internal Use `Awaited<ReactNode>` instead
*/
// Helper type to enable `Awaited<ReactNode>`.
// Must be a copy of the non-thenables of `ReactNode`.
type AwaitedReactNode =
| ReactElement
| string
| number
| Iterable<AwaitedReactNode>
| ReactPortal
| boolean
| null
| undefined;
interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES {
contexts: ReactContextAsReactNode;
promises: Promise<AwaitedReactNode>;
}
}
18 changes: 0 additions & 18 deletions types/react/experimental.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,6 @@ declare const UNDEFINED_VOID_ONLY: unique symbol;
type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };

declare module "." {
/**
* @internal Use `Awaited<ReactNode>` instead
*/
// Helper type to enable `Awaited<ReactNode>`.
// Must be a copy of the non-thenables of `ReactNode`.
type AwaitedReactNode =
| ReactElement
| string
| number
| Iterable<AwaitedReactNode>
| ReactPortal
| boolean
| null
| undefined;
interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES {
promises: Promise<AwaitedReactNode>;
}

export interface SuspenseProps {
/**
* The presence of this prop indicates that the content is computationally expensive to render.
Expand Down
28 changes: 28 additions & 0 deletions types/react/test/canary.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,3 +359,31 @@ function formTest() {
event;
}}
/>;

// ReactNode tests
{
// @ts-expect-error
const render: React.ReactNode = () => React.createElement("div");
// @ts-expect-error
const emptyObject: React.ReactNode = {};
// @ts-expect-error
const plainObject: React.ReactNode = { dave: true };
const promise: React.ReactNode = Promise.resolve("React");
// @ts-expect-error plain objects are not allowed
<div>{{ dave: true }}</div>;
<div>{Promise.resolve("React")}</div>;

const asyncTests = async function asyncTests() {
const node: Awaited<React.ReactNode> = await Promise.resolve("React");
};

const RenderableContext = React.createContext<React.ReactNode>("HAL");
const NestedContext = React.createContext(RenderableContext);
let node: React.ReactNode = RenderableContext;
// @ts-expect-error TODO context values are recursively unwrapped so this should be allowed by types.
node = NestedContext;

const NotRenderableContext = React.createContext(() => {});
// @ts-expect-error
node: React.ReactNode = NotRenderableContext;
}
18 changes: 0 additions & 18 deletions types/react/test/experimental.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,24 +72,6 @@ function useEvent() {
);
}

// ReactNode tests
{
// @ts-expect-error
const render: React.ReactNode = () => React.createElement("div");
// @ts-expect-error
const emptyObject: React.ReactNode = {};
// @ts-expect-error
const plainObject: React.ReactNode = { dave: true };
const promise: React.ReactNode = Promise.resolve("React");
// @ts-expect-error plain objects are not allowed
<div>{{ dave: true }}</div>;
<div>{Promise.resolve("React")}</div>;

const asyncTests = async function asyncTests() {
const node: Awaited<React.ReactNode> = await Promise.resolve("React");
};
}

function elementTypeTests() {
const ReturnPromise = () => Promise.resolve("React");
const FCPromise: React.FC = ReturnPromise;
Expand Down
24 changes: 24 additions & 0 deletions types/react/ts5.0/canary.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ export {};
declare const UNDEFINED_VOID_ONLY: unique symbol;
type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };

/**
* @internal
*/
interface ReactContextAsReactNode extends React.Context<React.ReactNode> {}

declare module "." {
interface ThenableImpl<T> {
then(onFulfill: (value: T) => unknown, onReject: (error: unknown) => unknown): void | PromiseLike<unknown>;
Expand Down Expand Up @@ -141,4 +146,23 @@ declare module "." {
onTransitionStart?: TransitionEventHandler<T> | undefined;
onTransitionStartCapture?: TransitionEventHandler<T> | undefined;
}

/**
* @internal Use `Awaited<ReactNode>` instead
*/
// Helper type to enable `Awaited<ReactNode>`.
// Must be a copy of the non-thenables of `ReactNode`.
type AwaitedReactNode =
| ReactElement
| string
| number
| Iterable<AwaitedReactNode>
| ReactPortal
| boolean
| null
| undefined;
interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES {
contexts: ReactContextAsReactNode;
promises: Promise<AwaitedReactNode>;
}
}
18 changes: 0 additions & 18 deletions types/react/ts5.0/experimental.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,6 @@ declare const UNDEFINED_VOID_ONLY: unique symbol;
type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };

declare module "." {
/**
* @internal Use `Awaited<ReactNode>` instead
*/
// Helper type to enable `Awaited<ReactNode>`.
// Must be a copy of the non-thenables of `ReactNode`.
type AwaitedReactNode =
| ReactElement
| string
| number
| Iterable<AwaitedReactNode>
| ReactPortal
| boolean
| null
| undefined;
interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES {
promises: Promise<AwaitedReactNode>;
}

export interface SuspenseProps {
/**
* The presence of this prop indicates that the content is computationally expensive to render.
Expand Down
28 changes: 28 additions & 0 deletions types/react/ts5.0/test/canary.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,3 +359,31 @@ function formTest() {
event;
}}
/>;

// ReactNode tests
{
// @ts-expect-error
const render: React.ReactNode = () => React.createElement("div");
// @ts-expect-error
const emptyObject: React.ReactNode = {};
// @ts-expect-error
const plainObject: React.ReactNode = { dave: true };
const promise: React.ReactNode = Promise.resolve("React");
// @ts-expect-error plain objects are not allowed
<div>{{ dave: true }}</div>;
<div>{Promise.resolve("React")}</div>;

const asyncTests = async function asyncTests() {
const node: Awaited<React.ReactNode> = await Promise.resolve("React");
};

const RenderableContext = React.createContext<React.ReactNode>("HAL");
const NestedContext = React.createContext(RenderableContext);
let node: React.ReactNode = RenderableContext;
// @ts-expect-error TODO context values are recursively unwrapped so this should be allowed by types.
node = NestedContext;

const NotRenderableContext = React.createContext(() => {});
// @ts-expect-error
node: React.ReactNode = NotRenderableContext;
}
18 changes: 0 additions & 18 deletions types/react/ts5.0/test/experimental.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,24 +72,6 @@ function useEvent() {
);
}

// ReactNode tests
{
// @ts-expect-error
const render: React.ReactNode = () => React.createElement("div");
// @ts-expect-error
const emptyObject: React.ReactNode = {};
// @ts-expect-error
const plainObject: React.ReactNode = { dave: true };
const promise: React.ReactNode = Promise.resolve("React");
// @ts-expect-error plain objects are not allowed
<div>{{ dave: true }}</div>;
<div>{Promise.resolve("React")}</div>;

const asyncTests = async function asyncTests() {
const node: Awaited<React.ReactNode> = await Promise.resolve("React");
};
}

function elementTypeTests() {
const ReturnPromise = () => Promise.resolve("React");
// @ts-expect-error Needs https://github.com/DefinitelyTyped/DefinitelyTyped/pull/65135
Expand Down