Skip to main content

A PDF viewer for nicegui based on pdf.js

Project description

nicegui-pdf

A NiceGUI PDF component (using pdf.js) to nicely integrate PDFs without the need for iframes without having any control on which page is shown or without the possibility to read the seelcted text. Install with

pip install nicegui-pdf

A quick example on how to use the component is given next:

from nicegui import ui, app
from nicegui_pdf.pdf_viewer import PdfViewer

# [...] 

state = {
    "current_page": 1,
}

# [...]

ui.number().bind_value(state, "current_page")

path = app.add_static_file(local_file="example/paper.pdf")
PdfViewer(path).classes("w-full").style(
    "border: solid 1px gray;"
).bind_current_page(
    state
)

Features

  • Full integration of PDF files into NiceGUI
  • Two-way binding of current_page
  • One-way binidng of num_pages, is_rendering and selected_text

A full example demonstrating all features is given in example/main.py:

table

ToDo's

  • Basic viewer
  • Text Overlay
  • Binding of pages etc
  • Binding of selected text
  • Support resizing
  • Binding on path (load new pdf document)
  • Highlight text (not 100% sure yet)
  • Push to pypi

Disclaimer

I'm neither a JS, NiceGUI or VUE expert. I simply tested a few things and found that an older version of PDF.js can be integrated as a custom NiceGUI component. Therefore, I cannot give any warranty etc. but still I'm trying to maintain this code. If you find any bugs or have feature requests, please open an issue or a pull request.

Donate

If you like it and want to buy me a coffe:

Thanks you so much!

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nicegui_pdf-0.0.4.tar.gz (408.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nicegui_pdf-0.0.4-py3-none-any.whl (410.9 kB view details)

Uploaded Python 3

File details

Details for the file nicegui_pdf-0.0.4.tar.gz.

File metadata

  • Download URL: nicegui_pdf-0.0.4.tar.gz
  • Upload date:
  • Size: 408.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for nicegui_pdf-0.0.4.tar.gz
Algorithm Hash digest
SHA256 b1c3a57b27310c0c8b7884a21f6396981e66440eac164bfadaaffa07a23a3e85
MD5 6c513d19342591ddcff935afebf9e9ab
BLAKE2b-256 150bafef19f500a2497d8017a8fc6bfa5fd8e6dde9d5586b56ff343f5af841d3

See more details on using hashes here.

File details

Details for the file nicegui_pdf-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: nicegui_pdf-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 410.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for nicegui_pdf-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 18d5d0f0f41291758b8973bd2cf7dc681dcc9769c8e9003fd20f98bc7e856a7d
MD5 720c56248d03eabf1d50ff4d724f3f86
BLAKE2b-256 dd19d505a5e28560d1ed294424572b557aa4696b0c78957fde5e4f4a88337451

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page