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. A quick example is shown below:

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.

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.2.tar.gz (408.2 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.2-py3-none-any.whl (410.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nicegui_pdf-0.0.2.tar.gz
  • Upload date:
  • Size: 408.2 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.2.tar.gz
Algorithm Hash digest
SHA256 945a1a09df89b0bb7cff3617b90b7a79689eddbb7dfe6d779567a18afb252ea0
MD5 6856ea0ff5502ddb4d966e5148dd0e63
BLAKE2b-256 83088a14277ed9cb491fb0ff1a754012a89e2a06d0708c5c013b2ebd6ff3705d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nicegui_pdf-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 410.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c46a4fc92a5023720531067e957e03d60f9a39add8747c0ab73983b293aeb10e
MD5 6de68eefeb289698ce669b1972c8c1e0
BLAKE2b-256 75960a955d896cd947ead8b6fedd4589478beade298f77ecec1d6665932222f8

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