Skip to content

SortableList API#

Bases: AnyWidget

Drag-and-drop list widget with optional add/remove/edit affordances.

Examples:

sortable = SortableList(value=["apple", "banana", "cherry"], removable=True)
sortable

Create a sortable list widget.

Parameters:

Name Type Description Default
value Sequence[str]

Initial sequence of string items.

 required
addable bool

Allow inserting new entries.

 False
removable bool

Allow deleting entries.

 False
editable bool

Enable inline text editing.

 False
label str

Optional heading shown above the list.

 ''
**kwargs Any

Forwarded to anywidget.AnyWidget.

 {}
Source code in wigglystuff/sortable_list.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def __init__(
    self,
    value: Sequence[str],
    *,
    addable: bool = False,
    removable: bool = False,
    editable: bool = False,
    label: str = "",
    **kwargs: Any,
) -> None:
    """Create a sortable list widget.

    Args:
        value: Initial sequence of string items.
        addable: Allow inserting new entries.
        removable: Allow deleting entries.
        editable: Enable inline text editing.
        label: Optional heading shown above the list.
        **kwargs: Forwarded to ``anywidget.AnyWidget``.
    """
    super().__init__(
        value=list(value),
        addable=addable,
        removable=removable,
        editable=editable,
        label=label,
        **kwargs,
    )

Synced traitlets#

Traitlet Type Notes
value list[str] Ordered list items.
addable bool Allow inserting new items.
removable bool Allow deleting items.
editable bool Allow inline edits.
label str Optional heading above the list.