1.0.0 • Published 6 months ago

capacitor-reader v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

capacitor-reader

Opens a simplified in app browser, prioritizing readability.

If you're looking for additional functionality, this plugin is not for you. ;)

Install

npm install capacitor-reader
npx cap sync

API

open(...)

open(options: CapacitorReaderOpenOptions) => Promise<void>

iOS & Android only

ParamType
optionsCapacitorReaderOpenOptions

addListener('browserFinished', ...)

addListener(eventName: 'browserFinished', listenerFunc: () => void) => Promise<PluginListenerHandle>

iOS only: Listen for the browser finished event. It fires when the Browser is closed by the user.

This is necessary for those that want to track iOS status taps (since capacitor swizzles all iOS navigation taps)

ParamType
eventName'browserFinished'
listenerFunc() => void

Returns: Promise<PluginListenerHandle>


Interfaces

CapacitorReaderOpenOptions

PropTypeDescriptionDefault
urlstring
toolbarColorstringThe color of the toolbar
entersReaderIfAvailablebooleanWhether to enter reader mode if available iOS onlyfalse

PluginListenerHandle

PropType
remove() => Promise<void>
1.0.0

6 months ago

0.4.0

6 months ago

0.3.1

7 months ago

0.3.0

7 months ago

0.2.0

8 months ago

0.1.0

8 months ago

0.0.1

8 months ago