dash-pdf-components 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ethan Zhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# dash-pdf-components
+
+Lightweight React-PDF rendering components for Plotly Dash.
+
+```bash
+uv add dash-pdf-components
+```
+
+For the common single-page viewer, use `PDF`:
+
+```python
+import dash_pdf_components as dpc
+
+dpc.PDF(
+    id="pdf",
+    file="/assets/document.pdf",
+    pageNumber=1,
+    width=720,
+)
+```
+
+`PDF` combines document loading and one rendered page. Navigation controls can update `PDF.pageNumber`, `PDF.scale`, and `PDF.rotate`; callbacks can read `PDF.numPages`, `PDF.loadProgress`, `PDF.pageData`, `PDF.renderData`, and `PDF.errorData` from the same component.
+
+## API
+
+Use the smallest API that fits the layout:
+
+| Component | Use case |
+| --- | --- |
+| `PDF` | Default single-page viewer and callback target |
+| `Document` | Shared PDF context for custom or continuous layouts |
+| `Page` | One page inside `Document` |
+| `Thumbnail` | Clickable page preview inside `Document` |
+| `Outline` | PDF table of contents inside `Document` |
+
+`PDF` accepts the commonly used React-PDF options directly: `file`, `pageNumber`, `width`, `height`, `scale`, `rotate`, `renderTextLayer`, `renderAnnotationLayer`, `renderForms`, `loading`, `error`, and `noData`. Advanced PDF.js loading options remain available through `options`, `assetBaseUrl`, and `workerSrc`.
+
+Use the composable API only when the layout needs multiple pages, thumbnails, or an outline:
+
+```python
+dpc.Document(
+    [
+        dpc.Outline(),
+        dpc.Thumbnail(pageNumber=1, width=120),
+        dpc.Page(pageNumber=1),
+        dpc.Page(pageNumber=2),
+    ],
+    file="/assets/document.pdf",
+)
+```
+
+The package intentionally has no toolbar, theme system, locale system, or Ant Design dependency. Build navigation, zoom, rotation, and download controls with ordinary Dash components. See [`usage.py`](usage.py) for a complete example.
+
+React-PDF uses PDF.js internally. The matching Worker, character maps, standard fonts, WASM, ICC profiles, and annotation images load from this package by default. Set `assetBaseUrl` on `PDF` or `Document` to replace them with a version-matched CDN:
+
+```python
+dpc.PDF(
+    file="/assets/document.pdf",
+    assetBaseUrl="https://registry.npmmirror.com/pdfjs-dist/5.4.296/files/",
+)
+```
+
+`workerSrc`, `imageResourcesPath`, and individual `options` values such as `cMapUrl`, `standardFontDataUrl`, `wasmUrl`, and `iccUrl` override the defaults. These options are also available on `Document`.
+
+Internal PDF links navigate automatically. `PDF` and a single rendered `Page` switch to the destination page, while documents rendering multiple pages scroll to the mounted destination. `itemClickData` remains available for observing navigation.
+
+## Development
+
+```bash
+pnpm install
+uv sync
+pnpm build
+uv build --no-sources
+```