{"route":"/en-US-v0.14.1/reference/layout/page/","title":"Page","description":"Documentation for the `page` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"accessibility","name":"Accessibility","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-paper","name":"paper","children":[]},{"id":"parameters-width","name":"width","children":[]},{"id":"parameters-height","name":"height","children":[]},{"id":"parameters-flipped","name":"flipped","children":[]},{"id":"parameters-margin","name":"margin","children":[]},{"id":"parameters-binding","name":"binding","children":[]},{"id":"parameters-columns","name":"columns","children":[]},{"id":"parameters-fill","name":"fill","children":[]},{"id":"parameters-numbering","name":"numbering","children":[]},{"id":"parameters-supplement","name":"supplement","children":[]},{"id":"parameters-number-align","name":"number-align","children":[]},{"id":"parameters-header","name":"header","children":[]},{"id":"parameters-header-ascent","name":"header-ascent","children":[]},{"id":"parameters-footer","name":"footer","children":[]},{"id":"parameters-footer-descent","name":"footer-descent","children":[]},{"id":"parameters-background","name":"background","children":[]},{"id":"parameters-foreground","name":"foreground","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"page","title":"Page","keywords":[],"oneliner":"Layouts its child onto one or multiple pages.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Layouts its child onto one or multiple pages.

\n

Although this function is primarily used in set rules to affect page\nproperties, it can also be used to explicitly render its argument onto\na set of pages of its own.

\n

Pages can be set to use auto as their width or height. In this case, the\npages will grow to fit their content on the respective axis.

\n

The Guide for Page Setup explains how to use\nthis and related functions to set up a document with many examples.

\n

Example

\n
#set page("us-letter")\n\nThere you go, US friends!\n
\"Preview\"
\n

Accessibility

\n

The contents of the page's header, footer, foreground, and background are\ninvisible to Assistive Technology (AT) like screen readers. Only the body of\nthe page is read by AT. Do not include vital information not included\nelsewhere in the document in these areas.

"}],"self":false,"params":[{"name":"paper","details":[{"kind":"html","content":"

A standard paper size to set width and height.

\n

This is just a shorthand for setting width and height and, as such,\ncannot be retrieved in a context expression.

"}],"types":["str"],"strings":[{"string":"a0","details":"

Produces a paper of the respective size.

"},{"string":"a1","details":"

Produces a paper of the respective size.

"},{"string":"a2","details":"

Produces a paper of the respective size.

"},{"string":"a3","details":"

Produces a paper of the respective size.

"},{"string":"a4","details":"

Produces a paper of the respective size.

"},{"string":"a5","details":"

Produces a paper of the respective size.

"},{"string":"a6","details":"

Produces a paper of the respective size.

"},{"string":"a7","details":"

Produces a paper of the respective size.

"},{"string":"a8","details":"

Produces a paper of the respective size.

"},{"string":"a9","details":"

Produces a paper of the respective size.

"},{"string":"a10","details":"

Produces a paper of the respective size.

"},{"string":"a11","details":"

Produces a paper of the respective size.

"},{"string":"iso-b1","details":"

Produces a paper of the respective size.

"},{"string":"iso-b2","details":"

Produces a paper of the respective size.

"},{"string":"iso-b3","details":"

Produces a paper of the respective size.

"},{"string":"iso-b4","details":"

Produces a paper of the respective size.

"},{"string":"iso-b5","details":"

Produces a paper of the respective size.

"},{"string":"iso-b6","details":"

Produces a paper of the respective size.

"},{"string":"iso-b7","details":"

Produces a paper of the respective size.

"},{"string":"iso-b8","details":"

Produces a paper of the respective size.

"},{"string":"iso-c3","details":"

Produces a paper of the respective size.

"},{"string":"iso-c4","details":"

Produces a paper of the respective size.

"},{"string":"iso-c5","details":"

Produces a paper of the respective size.

"},{"string":"iso-c6","details":"

Produces a paper of the respective size.

"},{"string":"iso-c7","details":"

Produces a paper of the respective size.

"},{"string":"iso-c8","details":"

Produces a paper of the respective size.

"},{"string":"din-d3","details":"

Produces a paper of the respective size.

"},{"string":"din-d4","details":"

Produces a paper of the respective size.

"},{"string":"din-d5","details":"

Produces a paper of the respective size.

"},{"string":"din-d6","details":"

Produces a paper of the respective size.

"},{"string":"din-d7","details":"

Produces a paper of the respective size.

"},{"string":"din-d8","details":"

Produces a paper of the respective size.

"},{"string":"sis-g5","details":"

Produces a paper of the respective size.

"},{"string":"sis-e5","details":"

Produces a paper of the respective size.

"},{"string":"ansi-a","details":"

Produces a paper of the respective size.

"},{"string":"ansi-b","details":"

Produces a paper of the respective size.

"},{"string":"ansi-c","details":"

Produces a paper of the respective size.

"},{"string":"ansi-d","details":"

Produces a paper of the respective size.

"},{"string":"ansi-e","details":"

Produces a paper of the respective size.

"},{"string":"arch-a","details":"

Produces a paper of the respective size.

"},{"string":"arch-b","details":"

Produces a paper of the respective size.

"},{"string":"arch-c","details":"

Produces a paper of the respective size.

"},{"string":"arch-d","details":"

Produces a paper of the respective size.

"},{"string":"arch-e1","details":"

Produces a paper of the respective size.

"},{"string":"arch-e","details":"

Produces a paper of the respective size.

"},{"string":"jis-b0","details":"

Produces a paper of the respective size.

"},{"string":"jis-b1","details":"

Produces a paper of the respective size.

"},{"string":"jis-b2","details":"

Produces a paper of the respective size.

"},{"string":"jis-b3","details":"

Produces a paper of the respective size.

"},{"string":"jis-b4","details":"

Produces a paper of the respective size.

"},{"string":"jis-b5","details":"

Produces a paper of the respective size.

"},{"string":"jis-b6","details":"

Produces a paper of the respective size.

"},{"string":"jis-b7","details":"

Produces a paper of the respective size.

"},{"string":"jis-b8","details":"

Produces a paper of the respective size.

"},{"string":"jis-b9","details":"

Produces a paper of the respective size.

"},{"string":"jis-b10","details":"

Produces a paper of the respective size.

"},{"string":"jis-b11","details":"

Produces a paper of the respective size.

"},{"string":"sac-d0","details":"

Produces a paper of the respective size.

"},{"string":"sac-d1","details":"

Produces a paper of the respective size.

"},{"string":"sac-d2","details":"

Produces a paper of the respective size.

"},{"string":"sac-d3","details":"

Produces a paper of the respective size.

"},{"string":"sac-d4","details":"

Produces a paper of the respective size.

"},{"string":"sac-d5","details":"

Produces a paper of the respective size.

"},{"string":"sac-d6","details":"

Produces a paper of the respective size.

"},{"string":"iso-id-1","details":"

Produces a paper of the respective size.

"},{"string":"iso-id-2","details":"

Produces a paper of the respective size.

"},{"string":"iso-id-3","details":"

Produces a paper of the respective size.

"},{"string":"asia-f4","details":"

Produces a paper of the respective size.

"},{"string":"jp-shiroku-ban-4","details":"

Produces a paper of the respective size.

"},{"string":"jp-shiroku-ban-5","details":"

Produces a paper of the respective size.

"},{"string":"jp-shiroku-ban-6","details":"

Produces a paper of the respective size.

"},{"string":"jp-kiku-4","details":"

Produces a paper of the respective size.

"},{"string":"jp-kiku-5","details":"

Produces a paper of the respective size.

"},{"string":"jp-business-card","details":"

Produces a paper of the respective size.

"},{"string":"cn-business-card","details":"

Produces a paper of the respective size.

"},{"string":"eu-business-card","details":"

Produces a paper of the respective size.

"},{"string":"fr-tellière","details":"

Produces a paper of the respective size.

"},{"string":"fr-couronne-écriture","details":"

Produces a paper of the respective size.

"},{"string":"fr-couronne-édition","details":"

Produces a paper of the respective size.

"},{"string":"fr-raisin","details":"

Produces a paper of the respective size.

"},{"string":"fr-carré","details":"

Produces a paper of the respective size.

"},{"string":"fr-jésus","details":"

Produces a paper of the respective size.

"},{"string":"uk-brief","details":"

Produces a paper of the respective size.

"},{"string":"uk-draft","details":"

Produces a paper of the respective size.

"},{"string":"uk-foolscap","details":"

Produces a paper of the respective size.

"},{"string":"uk-quarto","details":"

Produces a paper of the respective size.

"},{"string":"uk-crown","details":"

Produces a paper of the respective size.

"},{"string":"uk-book-a","details":"

Produces a paper of the respective size.

"},{"string":"uk-book-b","details":"

Produces a paper of the respective size.

"},{"string":"us-letter","details":"

Produces a paper of the respective size.

"},{"string":"us-legal","details":"

Produces a paper of the respective size.

"},{"string":"us-tabloid","details":"

Produces a paper of the respective size.

"},{"string":"us-executive","details":"

Produces a paper of the respective size.

"},{"string":"us-foolscap-folio","details":"

Produces a paper of the respective size.

"},{"string":"us-statement","details":"

Produces a paper of the respective size.

"},{"string":"us-ledger","details":"

Produces a paper of the respective size.

"},{"string":"us-oficio","details":"

Produces a paper of the respective size.

"},{"string":"us-gov-letter","details":"

Produces a paper of the respective size.

"},{"string":"us-gov-legal","details":"

Produces a paper of the respective size.

"},{"string":"us-business-card","details":"

Produces a paper of the respective size.

"},{"string":"us-digest","details":"

Produces a paper of the respective size.

"},{"string":"us-trade","details":"

Produces a paper of the respective size.

"},{"string":"newspaper-compact","details":"

Produces a paper of the respective size.

"},{"string":"newspaper-berliner","details":"

Produces a paper of the respective size.

"},{"string":"newspaper-broadsheet","details":"

Produces a paper of the respective size.

"},{"string":"presentation-16-9","details":"

Produces a paper of the respective size.

"},{"string":"presentation-4-3","details":"

Produces a paper of the respective size.

"}],"default":""a4"","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"width","details":[{"kind":"html","content":"

The width of the page.

"},{"kind":"example","content":{"body":"
#set page(\n  width: 3cm,\n  margin: (x: 0cm),\n)\n\n#for i in range(3) {\n  box(square(width: 1cm))\n}\n
\"Preview\"
","title":null}}],"types":["auto","length"],"strings":[],"default":"595.28pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"height","details":[{"kind":"html","content":"

The height of the page.

\n

If this is set to auto, page breaks can only be triggered manually\nby inserting a page break or by adding another non-empty\npage set rule. Most examples throughout this documentation use auto\nfor the height of the page to dynamically grow and shrink to fit their\ncontent.

"}],"types":["auto","length"],"strings":[],"default":"841.89pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"flipped","details":[{"kind":"html","content":"

Whether the page is flipped into landscape orientation.

"},{"kind":"example","content":{"body":"
#set page(\n  "us-business-card",\n  flipped: true,\n  fill: rgb("f2e5dd"),\n)\n\n#set align(bottom + end)\n#text(14pt)[*Sam H. Richards*] \\\n_Procurement Manager_\n\n#set text(10pt)\n17 Main Street \\\nNew York, NY 10001 \\\n+1 555 555 5555\n
\"Preview\"
","title":null}}],"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"margin","details":[{"kind":"html","content":"

The page's margins.

\n\n

All keys are optional; omitted keys will use their previously set value,\nor the default margin if never set. In addition, the values for left\nand right are mutually exclusive with the values for inside and\noutside.

"},{"kind":"example","content":{"body":"
#set page(\n width: 3cm,\n height: 4cm,\n margin: (x: 8pt, y: 4pt),\n)\n\n#rect(\n  width: 100%,\n  height: 100%,\n  fill: aqua,\n)\n
\"Preview\"
","title":null}}],"types":["auto","relative","dictionary"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"binding","details":[{"kind":"html","content":"

On which side the pages will be bound.

\n\n

This affects the meaning of the inside and outside options for\nmargins.

"}],"types":["auto","alignment"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"columns","details":[{"kind":"html","content":"

How many columns the page has.

\n

If you need to insert columns into a page or other container, you can\nalso use the columns function.

"},{"kind":"example","content":{"body":"
#set page(columns: 2, height: 4.8cm)\nClimate change is one of the most\npressing issues of our time, with\nthe potential to devastate\ncommunities, ecosystems, and\neconomies around the world. It's\nclear that we need to take urgent\naction to reduce our carbon\nemissions and mitigate the impacts\nof a rapidly changing climate.\n
\"Preview\"
","title":null}}],"types":["int"],"strings":[],"default":"1","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"fill","details":[{"kind":"html","content":"

The page's background fill.

\n

Setting this to something non-transparent instructs the printer to color\nthe complete page. If you are considering larger production runs, it may\nbe more environmentally friendly and cost-effective to source pre-dyed\npages and not set this property.

\n

When set to none, the background becomes transparent. Note that PDF\npages will still appear with a (usually white) background in viewers,\nbut they are actually transparent. (If you print them, no color is used\nfor the background.)

\n

The default of auto results in none for PDF output, and\nwhite for PNG and SVG.

"},{"kind":"example","content":{"body":"
#set page(fill: rgb("444352"))\n#set text(fill: rgb("fdfdfd"))\n*Dark mode enabled.*\n
\"Preview\"
","title":null}}],"types":["none","auto","color","gradient","tiling"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"numbering","details":[{"kind":"html","content":"

How to number the pages. You can refer to the Page Setup Guide for\ncustomizing page numbers.

\n

Accepts a numbering pattern or function taking one or two\nnumbers:

\n
    \n
  1. The first number is the current page number.
    2. \n
  2. The second number is the total number of pages. In a numbering\npattern, the second number can be omitted. If a function is passed,\nit will receive one argument in the context of links or references,\nand two arguments when producing the visible page numbers.
    3. \n
\n

These are logical numbers controlled by the page counter, and may thus\nnot match the physical numbers. Specifically, they are the\ncurrent and the final value of\ncounter(page). See the counter\ndocumentation for more details.

\n

If an explicit footer (or header for\ntop-aligned numbering) is given, the numbering is\nignored.

"},{"kind":"example","content":{"body":"
#set page(\n  height: 100pt,\n  margin: (top: 16pt, bottom: 24pt),\n  numbering: "1 / 1",\n)\n\n#lorem(48)\n
\"Preview\"Preview
","title":null}}],"types":["none","str","function"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"supplement","details":[{"kind":"html","content":"

A supplement for the pages.

\n

For page references, this is added before the page number.

"},{"kind":"example","content":{"body":"
#set page(numbering: "1.", supplement: [p.])\n\n= Introduction <intro>\nWe are on #ref(<intro>, form: "page")!\n
\"Preview\"
","title":null}}],"types":["none","auto","content"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"number-align","details":[{"kind":"html","content":"

The alignment of the page numbering.

\n

If the vertical component is top, the numbering is placed into the\nheader and if it is bottom, it is placed in the footer. Horizon\nalignment is forbidden. If an explicit matching header or footer is\ngiven, the numbering is ignored.

"},{"kind":"example","content":{"body":"
#set page(\n  margin: (top: 16pt, bottom: 24pt),\n  numbering: "1",\n  number-align: right,\n)\n\n#lorem(30)\n
\"Preview\"
","title":null}}],"types":["alignment"],"strings":[],"default":"center + bottom","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"header","details":[{"kind":"html","content":"

The page's header. Fills the top margin of each page.

\n"},{"kind":"example","content":{"body":"
#set par(justify: true)\n#set page(\n  margin: (top: 32pt, bottom: 20pt),\n  header: [\n    #set text(8pt)\n    #smallcaps[Typst Academy]\n    #h(1fr) _Exercise Sheet 3_\n  ],\n)\n\n#lorem(19)\n
\"Preview\"
","title":null}}],"types":["none","auto","content"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"header-ascent","details":[{"kind":"html","content":"

The amount the header is raised into the top margin.

"}],"types":["relative"],"strings":[],"default":"30% + 0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"footer","details":[{"kind":"html","content":"

The page's footer. Fills the bottom margin of each page.

\n\n

For just a page number, the numbering property typically suffices. If\nyou want to create a custom footer but still display the page number,\nyou can directly access the page counter.

"},{"kind":"example","content":{"body":"
#set par(justify: true)\n#set page(\n  height: 100pt,\n  margin: 20pt,\n  footer: context [\n    #set align(right)\n    #set text(8pt)\n    #counter(page).display(\n      "1 of I",\n      both: true,\n    )\n  ]\n)\n\n#lorem(48)\n
\"Preview\"Preview
","title":null}}],"types":["none","auto","content"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"footer-descent","details":[{"kind":"html","content":"

The amount the footer is lowered into the bottom margin.

"}],"types":["relative"],"strings":[],"default":"30% + 0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"background","details":[{"kind":"html","content":"

Content in the page's background.

\n

This content will be placed behind the page's body. It can be\nused to place a background image or a watermark.

"},{"kind":"example","content":{"body":"
#set page(background: rotate(24deg,\n  text(18pt, fill: rgb("FFCBC4"))[\n    *CONFIDENTIAL*\n  ]\n))\n\n= Typst's secret plans\nIn the year 2023, we plan to take\nover the world (of typesetting).\n
\"Preview\"
","title":null}}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"foreground","details":[{"kind":"html","content":"

Content in the page's foreground.

\n

This content will overlay the page's body.

"},{"kind":"example","content":{"body":"
#set page(foreground: text(24pt)[🤓])\n\nReviewer 2 has marked our paper\n"Weak Reject" because they did\nnot understand our approach...\n
\"Preview\"
","title":null}}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":[{"kind":"html","content":"

The contents of the page(s).

\n

Multiple pages will be created if the content does not fit on a single\npage. A new page with the page properties prior to the function invocation\nwill be created after the body has been typeset.

"}],"types":["content"],"strings":[],"default":"[]","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}}}