A simple component to display annotated text in Streamlit apps. For example:
First install Streamlit (of course!) then pip-install this library:
pip install streamlit
pip install st-annotated-text
import streamlit as st
from annotated_text import annotated_text
"""
# Annotated text example
Below is an example of how to use the annotated_text function:
"""
annotated_text(
"This ",
("is", "verb", "#8ef"),
" some ",
("annotated", "adj", "#faa"),
("text", "noun", "#afa"),
" for those of ",
("you", "pronoun", "#fea"),
" who ",
("like", "verb", "#8ef"),
" this sort of ",
("thing", "noun", "#afa"),
)
The annotated_text()
function accepts any of the following arguments:
- strings, to draw the string as-is on the screen.
- tuples of the form (main_text, annotation_text, background, color) where background and foreground colors are optional and should be an CSS-valid string such as "#aabbcc" or "rgb(10, 20, 30)"
- htbuilder.HtmlElement objects in case you want to customize
the annotations further. In particular, you can import the
annotation()
function from this module to easily produce annotations whose CSS you can customize via keyword arguments.
Just one to-do:
- Write tests! Contributions accepted ๐