https://github.com/akascape/ctkpdfviewer
A simple yet powerfull pdf viewer for customtkinter! (extension/add-on)
https://github.com/akascape/ctkpdfviewer
customtkinter customtkinter-widgets pdf-document pdf-viewer tkinter tkinter-graphic-interface tkinter-gui tkinter-python
Last synced: 2 months ago
JSON representation
A simple yet powerfull pdf viewer for customtkinter! (extension/add-on)
- Host: GitHub
- URL: https://github.com/akascape/ctkpdfviewer
- Owner: Akascape
- License: mit
- Created: 2023-05-31T15:07:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-30T18:48:22.000Z (about 1 year ago)
- Last Synced: 2024-05-21T03:35:37.380Z (about 1 year ago)
- Topics: customtkinter, customtkinter-widgets, pdf-document, pdf-viewer, tkinter, tkinter-graphic-interface, tkinter-gui, tkinter-python
- Language: Python
- Homepage:
- Size: 23.4 KB
- Stars: 33
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CTkPDFViewer
A simple yet powerfull pdf viewer widget for customtkinter! This can be helpful for adding **documentation (in the form of PDF)** inside your application.
Users can quicky view the offline copy of your documentation.
## Features
- load pdf with ease
- configure page width and height
- scrollable pages
- configurable options
## Installation
### [
](https://github.com/Akascape/CTkPDFViewer/archive/refs/heads/main.zip)
**Requirements**
- [PyMuPDF](https://pypi.org/project/PyMuPDF/) `pip install PyMuPDF`
**Download the source code, paste the `CTkPDFViewer` folder in the directory where your program is present.**
## Usage
### CTkPDFViewer
```python
import customtkinter
from CTkPDFViewer import *
root = customtkinter.CTk()
root.geometry("700x600")
pdf_frame = CTkPDFViewer(root, file="my_file.pdf")
pdf_frame.pack(fill="both", expand=True, padx=10, pady=10)
root.mainloop()
```
### CTkPDFViewerNavigate
```python
import customtkinter
from CTkPDFViewer import *
root = customtkinter.CTk()
root.geometry("700x600")
pdf_frame = CTkPDFViewerNavigate(root, file="my_file.pdf")
pdf_frame.pack(fill="both", expand=True, padx=10, pady=10)
root.mainloop()
```
## Arguments
| Parameter | Description |
|-----------| ------------|
| **master** | parent widget |
| **file** | the PDF file you want to view |
| page_width | **optional**, change the width of the pages |
| page_height | **optional**, change the height of the pages |
| page_separation_height | change the _pady_ between the pages |
| **other frame parameters | _All other ctkscrollable frame parameters can be passed_ |
You can also change all these parameters using the `.configure()` method. Eg: `pdf_frame.configure(file="new_file.pdf", ...)`
That's all, hope it will help!