streamlit-sortable-multiselect 0.7.8__tar.gz → 0.7.9__tar.gz

{streamlit_sortable_multiselect-0.7.8/streamlit_sortable_multiselect.egg-info → streamlit_sortable_multiselect-0.7.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamlit-sortable-multiselect
-Version: 0.7.8
+Version: 0.7.9
 Summary: A Streamlit custom component for selecting and reordering multiple string values.
 Author: Kentaro Aoki
 License-Expression: MIT
@@ -97,6 +97,7 @@ st.write(selected)
 | `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. Changing the values or their order replaces the current selection. Values must exist in `options` and must not contain duplicates. |
+| `default_revision` | `str \| int \| None` | `None` | Change this value to reapply `default` when its values and order are unchanged. |
 | `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`. |
@@ -129,6 +130,24 @@ st.write(selected)
 | `suggestions_error_message` | `str` | `"Failed to load suggestions"` | Message shown when the request or response cannot be processed. |
 | `key` | `str \| None` | `None` | Optional Streamlit component key. Use this when rendering multiple sortable multiselects. |
 
+To reset a component to the same `default` after the user changes its selection,
+increment or otherwise change `default_revision`:
+
+```python
+if "reset_revision" not in st.session_state:
+    st.session_state.reset_revision = 0
+
+if st.button("Reset languages"):
+    st.session_state.reset_revision += 1
+
+selected = sortable_multiselect(
+    "Languages",
+    options=["Python", "TypeScript", "Rust"],
+    default=["Python"],
+    default_revision=st.session_state.reset_revision,
+)
+```
+
 Option dictionaries use this shape:
 
 ```python

{streamlit_sortable_multiselect-0.7.8 → streamlit_sortable_multiselect-0.7.9}/README.md

@@ -69,6 +69,7 @@ st.write(selected)
 | `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. Changing the values or their order replaces the current selection. Values must exist in `options` and must not contain duplicates. |
+| `default_revision` | `str \| int \| None` | `None` | Change this value to reapply `default` when its values and order are unchanged. |
 | `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`. |
@@ -101,6 +102,24 @@ st.write(selected)
 | `suggestions_error_message` | `str` | `"Failed to load suggestions"` | Message shown when the request or response cannot be processed. |
 | `key` | `str \| None` | `None` | Optional Streamlit component key. Use this when rendering multiple sortable multiselects. |
 
+To reset a component to the same `default` after the user changes its selection,
+increment or otherwise change `default_revision`:
+
+```python
+if "reset_revision" not in st.session_state:
+    st.session_state.reset_revision = 0
+
+if st.button("Reset languages"):
+    st.session_state.reset_revision += 1
+
+selected = sortable_multiselect(
+    "Languages",
+    options=["Python", "TypeScript", "Rust"],
+    default=["Python"],
+    default_revision=st.session_state.reset_revision,
+)
+```
+
 Option dictionaries use this shape:
 
 ```python

{streamlit_sortable_multiselect-0.7.8 → streamlit_sortable_multiselect-0.7.9}/pyproject.toml

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

{streamlit_sortable_multiselect-0.7.8 → streamlit_sortable_multiselect-0.7.9}/streamlit_sortable_multiselect/__init__.py

@@ -9,7 +9,7 @@ from urllib.parse import urlparse
 
 import streamlit.components.v1 as components
 
-__version__ = "0.7.8"
+__version__ = "0.7.9"
 __all__ = ["COLOR_FIELDS", "COLOR_SOURCES", "ColorValue", "sortable_multiselect"]
 
 _COMPONENT_NAME = "streamlit_sortable_multiselect"
@@ -320,6 +320,7 @@ def sortable_multiselect(
     tooltip_color: ColorValue | None = None,
     suggestions_color_path: str | None = None,
     key: str | None = None,
+    default_revision: str | int | None = None,
 ) -> list[str]:
     """Select multiple string values and return them in user-defined order.
 
@@ -401,6 +402,8 @@ def sortable_multiselect(
         Optional dot-separated path to each suggestion's color. None disables API colors.
     key:
         Optional Streamlit component key.
+    default_revision:
+        Change this value to reapply default even when its values and order are unchanged.
     """
     if not isinstance(label, str):
         raise TypeError("label must be a string.")
@@ -424,6 +427,10 @@ def sortable_multiselect(
         raise TypeError("show_numbers must be a bool.")
     if not isinstance(single_select_display, bool):
         raise TypeError("single_select_display must be a bool.")
+    if default_revision is not None and (
+        isinstance(default_revision, bool) or not isinstance(default_revision, (str, int))
+    ):
+        raise TypeError("default_revision must be a string, an integer, or None.")
 
     base_color_value = None if base_color is None else _require_color("base_color", base_color)
     tooltip_color_value = (
@@ -535,6 +542,7 @@ def sortable_multiselect(
         suggestions_debounce_ms=suggestions_debounce_ms_value,
         suggestions_loading_message=suggestions_loading_message,
         suggestions_error_message=suggestions_error_message,
+        default_revision=default_revision,
         key=key,
         default=default_values,
     )