fix: undefined and null wrap prop values are rendered as undefined instead of true by default

Author: EvHaus

.changeset/fix-undefined-wrap.md

@@ -0,0 +1,5 @@
+---
+'@react-pdf/layout': patch
+---
+
+Treat an explicit `wrap={undefined}` like an omitted `wrap` prop (default `true`). `null` and `false` still disable wrapping.

packages/layout/src/node/getWrap.ts

@@ -8,7 +8,9 @@ const getWrap = (node: SafeNode) => {
 
   if (!node.props) return true;
 
-  return 'wrap' in node.props ? node.props.wrap : true;
+  return 'wrap' in node.props
+    ? node.props.wrap === undefined || node.props.wrap === true
+    : true;
 };
 
 export default getWrap;

packages/layout/tests/node/getWrap.test.ts

@@ -0,0 +1,70 @@
+import { describe, expect, test } from 'vitest';
+
+import getWrap from '../../src/node/getWrap';
+
+describe('node getWrap', () => {
+  test('Should return false by default for non-wrap types', () => {
+    const svgResult = getWrap({ type: 'SVG', props: {}, style: {} });
+    expect(svgResult).toBe(false);
+
+    const noteResult = getWrap({ type: 'NOTE', props: {}, style: {} });
+    expect(noteResult).toBe(false);
+
+    const imageResult = getWrap({
+      type: 'IMAGE',
+      props: { src: '' },
+      style: {},
+    });
+    expect(imageResult).toBe(false);
+
+    const canvasResult = getWrap({
+      type: 'CANVAS',
+      props: { paint: () => null },
+      style: {},
+    });
+    expect(canvasResult).toBe(false);
+  });
+
+  test('Should return true by default for other types', () => {
+    const viewResult = getWrap({ type: 'VIEW', props: {}, style: {} });
+    expect(viewResult).toBe(true);
+
+    const textResult = getWrap({ type: 'TEXT', props: {}, style: {} });
+    expect(textResult).toBe(true);
+  });
+
+  test('Should return true if wrap value is undefined', () => {
+    const undefinedResult = getWrap({
+      type: 'VIEW',
+      props: { wrap: undefined },
+      style: {},
+    });
+    expect(undefinedResult).toBe(true);
+  });
+
+  test('Should return false if wrap value is null', () => {
+    // @ts-expect-error Deliberately testing an invalid case to ensure it's also handled gracefully
+    const nullResult = getWrap({
+      type: 'VIEW',
+      props: { wrap: null },
+      style: {},
+    });
+    expect(nullResult).toBe(false);
+  });
+
+  test('Should return the custom wrap value if provided', () => {
+    const trueResult = getWrap({
+      type: 'VIEW',
+      props: { wrap: true },
+      style: {},
+    });
+    expect(trueResult).toBe(true);
+
+    const falseResult = getWrap({
+      type: 'VIEW',
+      props: { wrap: false },
+      style: {},
+    });
+    expect(falseResult).toBe(false);
+  });
+});