refactor: rename option

Author: mdjastrzebski

jest-setup.ts

@@ -3,5 +3,5 @@ import './src/matchers/extend-expect';
 
 beforeEach(() => {
   resetToDefaults();
-  configure({ legacyRoot: false });
+  configure({ concurrentRendering: false });
 });

src/__tests__/config.test.ts

@@ -16,7 +16,7 @@ test('configure() overrides existing config values', () => {
     asyncUtilTimeout: 5000,
     defaultDebugOptions: { message: 'debug message' },
     defaultIncludeHiddenElements: false,
-    legacyRoot: true,
+    concurrentRendering: false,
   });
 });
 

src/__tests__/render.test.tsx

@@ -241,3 +241,13 @@ test('render calls detects host component names', () => {
   render(<View testID="test" />);
   expect(getConfig().hostComponentNames).not.toBeUndefined();
 });
+
+test('supports legacy rendering', () => {
+  render(<View testID="test" />, { concurrentRendering: false });
+  expect(screen.root).toBeDefined();
+});
+
+test('supports concurrent rendering', () => {
+  render(<View testID="test" />, { concurrentRendering: true });
+  expect(screen.root).toBeDefined();
+});

src/config.ts

@@ -15,11 +15,10 @@ export type Config = {
   defaultDebugOptions?: Partial<DebugOptions>;
 
   /**
-   * Only works if used with React 18.
-   * Set to `true` if you want to force synchronous rendering.
-   * Otherwise `render` will default to concurrent React if available.
+   * Set to `true` to enable concurrent rendering.
+   * Otherwise `render` will default to legacy synchronous rendering.
    */
-  legacyRoot: boolean;
+  concurrentRendering: boolean;
 };
 
 export type ConfigAliasOptions = {
@@ -44,7 +43,7 @@ export type InternalConfig = Config & {
 const defaultConfig: InternalConfig = {
   asyncUtilTimeout: 1000,
   defaultIncludeHiddenElements: false,
-  legacyRoot: true,
+  concurrentRendering: false,
 };
 
 let config = { ...defaultConfig };

src/render.tsx

@@ -25,11 +25,10 @@ export interface RenderOptions {
   wrapper?: React.ComponentType<any>;
 
   /**
-   * Only works if used with React 18.
-   * Set to `true` if you want to force synchronous rendering.
-   * Otherwise `render` will default to concurrent React if available.
+   * Set to `true` to enable concurrent rendering.
+   * Otherwise `render` will default to legacy synchronous rendering.
    */
-  legacyRoot?: boolean | undefined;
+  concurrentRendering?: boolean | undefined;
 
   createNodeMock?: (element: React.ReactElement) => unknown;
   unstable_validateStringsRenderedWithinText?: boolean;
@@ -55,15 +54,15 @@ export function renderInternal<T>(
 ) {
   const {
     wrapper: Wrapper,
-    legacyRoot,
+    concurrentRendering: concurrent,
     detectHostComponentNames = true,
     unstable_validateStringsRenderedWithinText,
     ...rest
   } = options || {};
 
   const testRendererOptions: TestRendererOptions = {
     // @ts-expect-error incomplete typing on RTR package
-    unstable_isConcurrent: !(legacyRoot ?? getConfig().legacyRoot),
+    unstable_isConcurrent: concurrent ?? getConfig().concurrentRendering,
     ...rest,
   };