react-native-html-to-pdf

September 4, 2025 ยท View on GitHub

Convert html strings to PDF documents using React Native

Installation

npm install react-native-html-to-pdf

Usage

Usage

import React, { Component } from 'react';

import { Text, TouchableHighlight, View } from 'react-native';

import { generatePDF } from 'react-native-html-to-pdf';

export default class Example extends Component {
  async createPDF() {
    let options = {
      html: '<h1>PDF TEST</h1>',
      fileName: 'test',
      base64: true,
    };

    let results = await generatePDF(options);
    console.log(results);
  }

  render() {
    return (
      <View>
        <TouchableHighlight onPress={this.createPDF}>
          <Text>Create PDF</Text>
        </TouchableHighlight>
      </View>
    );
  }
}

Options

ParamTypeDefaultNote
htmlstringHTML string to be converted
fileNamestringRandomCustom Filename excluding .pdf extension
base64booleanfalsereturn base64 string of pdf file (not recommended)
directorystringdefault cache directoryDirectory where the file will be created (Documents folder in example above). Please note, on iOS Documents is the only custom value that is accepted.
heightnumber792Set document height (points)
widthnumber612Set document width (points)

iOS Only

ParamTypeDefaultNote
paddingLeftnumber10Outer left padding (points)
paddingRightnumber10Outer right padding (points)
paddingTopnumber10Outer top padding (points)
paddingBottomnumber10Outer bottom padding (points)
paddingnumber10Outer padding for any side (points), overrides any padding listed before
bgColorstring#F6F5F0Background color in Hexadecimal

Android Only

ParamTypeDefaultNote
fontsArrayAllow custom fonts ['/fonts/TimesNewRoman.ttf', '/fonts/Verdana.ttf']

Contributing

License

MIT


Made with create-react-native-library