Skip to main content

A Streamlit component that allows you to select from a list of options or enter a custom value.

Project description

Streamlit free text select

This component implements a selectbox that allows free text input. It is based on React-Select's 'Select' component.

Installation

pip install streamlit-free-text-select

Usage

import streamlit as st

from streamlit_free_text_select import st_free_text_select

options = ["apple", "banana", "cherry", "date", "elderberry", "fig", "grape"]

value = st_free_text_select(
    label="Free text select",
    options=options,
    index=None,
    format_func=lambda x: x.lower(),
    placeholder="Select or enter a fruit",
    disabled=False,
    delay=300,
    label_visibility="visible",
)
st.write("Free text select value:", value)

demo

Docs

Parameters

  • label : str A short label explaining to the user what this input is for.
  • options : list A list of predefined options to choose from.
  • index : int An optional index to select an option by default, defaults to None.
  • format_func : callable A callable function to format the options, defaults to None.
  • placeholder : str A string to display when the input is empty, defaults to None.
  • disabled : bool Whether the input is disabled, defaults to False.
  • delay : int The time in milliseconds to wait before updating the component, defaults to 300.
  • key : str An optional string to use as the unique key for the widget, defaults to None.
  • label_visibility : str The visibility of the label, defaults to "visible". Options are "visible", "hidden", "collapsed".

Returns str or None The value of the free text select input.

Contributors

hummerichsander
Sander Niels Hummerich
kevintcaron
Kevin Caron
LorianColtof
Lorian Coltof

Release Notes

  • 0.3.0: Enhancement: Support for disabled=True and updated styling to match streamlit-1.45.0. by kevintcaron
  • 0.2.0: Enhancement: Allow dynamic updating of the options. by LorianColtof
  • 0.1.2: Bug fix: Fixed issue with index=0 not selecting the first option.
  • 0.1.1: Added the label_visibility and index parameters.
  • 0.0.5: Initial release.

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

streamlit_free_text_select-0.3.0.tar.gz (490.6 kB view details)

Uploaded Source

Built Distribution

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

streamlit_free_text_select-0.3.0-py3-none-any.whl (494.1 kB view details)

Uploaded Python 3

File details

Details for the file streamlit_free_text_select-0.3.0.tar.gz.

File metadata

File hashes

Hashes for streamlit_free_text_select-0.3.0.tar.gz
Algorithm Hash digest
SHA256 57e820108e508a947d4bf0b76c3b9fc8d27bc56c7d08b7134724a8cefe542aa2
MD5 c68795ebb619eb7af5c616b743be746f
BLAKE2b-256 72fbd61b315c2679a32d58f741b7f05a3867e1c220fd257b84cc7403ee80fafb

See more details on using hashes here.

File details

Details for the file streamlit_free_text_select-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_free_text_select-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c3bf9159be4361e309722a05a28d727ad2974b4f43372aac88eeb2a489edb207
MD5 51761af758b5dfa135764967b438d0c8
BLAKE2b-256 027c608d50ea9ff9bec8684a1f6fbfc52df7c703282aa07f75dd98afefefb9e5

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