streamlit-sortable-multiselect 0.6.0__tar.gz → 0.7.0__tar.gz

{streamlit_sortable_multiselect-0.6.0/streamlit_sortable_multiselect.egg-info → streamlit_sortable_multiselect-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamlit-sortable-multiselect
-Version: 0.6.0
+Version: 0.7.0
 Summary: A Streamlit custom component for selecting and reordering multiple string values.
 Author: Developer
 License-Expression: MIT
@@ -72,11 +72,44 @@ selected = sortable_multiselect(
     order_colors={1: "#fee2e2", 2: "#dcfce7"},
     max_selections=3,
     max_selections_placeholder="Choose up to 3 frameworks",
+    empty_message="No frameworks selected",
+    no_options_placeholder="All frameworks selected",
+    selected_position="top",
 )
 
 st.write(selected)
 ```
 
+## Settings
+
+`sortable_multiselect` returns the selected option values as a `list[str]` in the current display order.
+
+| Argument | Type | Default | Description |
+| --- | --- | --- | --- |
+| `label` | `str` | required | Label displayed above the component. |
+| `options` | `Sequence[str \| Mapping[str, Any]]` | required | Available options. Each option can be a plain string, or a dictionary with `label`, `value`, and optional `icon_url`. Option values must be unique. |
+| `default` | `Sequence[str] \| None` | `None` | Initially selected values, in the initial order. Values must exist in `options` and must not contain duplicates. |
+| `placeholder` | `str` | `"Select..."` | Placeholder shown in the search/add input when options are available. |
+| `disabled` | `bool` | `False` | Disables searching, selecting, removing, dragging, and move buttons. |
+| `show_move_buttons` | `bool` | `True` | Shows up/down buttons on selected items. Drag sorting remains available unless `disabled=True`. |
+| `show_numbers` | `bool` | `False` | Shows 1-based position numbers before selected item labels. |
+| `base_color` | `str \| None` | `None` | Background color applied to all selected items. Accepts CSS color values such as `"#eef2ff"` or `"lightblue"`. |
+| `order_colors` | `Mapping[int, str] \| None` | `None` | Per-position selected item background colors. Keys are 1-based positions, for example `{1: "#fee2e2", 2: "#dcfce7"}`. These override `base_color` for matching positions. |
+| `max_selections` | `int \| None` | `None` | Maximum number of selected items. `None` means no limit. Use `0` to prevent any selections. |
+| `max_selections_placeholder` | `str` | `"Selection limit reached"` | Placeholder shown when `max_selections` has been reached. This takes precedence over `placeholder` and `no_options_placeholder`. |
+| `empty_message` | `str` | `"No items selected"` | Message shown where the selected list appears when no items are selected. |
+| `no_options_placeholder` | `str` | `"No more options"` | Placeholder shown when every option is already selected and there are no more options to add. |
+| `selected_position` | `str` | `"bottom"` | Position of the selected item list relative to the search/add input. Use `"bottom"` or `"top"`. |
+| `key` | `str \| None` | `None` | Optional Streamlit component key. Use this when rendering multiple sortable multiselects. |
+
+Option dictionaries use this shape:
+
+```python
+{"label": "Python", "value": "python", "icon_url": "https://www.python.org/static/favicon.ico"}
+```
+
+`icon_url` may be omitted. The returned value is always the `value`, not the display `label`.
+
 Build the frontend before packaging or using release mode:
 
 ```bash

streamlit_sortable_multiselect-0.7.0/README.md

@@ -0,0 +1,116 @@
+# streamlit-sortable-multiselect
+
+A Streamlit custom component for searching, selecting, and reordering multiple string values.
+
+## Install
+
+```bash
+python -m pip install streamlit-sortable-multiselect
+```
+
+For local development:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+For frontend development:
+
+```bash
+cd streamlit_sortable_multiselect/frontend
+npm install
+npm run dev
+```
+
+## Usage
+
+```python
+import streamlit as st
+from streamlit_sortable_multiselect import sortable_multiselect
+
+selected = sortable_multiselect(
+    "Favorite frameworks",
+    options=[
+        {"label": "Streamlit", "value": "streamlit", "icon_url": "https://streamlit.io/images/brand/streamlit-mark-color.png"},
+        {"label": "FastAPI", "value": "fastapi", "icon_url": "https://fastapi.tiangolo.com/img/favicon.png"},
+        {"label": "Django", "value": "django"},
+        {"label": "Flask", "value": "flask"},
+    ],
+    default=["streamlit"],
+    placeholder="Search frameworks...",
+    show_move_buttons=True,
+    show_numbers=True,
+    base_color="#eef2ff",
+    order_colors={1: "#fee2e2", 2: "#dcfce7"},
+    max_selections=3,
+    max_selections_placeholder="Choose up to 3 frameworks",
+    empty_message="No frameworks selected",
+    no_options_placeholder="All frameworks selected",
+    selected_position="top",
+)
+
+st.write(selected)
+```
+
+## Settings
+
+`sortable_multiselect` returns the selected option values as a `list[str]` in the current display order.
+
+| Argument | Type | Default | Description |
+| --- | --- | --- | --- |
+| `label` | `str` | required | Label displayed above the component. |
+| `options` | `Sequence[str \| Mapping[str, Any]]` | required | Available options. Each option can be a plain string, or a dictionary with `label`, `value`, and optional `icon_url`. Option values must be unique. |
+| `default` | `Sequence[str] \| None` | `None` | Initially selected values, in the initial order. Values must exist in `options` and must not contain duplicates. |
+| `placeholder` | `str` | `"Select..."` | Placeholder shown in the search/add input when options are available. |
+| `disabled` | `bool` | `False` | Disables searching, selecting, removing, dragging, and move buttons. |
+| `show_move_buttons` | `bool` | `True` | Shows up/down buttons on selected items. Drag sorting remains available unless `disabled=True`. |
+| `show_numbers` | `bool` | `False` | Shows 1-based position numbers before selected item labels. |
+| `base_color` | `str \| None` | `None` | Background color applied to all selected items. Accepts CSS color values such as `"#eef2ff"` or `"lightblue"`. |
+| `order_colors` | `Mapping[int, str] \| None` | `None` | Per-position selected item background colors. Keys are 1-based positions, for example `{1: "#fee2e2", 2: "#dcfce7"}`. These override `base_color` for matching positions. |
+| `max_selections` | `int \| None` | `None` | Maximum number of selected items. `None` means no limit. Use `0` to prevent any selections. |
+| `max_selections_placeholder` | `str` | `"Selection limit reached"` | Placeholder shown when `max_selections` has been reached. This takes precedence over `placeholder` and `no_options_placeholder`. |
+| `empty_message` | `str` | `"No items selected"` | Message shown where the selected list appears when no items are selected. |
+| `no_options_placeholder` | `str` | `"No more options"` | Placeholder shown when every option is already selected and there are no more options to add. |
+| `selected_position` | `str` | `"bottom"` | Position of the selected item list relative to the search/add input. Use `"bottom"` or `"top"`. |
+| `key` | `str \| None` | `None` | Optional Streamlit component key. Use this when rendering multiple sortable multiselects. |
+
+Option dictionaries use this shape:
+
+```python
+{"label": "Python", "value": "python", "icon_url": "https://www.python.org/static/favicon.ico"}
+```
+
+`icon_url` may be omitted. The returned value is always the `value`, not the display `label`.
+
+Build the frontend before packaging or using release mode:
+
+```bash
+cd streamlit_sortable_multiselect/frontend
+npm run build
+```
+
+Run the example app:
+
+```bash
+streamlit run examples/basic.py
+```
+
+## Release
+
+Build and check the distribution files:
+
+```bash
+cd streamlit_sortable_multiselect/frontend
+npm install
+npm run build
+cd ../..
+python -m pip install -e ".[dev]"
+python -m build
+python -m twine check dist/*
+```
+
+Upload to PyPI with an API token:
+
+```bash
+python -m twine upload dist/*
+```

{streamlit_sortable_multiselect-0.6.0 → streamlit_sortable_multiselect-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "streamlit-sortable-multiselect"
-version = "0.6.0"
+version = "0.7.0"
 description = "A Streamlit custom component for selecting and reordering multiple string values."
 readme = "README.md"
 requires-python = ">=3.9"

{streamlit_sortable_multiselect-0.6.0 → streamlit_sortable_multiselect-0.7.0}/streamlit_sortable_multiselect/__init__.py

@@ -8,7 +8,7 @@ from typing import Any, Iterable, Mapping, Sequence, cast
 
 import streamlit.components.v1 as components
 
-__version__ = "0.6.0"
+__version__ = "0.7.0"
 __all__ = ["sortable_multiselect"]
 
 _COMPONENT_NAME = "streamlit_sortable_multiselect"
@@ -107,6 +107,9 @@ def sortable_multiselect(
     order_colors: Mapping[int, str] | None = None,
     max_selections: int | None = None,
     max_selections_placeholder: str = "Selection limit reached",
+    empty_message: str = "No items selected",
+    no_options_placeholder: str = "No more options",
+    selected_position: str = "bottom",
     key: str | None = None,
 ) -> list[str]:
     """Select multiple string values and return them in user-defined order.
@@ -135,6 +138,12 @@ def sortable_multiselect(
         Maximum number of selected items. None means no limit.
     max_selections_placeholder:
         Placeholder text shown when the maximum selection count is reached.
+    empty_message:
+        Text shown when no items are selected.
+    no_options_placeholder:
+        Placeholder text shown when there are no more options to add.
+    selected_position:
+        Position of selected items relative to the select control. Use "bottom" or "top".
     key:
         Optional Streamlit component key.
     """
@@ -144,6 +153,14 @@ def sortable_multiselect(
         raise TypeError("placeholder must be a string.")
     if not isinstance(max_selections_placeholder, str):
         raise TypeError("max_selections_placeholder must be a string.")
+    if not isinstance(empty_message, str):
+        raise TypeError("empty_message must be a string.")
+    if not isinstance(no_options_placeholder, str):
+        raise TypeError("no_options_placeholder must be a string.")
+    if not isinstance(selected_position, str):
+        raise TypeError("selected_position must be a string.")
+    if selected_position not in {"bottom", "top"}:
+        raise ValueError('selected_position must be "bottom" or "top".')
     if not isinstance(disabled, bool):
         raise TypeError("disabled must be a bool.")
     if not isinstance(show_move_buttons, bool):
@@ -187,6 +204,9 @@ def sortable_multiselect(
         order_colors=order_color_values,
         max_selections=max_selection_count,
         max_selections_placeholder=max_selections_placeholder,
+        empty_message=empty_message,
+        no_options_placeholder=no_options_placeholder,
+        selected_position=selected_position,
         key=key,
         default=default_values,
     )