https://github.com/innerdoc/streamlit-timeline

A simple Streamlit Component to display a Timeline in Streamlit apps. It integrates Knightlab's TimelineJS.
https://github.com/innerdoc/streamlit-timeline

streamlit streamlit-component timeline timeline-analysis

Last synced: 6 days ago
JSON representation

A simple Streamlit Component to display a Timeline in Streamlit apps. It integrates Knightlab's TimelineJS.

• Host: GitHub
• URL: https://github.com/innerdoc/streamlit-timeline
• Owner: innerdoc
• License: mit
• Created: 2021-02-10T08:06:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-02-10T09:52:31.000Z (over 3 years ago)
• Last Synced: 2024-09-19T07:14:16.454Z (14 days ago)
• Topics: streamlit, streamlit-component, timeline, timeline-analysis
• Language: Python
• Homepage: https://www.innerdoc.com
• Size: 266 KB
• Stars: 128
• Watchers: 1
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![repo logo](https://github.com/innerdoc/streamlit-timeline/raw/main/component-logo.png)

# Timeline Component for Streamlit

A simple component to display a timeline in Streamlit apps. It integrates [Knightlab's TimelineJS](https://timeline.knightlab.com).

## Installation

First install Streamlit (of course!) then pip-install this library:

```bash

pip install streamlit

pip install streamlit-timeline

```

## Example

```python

# Streamlit Timeline Component Example

import streamlit as st

from streamlit_timeline import timeline

# use full page width

st.set_page_config(page_title="Timeline Example", layout="wide")

# load data

with open('example.json', "r") as f:

    data = f.read()

# render timeline

timeline(data, height=800)

```

## Parameters

The `timeline()` function accepts a string or a dict, as long as it's in the [TimelineJS json format](https://timeline.knightlab.com/docs/json-format.html). The optional heigth of the visualization is in px.

## Preview

You can also check the [preview video](https://www.youtube.com/embed/N61ed-XvPR4) or go to the demo [A History of Natural Language Processing](https://github.com/innerdoc/nlp-history-timeline).

[![timeline example](https://github.com/innerdoc/streamlit-timeline/raw/main/example.png)](https://www.youtube.com/embed/N61ed-XvPR4)