Skip to content

GoodReader

GoodReader is a file viewer and file manager for iPad and iPhone. Protocol Launcher allows you to generate GoodReader URL scheme links.

Usage

There are two ways to use this library:

  • On-Demand import from subpaths enables tree-shaking and keeps bundles small.
  • Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand
Recommended. Optimized for production.
Full Import
Convenient. Good for quick scripts.

Open Internal File

Open a file from GoodReader's internal file storage using the documented gropen:// prefix and the file's internal path. The path is appended exactly as provided.

On-Demand
ts
import { openInternalFile } from 'protocol-launcher/goodreader'

const url = openInternalFile({
  path: 'Manuals/Guide.pdf',
})

Download URL

Send an HTTP or HTTPS URL to GoodReader by adding the documented g prefix to the original URL scheme.

On-Demand
ts
import { downloadUrl } from 'protocol-launcher/goodreader'

const url = downloadUrl({
  url: 'https://example.com/Guide.pdf',
})

References