Skip to content

📄  PDF Viewer

Submitted by Lukas Masuch

Summary

Display PDF documents from URLs or local files using the native browser rendering.

Functions

pdf_viewer

Display a PDF document.

Parameters:

Name Type Description Default
data str, Path, bytes, io.BytesIO, or file

The PDF to display. This can be one of the following: - A URL (string) for a hosted PDF file. - A path to a local PDF file. The path can be a str or Path object. Paths can be absolute or relative to the working directory (where you execute streamlit run). - Raw PDF data. Raw data formats must include all necessary file headers for a valid PDF document.

 required
width int or None

The width of the PDF viewer in CSS pixels. By default, this uses the full container width.

 None
height int or None

The height of the PDF viewer in CSS pixels. Defaults to 500.

 None
Source code in src/streamlit_extras/pdf_viewer/__init__.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
@extra
def pdf_viewer(
    data: PdfData, width: int | None = None, height: int | None = None
) -> None:
    """Display a PDF document.

    Args:
        data (str, Path, bytes, io.BytesIO, or file): The PDF to display. This can be one of the following:
            - A URL (string) for a hosted PDF file.
            - A path to a local PDF file. The path can be a ``str``
            or ``Path`` object. Paths can be absolute or relative to the
            working directory (where you execute ``streamlit run``).
            - Raw PDF data. Raw data formats must include all necessary file
            headers for a valid PDF document.

        width (int or None): The width of the PDF viewer in CSS pixels. By default, this uses the full
            container width.

        height (int or None): The height of the PDF viewer in CSS pixels. Defaults to 500.
    """
    # Process width and height for HTML
    width_style = f"width: {width}px;" if width is not None else "width: 100%;"
    height_style = f"height: {height}px;" if height is not None else "height: 500px;"

    # Check if data is a URL
    if isinstance(data, str) and (
        data.startswith("http://")
        or data.startswith("https://")
        # Support for pdf data urls:
        or data.startswith("data:application/pdf")
    ):
        # For URLs, use HTML directly
        pdf_url = data
    else:
        # For local files or raw data, process and store in media file manager
        coordinates = st._main._get_delta_path_str()

        # Convert data to appropriate format
        data_or_filename: Union[bytes, str, None]
        if isinstance(data, (str, bytes)):
            # Pass strings and bytes through unchanged
            data_or_filename = data
        elif isinstance(data, Path):
            data_or_filename = str(data)
        elif isinstance(data, io.BytesIO):
            data.seek(0)
            data_or_filename = data.getvalue()
        elif isinstance(data, (io.RawIOBase, io.BufferedReader)):
            data.seek(0)
            data_or_filename = data.read()

        if data_or_filename is None:
            raise RuntimeError(f"Cannot process provided data of type: {type(data)}")
        # Add to media file manager
        from streamlit.runtime import Runtime

        runtime = Runtime.instance()
        pdf_url = runtime.media_file_mgr.add(
            data_or_filename, "application/pdf", coordinates
        )

    html_content = f"""
    <iframe
        src="{pdf_url}"
        style="{width_style} {height_style}"
        type="application/pdf"
        frameborder="0"
    ></iframe>
    """

    st.markdown(html_content, unsafe_allow_html=True)

Import:

from streamlit_extras.pdf_viewer import pdf_viewer # (1)!
  1. You should add this to the top of your .py file 🛠

Examples

example

def example():
    """Example usage of the PDF viewer component."""
    pdf_viewer(
        "https://pdfobject.com/pdf/sample.pdf",
    )
Output (beta)