Back to React Pdf

README

packages/renderer/README.md

2.0.215.3 KB
Original Source
<p align="center"> <p align="center">React renderer for creating PDF files on the browser and server<p> <p align="center"> <a href="https://www.npmjs.com/package/@react-pdf/renderer">
</a>
<a href="https://travis-ci.org/diegomura/react-pdf">
  
</a>
<a href="https://github.com/diegomura/react-pdf/blob/master/LICENSE">
  
</a>
<a href="https://spectrum.chat/react-pdf">
  
</a>
<a href="https://github.com/prettier/prettier">
  
</a>
</p> </p>

How to install

sh
yarn add @react-pdf/renderer

How it works

jsx
import { Document, Page, Text, View, StyleSheet } from '@react-pdf/renderer';

// Create styles
const styles = StyleSheet.create({
  page: {
    flexDirection: 'row',
    backgroundColor: '#E4E4E4',
  },
  section: {
    margin: 10,
    padding: 10,
    flexGrow: 1,
  },
});

// Create Document Component
const MyDocument = () => (
  <Document>
    <Page size="A4" style={styles.page}>
      <View style={styles.section}>
        <Text>Section #1</Text>
      </View>
      <View style={styles.section}>
        <Text>Section #2</Text>
      </View>
    </Page>
  </Document>
);

Web. Render in DOM

jsx
import ReactDOM from 'react-dom';
import { PDFViewer } from '@react-pdf/renderer';

const App = () => (
  <PDFViewer>
    <MyDocument />
  </PDFViewer>
);

ReactDOM.render(<App />, document.getElementById('root'));

Node. Save in a file

jsx
import ReactPDF from '@react-pdf/renderer';

ReactPDF.render(<MyDocument />, `${__dirname}/example.pdf`);

Examples

For each example, try opening output.pdf to see the result.

<table> <tbody> <tr> <td align="center" valign="top"> <a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/text/">
			</a>
			

			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/text/">Text</a>
		</td>
		<td align="center" valign="top">
			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/resume/">
				
			</a>
			

			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/resume/">Resume</a>
		</td>
		<td align="center" valign="top">
			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/fractals/">
				
			</a>
			

			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/fractals/">Fractals</a>
		</td>
	</tr>
</tbody>
</table> <table> <tbody> <tr> <td align="center" valign="top"> <a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/knobs/">
			</a>
			

			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/knobs/">Knobs</a>
		</td>
		<td align="center" valign="top">
			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/pageWrap/">
				
			</a>
			

			<a href="https://github.com/diegomura/react-pdf/tree/master/packages/examples/src/pageWrap/">Page wrap</a>
		</td>
	</tr>
</tbody>
</table>

Contributors

This project exists thanks to all the people who contribute. [Contribute]. <a href="https://github.com/diegomura/react-pdf/graphs/contributors"></a>

Sponsors

Thank you to all our sponsors! [Become a sponsors]

<a href="https://opencollective.com/react-pdf#sponsors" target="_blank"></a>

Backers

Thank you to all our backers! [Become a backer]

<a href="https://opencollective.com/react-pdf#backers" target="_blank"></a>

License

MIT © Diego Muracciole