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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: streamlit-sortable-multiselect
-Version: 0.7.6
+Version: 0.7.8
 Summary: A Streamlit custom component for selecting and reordering multiple string values.
 Author: Kentaro Aoki
 License-Expression: MIT
@@ -96,7 +96,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. Values must exist in `options` and must not contain duplicates. |
+| `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. |
 | `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`. |
@@ -108,7 +108,8 @@ st.write(selected)
 | `color_priority` | `Sequence[str] \| None` | `None` | Ranking of the color sources `"value"`, `"option"`, `"order"`, `"palette"`, and `"base"`. Omitted sources keep their default rank. |
 | `tooltip_color` | `str \| Mapping[str, str] \| None` | `None` | Color of the tooltip shown for labels that do not fit. `None` uses the built-in dark tooltip. See [Labels](#labels). |
 | `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`. |
+| `single_select_display` | `bool` | `False` | With `max_selections=1`, displays the selected item inside the search control and replaces it when another option is selected. |
+| `max_selections_placeholder` | `str` | `"Selection limit reached"` | Placeholder shown when `max_selections` has been reached. This takes precedence over `placeholder` and `no_options_placeholder`, except in single-selection display mode. |
 | `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"`. |
@@ -232,6 +233,33 @@ picks up both the background and the border, so it stays attached either way.
 `examples/tooltip_labels.py` shows the same options in a narrow list and a wide one,
 so the conditional behavior is visible side by side.
 
+## Single Selection Display
+
+Set `single_select_display=True` together with `max_selections=1` to keep the selected
+item inside the search control. The external selected-item list is not rendered in this
+mode. The item keeps its label, icon, resolved colors, optional number, and truncated
+label tooltip. Because no external selected list is rendered, `selected_position`,
+`empty_message`, and `show_move_buttons` do not affect this mode.
+
+```python
+selected = sortable_multiselect(
+    "Primary language",
+    options=[
+        {"label": "Python", "value": "python", "icon_url": "https://www.python.org/static/favicon.ico"},
+        {"label": "TypeScript", "value": "typescript"},
+        {"label": "Rust", "value": "rust"},
+    ],
+    default=["python"],
+    max_selections=1,
+    single_select_display=True,
+)
+```
+
+The input remains available after a selection. Opening the choices and selecting a new
+option replaces the current value instead of adding another one. Use the remove button
+inside the selected item to clear it. `single_select_display=True` without
+`max_selections=1` raises `ValueError`.
+
 ## API Suggestions
 
 Set `suggestions_api_url` to request suggestions as the user types. Static `options` that match the query are shown first, followed by API results. Duplicate `value` entries prefer the static option.

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

@@ -68,7 +68,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. Values must exist in `options` and must not contain duplicates. |
+| `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. |
 | `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`. |
@@ -80,7 +80,8 @@ st.write(selected)
 | `color_priority` | `Sequence[str] \| None` | `None` | Ranking of the color sources `"value"`, `"option"`, `"order"`, `"palette"`, and `"base"`. Omitted sources keep their default rank. |
 | `tooltip_color` | `str \| Mapping[str, str] \| None` | `None` | Color of the tooltip shown for labels that do not fit. `None` uses the built-in dark tooltip. See [Labels](#labels). |
 | `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`. |
+| `single_select_display` | `bool` | `False` | With `max_selections=1`, displays the selected item inside the search control and replaces it when another option is selected. |
+| `max_selections_placeholder` | `str` | `"Selection limit reached"` | Placeholder shown when `max_selections` has been reached. This takes precedence over `placeholder` and `no_options_placeholder`, except in single-selection display mode. |
 | `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"`. |
@@ -204,6 +205,33 @@ picks up both the background and the border, so it stays attached either way.
 `examples/tooltip_labels.py` shows the same options in a narrow list and a wide one,
 so the conditional behavior is visible side by side.
 
+## Single Selection Display
+
+Set `single_select_display=True` together with `max_selections=1` to keep the selected
+item inside the search control. The external selected-item list is not rendered in this
+mode. The item keeps its label, icon, resolved colors, optional number, and truncated
+label tooltip. Because no external selected list is rendered, `selected_position`,
+`empty_message`, and `show_move_buttons` do not affect this mode.
+
+```python
+selected = sortable_multiselect(
+    "Primary language",
+    options=[
+        {"label": "Python", "value": "python", "icon_url": "https://www.python.org/static/favicon.ico"},
+        {"label": "TypeScript", "value": "typescript"},
+        {"label": "Rust", "value": "rust"},
+    ],
+    default=["python"],
+    max_selections=1,
+    single_select_display=True,
+)
+```
+
+The input remains available after a selection. Opening the choices and selecting a new
+option replaces the current value instead of adding another one. Use the remove button
+inside the selected item to clear it. `single_select_display=True` without
+`max_selections=1` raises `ValueError`.
+
 ## API Suggestions
 
 Set `suggestions_api_url` to request suggestions as the user types. Static `options` that match the query are shown first, followed by API results. Duplicate `value` entries prefer the static option.

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

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

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

@@ -9,7 +9,7 @@ from urllib.parse import urlparse
 
 import streamlit.components.v1 as components
 
-__version__ = "0.7.6"
+__version__ = "0.7.8"
 __all__ = ["COLOR_FIELDS", "COLOR_SOURCES", "ColorValue", "sortable_multiselect"]
 
 _COMPONENT_NAME = "streamlit_sortable_multiselect"
@@ -296,6 +296,7 @@ def sortable_multiselect(
     base_color: ColorValue | None = None,
     order_colors: Mapping[int, ColorValue] | None = None,
     max_selections: int | None = None,
+    single_select_display: bool = False,
     max_selections_placeholder: str = "Selection limit reached",
     empty_message: str = "No items selected",
     no_options_placeholder: str = "No more options",
@@ -347,6 +348,9 @@ def sortable_multiselect(
         the top (1 is first), negative keys count from the bottom (-1 is last).
     max_selections:
         Maximum number of selected items. None means no limit.
+    single_select_display:
+        Display the selected item inside the search control and replace it when
+        another option is selected. Requires max_selections=1.
     max_selections_placeholder:
         Placeholder text shown when the maximum selection count is reached.
     empty_message:
@@ -418,6 +422,8 @@ def sortable_multiselect(
         raise TypeError("show_move_buttons must be a bool.")
     if not isinstance(show_numbers, bool):
         raise TypeError("show_numbers must be a bool.")
+    if not isinstance(single_select_display, bool):
+        raise TypeError("single_select_display must be a bool.")
 
     base_color_value = None if base_color is None else _require_color("base_color", base_color)
     tooltip_color_value = (
@@ -431,6 +437,8 @@ def sortable_multiselect(
     color_palette_values = _validate_color_palette(color_palette)
     color_priority_values = _validate_color_priority(color_priority)
     max_selection_count = _validate_max_selections(max_selections)
+    if single_select_display and max_selection_count != 1:
+        raise ValueError("single_select_display requires max_selections=1.")
     icon_size_value = _validate_icon_size(icon_size)
     options_max_height_value = _validate_options_max_height(options_max_height)
     suggestions_api_url_value = _validate_suggestions_api_url(suggestions_api_url)
@@ -508,6 +516,7 @@ def sortable_multiselect(
         color_priority=color_priority_values,
         tooltip_color=tooltip_color_value,
         max_selections=max_selection_count,
+        single_select_display=single_select_display,
         max_selections_placeholder=max_selections_placeholder,
         empty_message=empty_message,
         no_options_placeholder=no_options_placeholder,