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.6.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.6-py3-none-any.whl (126.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: st_dataframe_paginator-0.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 5c7e875e397b9dfd91bbb3addeae82f2c73988c7d1857f13722e3e2aa4b02b5e
MD5 30e75ff777021c81d9daa8016ffa035c
BLAKE2b-256 2212fdef9a453dc3a85296efdab6e5c2cb6d4dbf181581c9bc92597244767138

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for st_dataframe_paginator-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6c32f5ba4f465ee81dc057f09c4c53ce45a30570141fc73f22f9b50a245a323a
MD5 2a4c06866e20e461d9588cc8dd8811d8
BLAKE2b-256 8122c9f7b3d29d29785cb6579d0595cb4843cb3f0b2d334a299b4aac517f19ad

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