Skip to main content

Dataframe paginator for Streamlit

Project description

📄 Streamlit DataFrame Paginator

A lightweight Streamlit component that displays a paginated table for large DataFrames.
This helps keep your Streamlit apps responsive by showing the data in manageable pages.


✨ Features

  • 🔢 Pagination: Displays data with page navigation, improving usability for large DataFrames.

  • 🌍 Multilingual Support: You can fully customize all pagination labels to any language, including Japanese. For example:

    # Japanese
    labels = {
        "first": "最初",
        "prev": "前へ",
        "next": "次へ",
        "last": "最後",
        "displayed_record": "表示行数:"
    }
    # English
    labels={
        "first": "First",
        "prev": "Previous",
        "next": "Next",
        "last": "Last",
    }
    
  • 📊 Column Sorting: Users can click on any column header to sort the table by that column, toggling between ascending and descending order.

  • ↔️ Horizontal Scrolling: If the DataFrame contains many columns, horizontal scrolling is enabled, so you can easily view all data without layout issues.


Installation

pip install st_dataframe_paginator

Usage

import streamlit as st
from st_dataframe_paginator import st_dataframe_paginator
import pandas as pd

# Example DataFrame
df = pd.DataFrame({
    "Name": ["Alice", "Bob", "Charlie", "David", "Eve", "Frank", "Grace", "Hank"],
    "Score": [85, 92, 88, 70, 95, 60, 75, 90]
})

# Use the paginator
st_dataframe_paginator(
    df,
    page_size=3,
    page_size_options=[3, 5, 10],
    labels={
        "first": "⏮️ First",
        "prev": "◀️ Previous",
        "next": "Next ▶️",
        "last": "Last ⏭️",
    }
)

Parameters

Parameter Type Default Description
data DataFrame Required The DataFrame to paginate
page_size int 10 Number of rows per page
page_size_options list[int] [10, 20, 50] Dropdown options for page size
labels dict Optional Custom labels for navigation buttons

Screenshot

sample

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

st_dataframe_paginator-0.0.8.tar.gz (125.9 kB view details)

Uploaded Source

Built Distribution

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

st_dataframe_paginator-0.0.8-py3-none-any.whl (126.8 kB view details)

Uploaded Python 3

File details

Details for the file st_dataframe_paginator-0.0.8.tar.gz.

File metadata

  • Download URL: st_dataframe_paginator-0.0.8.tar.gz
  • Upload date:
  • Size: 125.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for st_dataframe_paginator-0.0.8.tar.gz
Algorithm Hash digest
SHA256 c5b5448dc023a74e554a723f15dd9d12f3e3df72e5686d88e414cba577ef8481
MD5 9a32bb2c26d9eb95d2facf13e9884a17
BLAKE2b-256 f2b4148e25435549a250606b43f9537a4308ef17038d69dadbf045d82ad627e2

See more details on using hashes here.

File details

Details for the file st_dataframe_paginator-0.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for st_dataframe_paginator-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1c809d2cfd88490366be06bf06693085a5403499a153612cb3d7464274ca115b
MD5 4c7988df1b8cfe9f60f96ad22a60e46e
BLAKE2b-256 7a5680675c24543c1aef1d55f9d9a5970b013cb020b3d4cc5f0a0b4066658285

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