Developer docs for the Streamlit Components beta (This is a publicly viewable page)

Files

Contains a wheelfile, templates to get started with, and several example components.

Contains a wheelfile, templates to get started with, and several example components.

Scope

Custom Components is a Streamlit feature that's currently in beta. It enables developers to write JavaScript and HTML "components" that can be rendered in Streamlit apps. Components can receive data from, and also send data to, Streamlit Python scripts.

What you can do

What you can't do

Setup

$ cd components_beta/template
$ python3 -m venv venv  # create new python venv
$ . venv/bin/activate   # activate the venv
$ pip install ../streamlit-0.62.1-py2.py3-none-any.whl  # install the Streamlit beta
$ cd components_beta/template/my_component/frontend
$ npm install    # Initialize the project, and install npm dependencies
$ npm run start  # Start the Webpack dev server