@kishannareshpal/expo-pdf 0.2.3 → 0.2.5

package/.bun-version

@@ -0,0 +1 @@
+1.3.6

package/.node-version

@@ -1 +1 @@
-v24.12.0
+lts/*

package/CHANGELOG.md

@@ -13,6 +13,45 @@
 _This version does not introduce any user-facing changes._
 -->
 
+## 0.2.5 - 2026-01-18
+
+
+**Full Changelog**: https://github.com/kishannareshpal/expo-pdf/compare/v0.2.4...v0.2.5
+
+
+## 0.2.4 - 2026-01-18
+
+
+### 📚 Documentation
+
+- docs: update readme with prior art and uniwind info ([41eed16](https://github.com/kishannareshpal/expo-pdf/commit/41eed169f5f1e8edcaf819e42706020f27bdf5f9)) by `Kishan Jadav`
+- docs: fix typo ([75204b4](https://github.com/kishannareshpal/expo-pdf/commit/75204b4b04466b3c62ccb78f3fc28b2472c08e9f)) by `Kishan Jadav`
+
+
+### 🧹 Chores
+
+- chore: add uniwind styled component example ([592aafd](https://github.com/kishannareshpal/expo-pdf/commit/592aafdc40aed850a733d1f9eadf8c7410de8143)) by `Kishan Jadav`
+
+
+### 📦 Other Changes
+
+- ci: relax pr req and push directly from ci ([baa6a52](https://github.com/kishannareshpal/expo-pdf/commit/baa6a527771ce25aa8dddca055b8cd77f6874453)) by `Kishan Jadav`
+- ci: try admin priv. for merging release pr ([f4f3496](https://github.com/kishannareshpal/expo-pdf/commit/f4f349616e7fc26e4bc68630016ba1825106ad76)) by `Kishan Jadav`
+- ci: merge release pr ([90b2b2d](https://github.com/kishannareshpal/expo-pdf/commit/90b2b2dd96aecf4734899d70e85cbf0f878450cc)) by `Kishan Jadav`
+- ci: fix changelog update ([ca9f012](https://github.com/kishannareshpal/expo-pdf/commit/ca9f0123887c567e325fab9ddc159a01e49bbae8)) by `Kishan Jadav`
+- ci: fix pr not merging on release again ([b933332](https://github.com/kishannareshpal/expo-pdf/commit/b9333328a19d0518192aecfab78f5096726c7c7c)) by `Kishan Jadav`
+- ci: fix pr not merging on release ([e3cc3bb](https://github.com/kishannareshpal/expo-pdf/commit/e3cc3bb3f5cc7c19baa8ad97d1229b7d37aee662)) by `Kishan Jadav`
+- ci: release to create pr to allow push ([60dfc8a](https://github.com/kishannareshpal/expo-pdf/commit/60dfc8a7058dd84e27d071d5ba317e9e306a5b8f)) by `Kishan Jadav`
+- ci: tidy release action summary ([64de3d7](https://github.com/kishannareshpal/expo-pdf/commit/64de3d7607f7625994704a66cdedbad25412b695)) by `Kishan Jadav`
+- ci: fix gen release notes format ([14d6d2a](https://github.com/kishannareshpal/expo-pdf/commit/14d6d2a391de506e5c7cb201d8616c5e07d145ed)) by `Kishan Jadav`
+- ci: update release notes format to include link to commit and author name ([d4c88fa](https://github.com/kishannareshpal/expo-pdf/commit/d4c88fa4c20cad9aaa8165acec262dbdde62c15b)) by `Kishan Jadav`
+- ci: include generated summary notes in action summary ([23412a6](https://github.com/kishannareshpal/expo-pdf/commit/23412a6efb602afd1ec2a0a96ac348d714954f69)) by `Kishan Jadav`
+- ci: improve release process, update docs preview ([5503c3e](https://github.com/kishannareshpal/expo-pdf/commit/5503c3ec4bafe49ed7a68a2ec8ce821118ad3757)) by `Kishan Jadav`
+
+
+**Full Changelog**: https://github.com/kishannareshpal/expo-pdf/compare/v0.2.3...v0.2.4
+
+
 ## 0.2.3 - 2026-01-11
 
 _This version does not introduce any user-facing changes._

package/README.md

@@ -5,9 +5,9 @@
 
 A cross-platform, high-performance PDF viewer for React Native and Expo, built on top of native PDF rendering engines.
 
-| [iOS](./docs/demo-ios.mp4)                                                                      | [Android](./docs/demo-android.mp4)                                                              |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| <video src="https://github.com/user-attachments/assets/57000914-4f7a-4139-9079-9cfd8ece740b" /> | <video src="https://github.com/user-attachments/assets/14faf4f1-b7cc-4e8b-97a5-c0da94fd26c2" /> |
+| [iOS](./docs/preview-ios.mp4)                               | [Android](./docs/preview-android.mp4)                           |
+| ----------------------------------------------------------- | --------------------------------------------------------------- |
+| ![iOS preview](./docs/preview-ios.gif) | ![Android preview](./docs/preview-android.gif) |
 
 ## Features
 
@@ -188,7 +188,7 @@ export const App = () => {
       <td><code>uri</code></td>
       <td>Required</td>
       <td><code>string</code></td>
-      <td>PDF document URL or local file path.</td>
+      <td>PDF document local file URI.</td>
       <td>-</td>
     </tr>
     <tr>
@@ -202,7 +202,7 @@ export const App = () => {
       <td><code>pagingEnabled</code></td>
       <td>No</td>
       <td><code>boolean</code></td>
-      <td>Enables page-by-page snapping instead of free scrolling.</td>
+      <td>Enables page-by-page snapping instead of free scrolling in vertical direction by default, unless the <code>horizontal</code> prop is provided to page horizontally instead.</td>
       <td><code>false</code></td>
     </tr>
     <tr>
@@ -223,7 +223,7 @@ export const App = () => {
       <td><code>pageGap</code></td>
       <td>No</td>
       <td><code>number</code></td>
-      <td>Space (in points/pixels) between adjacent pages.</td>
+      <td>Space between adjacent pages.</td>
       <td><code>0</code></td>
     </tr>
     <tr>
@@ -237,7 +237,7 @@ export const App = () => {
       <td><code>fitMode</code></td>
       <td>No</td>
       <td><a href="#fitmode"><code>FitMode</code></a></td>
-      <td>How the document is scaled to fit within the viewer (e.g., width or height).</td>
+      <td>How the document is scaled to fit within the viewer.</td>
       <td><code>"width"</code></td>
     </tr>
     <tr>
@@ -257,14 +257,14 @@ export const App = () => {
     <tr>
       <td><code>onPageChanged</code></td>
       <td>No</td>
-      <td><a href="#onpagechangedeventpayload"><code>(OnPageChangedPayload) =&gt; void</code></a></td>
+      <td><a href="#onpagechangedeventpayload"><code>(OnPageChangedEventPayload) =&gt; void</code></a></td>
       <td>Triggered when the currently visible page index changes.</td>
       <td>-</td>
     </tr>
     <tr>
       <td><code>onError</code></td>
       <td>No</td>
-      <td><a href="#onerroreventpayload"><code>(OnErrorPayload) =&gt; void</code></a></td>
+      <td><a href="#onerroreventpayload"><code>(OnErrorEventPayload) =&gt; void</code></a></td>
       <td>Triggered when the PDF fails to load, decrypt, or render.</td>
       <td>-</td>
     </tr>
@@ -308,6 +308,44 @@ export const App = () => {
 }
 ```
 
+## Support for CSS using `uniwind` (TailwindCSS)
+
+To use `uniwind` class names, you must wrap the component with the [`withUniwind`](https://docs.uniwind.dev/api/with-uniwind#withuniwind) Higher-Order Component (HOC).
+This allows the component to process the `className` prop and convert it into native styles.
+
+```tsx
+// src/lib/styled.tsx
+import { PdfView as PdfViewPrimitive } from '@kishannareshpal/expo-pdf';
+import { ComponentProps } from 'react';
+import { withUniwind } from 'uniwind';
+
+export const StyledPdfViewPrimitive = withUniwind(PdfViewPrimitive);
+export type StyledPdfViewPrimitiveProps = ComponentProps<
+  typeof StyledPdfViewPrimitive
+>;
+```
+
+```tsx
+// src/app.tsx
+import { StyledPdfView } from '@/lib/styled';
+
+const App = () => {
+  return (
+    <StyledPdfView
+      className="flex-1 rounded-4xl bg-red-500"
+      uri="..."
+      ...
+    />
+  )
+}
+```
+
+## References
+
+### Prior art
+
+This project is inspired by [`react-native-pdf`](https://github.com/wonday/react-native-pdf) and maintained to the more modern React Native and Expo ecosystem.
+
 ## Contributing
 
 Contributions are welcome!
@@ -320,21 +358,23 @@ Please read [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 > **NOTE**
 >
-> This package follows semantic versioning with the format: `major.minor.patch`.
+> This package follows semantic versioning with the format: `major.minor.patch(-beta.n|next)`.
 >
 > - Major version: Increment when making incompatible API changes.
 > - Minor version: Increment when adding new functionality in a backward-compatible way.
 > - Patch version: Increment when fixing bugs in a backward-compatible manner.
-
-1. Bump `package.json` version using one of `npm version patch|minor|major` - this will create a new `tag`.
-2. `git push --tags` to push the new changes including the newly created tag.
-3. Navigate to [Create a New Release](https://github.com/kishannareshpal/expo-pdf/releases/new)
-4. Select the latest tag you've created above.
-5. Use the same name as the tag for the release title.
-6. Click <kbd>Generate release notes</kbd>, and/or edit the description to detail the changes.
-7. Click the green <kbd>Publish release</kbd> button.
-8. A GitHub action will automatically run to publish the new version of the package to the registry.
-   - Monitor the status at [kishannareshpal/expo-pdf/actions](https://github.com/kishannareshpal/expo-pdf/actions)
+>
+> **Only approved repository members with access to our NPM account can publish new versions.**
+
+1. Ensure all changes ready for release are merged into `main`.
+2. Go to the [`✳️ Release Package`](https://github.com/kishannareshpal/expo-pdf/actions/workflows/release.yml) workflow
+3. Click the `Run workflow` dropdown button and configure the inputs:
+   - `Dry run`: Uncheck this to perform the actual release (Default is `true` to test the build/versioning without publishing - only useful when updating the `release.yml` workflow during maintenance)
+   - `NPM tag`: Leave as `latest` for standard releases, or use `beta` / `next` for pre-releases.
+   - `Version override`: Leave as `auto` to let it automatically increment the patch version (or beta version if `beta` was specified above).
+     if you to bump the minor or major version, you must specify that here (e.g. `1.2.0` or `2.0.0`)
+4. Click the `Run workflow` button to publish 🚀
+   - Monitor the status at [**kishannareshpal/expo-pdf/actions**](https://github.com/kishannareshpal/expo-pdf/actions)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kishannareshpal/expo-pdf",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "author": "Kishan Jadav <kishan_jadav@hotmail.com> (https://github.com/kishannareshpal)",
   "repository": "https://github.com/kishannareshpal/expo-pdf",
   "main": "build/index.js",

package/release_body.txt

@@ -0,0 +1,2 @@
+
+**Full Changelog**: https://github.com/kishannareshpal/expo-pdf/compare/v0.2.4...v0.2.5