Expo

Get Started
API Reference

Print

expo-print provides an API for iOS (AirPrint) and Android printing functionality.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Installation

expo install expo-print

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

API

import * as Print from 'expo-print';

Constants

Print.Orientation

Type: OrientationType

The orientation of the printed content.

Methods

Print.printAsync(options)

Arguments

  • options (PrintOptions) - A map defining what should be printed.

Prints a document or HTML, on web this prints the HTML from the page.

Note: On iOS, printing from HTML source doesn't support local asset URLs (due to WKWebView limitations). As a workaround you can use inlined base64-encoded strings. See this comment for more details.

Returns

  • Promise<void>

Resolves to an empty Promise if printing started.

Print.printToFileAsync(options)

Arguments

Prints HTML to PDF file and saves it to app's cache directory. On Web this method opens the print dialog.

Print.selectPrinterAsync()

Available on iOS only. Chooses a printer that can be later used in printAsync

Returns

A promise which fulfils with an object containing name and url of the selected printer.

Types

FilePrintOptions

NameTypeDescription
base64
(optional)		booleanWhether to include base64 encoded string of the file in the returned object.
height
(optional)		numberHeight of the single page in pixels. Defaults to 792 which is a height of US Letter paper format with 72 PPI.
html
(optional)		stringHTML string to print into PDF file.
padding
(optional)		FilePrintPaddingPadding for the printed document.
width
(optional)		numberWidth of the single page in pixels. Defaults to 612 which is a width of US Letter paper format with 72 PPI.

FilePrintResult

NameTypeDescription
base64
(optional)		stringBase64 encoded string containing the data of the PDF file. Available only if base64 option is truthy. It doesn't include data URI prefix data:application/pdf;base64,.
numberOfPagesnumberNumber of pages that were needed to render given content.
uristringA URI to the printed PDF file.

PrintOptions

NameTypeDescription
height
(optional)		numberHeight of the single page in pixels. Defaults to 792 which is a height of US Letter paper format with 72 PPI. Available only with html option.
html
(optional)		stringHTML string to print. Available on Android and iOS only.
markupFormatterIOS
(optional)		stringAvailable on iOS only. Alternative to html option that uses UIMarkupTextPrintFormatter instead of WebView. Might be removed in the future releases.
orientation
(optional)		undefined | undefinedAvailable on iOS only. The orientation of the printed content, Print.Orientation.portrait or Print.Orientation.landscape.
printerUrl
(optional)		stringURL of the printer to use. Returned from selectPrinterAsync. Available on iOS only.
uri
(optional)		stringURI of a PDF file to print. Remote, local (ex. selected via DocumentPicker) or base64 data URI starting with data:application/pdf;base64,. This only supports PDF, not other types of document (e.g. images). Available on Android and iOS only.
width
(optional)		numberWidth of the single page in pixels. Defaults to 612 which is a width of US Letter paper format with 72 PPI. Available only with html option.

Printer

NameTypeDescription
namestringName of the printer.
urlstringURL of the printer.

Interfaces

OrientationType

The possible values of orientation for the printed content.

NameTypeDescription
landscapestring-
portraitstring-

Page margins

If you're using html option in printAsync or printToFileAsync, the resulting print might contain page margins (it depends on WebView engine). They are set by @page style block and you can override them in your HTML code:
<style>
  @page {
    margin: 20px;
  }
</style>
See @page docs on MDN for more details.