Skip to content

Commit 30bc519

Browse files
committed
docs: update v1.1.5-beta01 5cf0dac
0 parents  commit 30bc519

907 files changed

Lines changed: 125177 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.nojekyll

Whitespace-only changes.

MIGRATION.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
# PdfViewer
3+
A lightweight **Android PDF viewer library** powered by Mozilla's [PDF.js](https://github.com/mozilla/pdf.js), offering seamless PDF rendering and interactive features. Supports both Jetpack Compose and Xml.
4+
5+
## Migrating to v1.1.0
6+
7+
In version `v1.1.0`, the library packages have been renamed to reflect the new namespace. If you're upgrading from an older version, you'll need to update your import statements accordingly.
8+
9+
### 📦 What Changed?
10+
11+
| Old Package | New Package |
12+
|---------------------------------------|---------------------------------|
13+
| `com.acutecoder.pdf` | `com.bhuvaneshw.pdf` |
14+
| `com.acutecoder.pdf.ui` | `com.bhuvaneshw.pdf.ui` |
15+
| `com.acutecoder.pdfviewer.compose` | `com.bhuvaneshw.pdf.compose` |
16+
| `com.acutecoder.pdfviewer.compose.ui` | `com.bhuvaneshw.pdf.compose.ui` |
17+
18+
In addition to package renaming, all previous extension functions for adding PDF event listeners (such as `PdfOnPageLoadStart`) have been removed and replaced with a more streamlined and unified approach.
19+
20+
### 🛠 What You Need to Do
21+
22+
- Open your project
23+
- Search for any imports starting with `com.acutecoder.`
24+
- Replace them with the shiny new `com.bhuvaneshw.` equivalents
25+
- Also update any usage of `pdfviewer` (`com.acutecoder.pdfviewer`) in package paths or module references to just `pdf` (`com.bhuvaneshw.pdf`)
26+
- For adding listeners use new extension function PdfViewer.addListener()
27+
- For example, replace `pdfviewer.addListener(PdfOnPageLoadStart { })` with `pdfviewer.addListener(onPageLoadStart = { })`
28+
- That’s it—you’re good to go! 🚀
29+
30+
### 💬 Why the Change?
31+
32+
Just making things a bit more personal and better aligned with ongoing development. New namespace, cleaner name, more predictable API, same smooth PDF experience. 😎
33+
34+
**If you hit any snags, feel free to open an issue!**

0 commit comments

Comments
 (0)