chore: pdf generation now works in headed mode too (#33879)

microsoft · Dec 6, 2024 · 733f9a2 · 733f9a2
1 parent 993546c
commit 733f9a2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 12 deletions.
diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.md
@@ -2762,10 +2762,6 @@ This method requires Playwright to be started in a headed mode, with a falsy [`o
 
 Returns the PDF buffer.
 
-:::note
-Generating a pdf is currently only supported in Chromium headless.
-:::
-
 `page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call
 [`method: Page.emulateMedia`] before calling `page.pdf()`:
 

diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
@@ -3609,8 +3609,6 @@ export interface Page {
   /**
    * Returns the PDF buffer.
    *
-   * **NOTE** Generating a pdf is currently only supported in Chromium headless.
-   *
    * `page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call
    * [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) before calling
    * `page.pdf()`:

diff --git a/tests/library/pdf.spec.ts b/tests/library/pdf.spec.ts
@@ -17,19 +17,17 @@
 import { browserTest as it, expect } from '../config/browserTest';
 import fs from 'fs';
 
-it('should be able to save file', async ({ contextFactory, headless, browserName }, testInfo) => {
-  it.skip(!headless || browserName !== 'chromium', 'Printing to pdf is currently only supported in headless chromium.');
-
+it('should be able to save file', async ({ contextFactory, browserName }, testInfo) => {
+  it.skip(browserName !== 'chromium', 'Printing to pdf is currently only supported in chromium.');
   const context = await contextFactory();
   const page = await context.newPage();
   const outputFile = testInfo.outputPath('output.pdf');
   await page.pdf({ path: outputFile });
   expect(fs.readFileSync(outputFile).byteLength).toBeGreaterThan(0);
 });
 
-it('should be able to generate outline', async ({ contextFactory, server, headless, browserName }, testInfo) => {
-  it.skip(!headless || browserName !== 'chromium', 'Printing to pdf is currently only supported in headless chromium.');
-  // const context = await contextFactory();
+it('should be able to generate outline', async ({ contextFactory, server, browserName }, testInfo) => {
+  it.skip(browserName !== 'chromium', 'Printing to pdf is currently only supported in chromium.');
   const context = await contextFactory({
     baseURL: server.PREFIX,
   });