Skip to content

Commit

Permalink
feat(chromium): add generateDocumentOutline form field
Browse files Browse the repository at this point in the history
  • Loading branch information
@gulien
gulien committed Nov 18, 2024
1 parent 3f47d8a commit d47e2fc
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions docs/routes.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -422,21 +422,22 @@ Body: Service Unavailable

Each route accepts the following form fields:

| Key | Description | Default |
|-------------------|---------------------------------------------------------------------------------------------------------------------------|-----------|
| singlePage | Define whether to print the entire content in one single page. | false |
| paperWidth | Specify paper width using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 8.5 |
| paperHeight | Specify paper height using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 11 |
| marginTop | Specify top margin width using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| marginBottom | Specify bottom margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| marginLeft | Specify left margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| marginRight | Specify right margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| preferCssPageSize | Define whether to prefer page size as defined by CSS. | false |
| printBackground | Print the background graphics. | false |
| omitBackground | Hide the default white background and allow generating PDFs with transparency. | false |
| landscape | Set the paper orientation to landscape. | false |
| scale | The scale of the page rendering. | 1.0 |
| nativePageRanges | Page ranges to print, e.g., '1-5, 8, 11-13' - empty means all pages. | All pages |
| Key | Description | Default |
|-------------------------|---------------------------------------------------------------------------------------------------------------------------|-----------|
| singlePage | Define whether to print the entire content in one single page. | false |
| paperWidth | Specify paper width using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 8.5 |
| paperHeight | Specify paper height using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 11 |
| marginTop | Specify top margin width using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| marginBottom | Specify bottom margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| marginLeft | Specify left margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| marginRight | Specify right margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified. | 0.39 |
| preferCssPageSize | Define whether to prefer page size as defined by CSS. | false |
| generateDocumentOutline | Define whether the document outline should be embedded into the PDF. | false |
| printBackground | Print the background graphics. | false |
| omitBackground | Hide the default white background and allow generating PDFs with transparency. | false |
| landscape | Set the paper orientation to landscape. | false |
| scale | The scale of the page rendering. | 1.0 |
| nativePageRanges | Page ranges to print, e.g., '1-5, 8, 11-13' - empty means all pages. | All pages |

<Tabs
defaultValue="curl"
Expand Down

0 comments on commit d47e2fc

Please sign in to comment.