https://github.com/madmas/nativescript-pdf-view

A basic PDF viewer plugin for NativeScript, to display PDF documents on iOS and Android.
https://github.com/madmas/nativescript-pdf-view

android hacktoberfest ios nativescript pdf-viewer

Last synced: 3 months ago
JSON representation

A basic PDF viewer plugin for NativeScript, to display PDF documents on iOS and Android.

• Host: GitHub
• URL: https://github.com/madmas/nativescript-pdf-view
• Owner: madmas
• License: other
• Archived: true
• Fork: true (Merott/nativescript-pdf-view)
• Created: 2019-10-16T19:38:34.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-07T15:58:57.000Z (over 2 years ago)
• Last Synced: 2024-09-24T09:48:45.388Z (3 months ago)
• Topics: android, hacktoberfest, ios, nativescript, pdf-viewer
• Language: TypeScript
• Homepage:
• Size: 3.58 MB
• Stars: 13
• Watchers: 7
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# *IMPORTANT*

This plugin has moved into the NativeScript plugin repository: https://github.com/NativeScript/plugins/blob/main/packages/pdf/

Please use `npm install @nativescript/pdf`from now on.

There will be no more releases from this repository.

# NativeScript PDFView

> *Remark* [This repository](https://github.com/madmas/nativescript-pdf-view) is a fork of [the original by Merott](https://github.com/Merott/nativescript-pdf-view) that will be used with his consent to provide further maintenance of this NativeScript plugin.

A minimal PDF view implementation that does only one thing, and that is to display PDF files in the simplest way possible. It conveniently uses the iOS `WKWebView`, and for Android it uses [`AndroidPdfViewer`](https://github.com/barteksc/AndroidPdfViewer).

This plugin does the bare minimum required to render the PDF, no configuration options, and no error handling have been built yet. I welcome all Pull Requests!

My aim is to keep the features consistent across iOS and Android.

## Installation

```

tns plugin add nativescript-pdf-view

```

## Usage

### Vanilla NativeScript

```xml

  

```

### Angular NativeScript

```ts

import { PDFView } from 'nativescript-pdf-view';

import { registerElement } from 'nativescript-angular';

registerElement('PDFView', () => PDFView);

```

```html

```

## Demo

Check out the [demo](./demo) folder for a demo application using this plugin. You can run the demo by executing `npm run demo.ios` and `npm run demo.android` from the root directory of the project.

## Samples

There are sample applications avalable:

* *Plain TypeScript*: see [demo/](https://github.com/madmas/nativescript-pdf-view/tree/master/demo) folder in this repository

* *NativeScript+Angular*: [nativescript-pdf-view-angular-sample](https://github.com/madmas/nativescript-pdf-view-angular-sample) repository

* *NativeScript+VueJs*:  [nativescript-pdf-view-vue-sample](https://github.com/madmas/nativescript-pdf-view-vue-sample) repository