Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christopherdro/react-native-print
Print documents using React Native
https://github.com/christopherdro/react-native-print
Last synced: about 2 months ago
JSON representation
Print documents using React Native
- Host: GitHub
- URL: https://github.com/christopherdro/react-native-print
- Owner: christopherdro
- License: mit
- Created: 2015-09-04T19:29:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T19:55:16.000Z (9 months ago)
- Last Synced: 2024-04-29T01:09:37.770Z (9 months ago)
- Language: C++
- Size: 938 KB
- Stars: 323
- Watchers: 16
- Forks: 135
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-native-native-modules - react-native-print ★84
README
# react-native-print
Print documents using React Native.
## Installation
Run `npm install react-native-print --save`
## Add it to your project
### Automatic
Run `react-native link`
### Manual
#### iOS
1. Open your project in XCode, right click on [Libraries](http://url.brentvatne.ca/jQp8) and select [Add Files to "Your Project Name](http://url.brentvatne.ca/1gqUD).
2. Choose the file `node_modules/react-native-print/RNPrint.xcodeproj`
3. Go to `Project Manager` tab and click on your project's name. Select the name of the target and click on `Build Phases`
4. Add `libRNPrint.a` to `Link Binary With Libraries`
[(Screenshot)](http://url.brentvatne.ca/17Xfe).
#### Android
- Edit `android/settings.gradle` to included
```java
include ':react-native-print'
project(':react-native-print').projectDir = new File(rootProject.projectDir,'../node_modules/react-native-print/android')
```
- Edit `android/app/build.gradle` file to include
```java
dependencies {
....
compile project(':react-native-print')
}
```
- Edit `MainApplication.java` to include
```java
// import the package
import com.christopherdro.RNPrint.RNPrintPackage;
// include package
new MainReactPackage(),
new RNPrintPackage(),
```
#### Windows
1. In `windows/myapp.sln` add the `RNPrint` project to your solution:
- Open the solution in Visual Studio 2019
- Right-click Solution icon in Solution Explorer > Add > Existing Project
- Select `node_modules\react-native-print\windows\RNPrint\RNPrint.vcxproj`
2. In `windows/myapp/myapp.vcxproj` ad a reference to `RNPrint` to your main application project. From Visual Studio 2019:
- Right-click main application project > Add > Reference...
- Check `RNPrint` from Solution Projects.
3. In `pch.h` add `#include "winrt/RNPrint.h"`.
4. In `app.cpp` add `PackageProviders().Append(winrt::RNPrint::ReactPackageProvider());` before `InitializeComponent();`.
### Windows print canvas
On Windows, `react-native-print` needs an element in the visual tree to add the printable pages to.
It will look for a XAML `Canvas` named `RNPrintCanvas` and use it.
This needs to be added to the XAML tree of the screens where `react-native-print` is used.
As an example, in `windows/myapp/MainPage.xaml` from the `react-native-windows` app template this can be done by adding a XAML `Grid` with an invisible `Canvas` alongside the `ReactRootView`. Change `windows/myapp/MainPage.xaml` from:
```xaml
```
to
```xaml
```
## Usage
```javascript
/**
* Sample React Native App
* https://github.com/facebook/react-native
* @flow
*/
import React, { Component } from 'react';
import {
AppRegistry,
Button,
StyleSheet,
NativeModules,
Platform,
Text,
View
} from 'react-native';
import RNHTMLtoPDF from 'react-native-html-to-pdf';
import RNPrint from 'react-native-print';
export default class RNPrintExample extends Component {
state = {
selectedPrinter: null
}
// @NOTE iOS Only
selectPrinter = async () => {
const selectedPrinter = await RNPrint.selectPrinter({ x: 100, y: 100 })
this.setState({ selectedPrinter })
}
// @NOTE iOS Only
silentPrint = async () => {
if (!this.state.selectedPrinter) {
alert('Must Select Printer First')
}
const jobName = await RNPrint.print({
printerURL: this.state.selectedPrinter.url,
html: '
Silent Print
'
})
}
async printHTML() {
await RNPrint.print({
html: '
Heading 1
Heading 2
Heading 3
'
})
}
async printPDF() {
const results = await RNHTMLtoPDF.convert({
html: '
Custom converted PDF Document
',
fileName: 'test',
base64: true,
})
await RNPrint.print({ filePath: results.filePath })
}
async printRemotePDF() {
await RNPrint.print({ filePath: 'https://graduateland.com/api/v2/users/jesper/cv' })
}
customOptions = () => {
return (
{this.state.selectedPrinter &&
{`Selected Printer Name: ${this.state.selectedPrinter.name}`}
{`Selected Printer URI: ${this.state.selectedPrinter.url}`}
}
)
}
render() {
return (
{Platform.OS === 'ios' && this.customOptions()}
);
}
}
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: '#F5FCFF',
},
});
```
### Methods
## print(options: Object)
| Param | Type | Note |
|---|---|---|
| `html` | `string` | **iOS and Android Only:** HTML string to print
| `filePath` | `string` | Local or remote file url NOTE: iOS only supports https protocols for remote
| `printerURL` | `string` | **iOS Only:** URL returned from `selectPrinterMethod()`
| `isLandscape` | `bool` | Landscape print; default value is false
| `jobName` | `string` | **iOS and Android Only:** Name of printing job; default value is "Document"
| `baseUrl` | `string` | **Android Only:** Used to resolve relative links in the HTML. Also used for the origin header when applying same origin policy (CORS). Reference [Android WebView Docs](https://developer.android.com/reference/android/webkit/WebView#loadDataWithBaseURL(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String))
## selectPrinter(options: Object)
| Param | Type | Note |
|---|---|---|
| `x` | `string` | **iPad Only:** The x position of the popup dialog
| `y` | `string` | **iPad Only:** The y position of the popup dialog