Files
Buffteks-Website/streamlit-venv/lib/python3.10/site-packages/streamlit_antd_components/widgets/cascader.py
2025-01-10 21:40:35 +00:00

68 lines
2.4 KiB
Python
Executable File

#!/usr/bin/env python
# _*_coding:utf-8_*_
"""
@Time : 2023/6/7 10:23
@Author : ji hao ran
@File : cascader.py
@Project : StreamlitAntdComponents
@Software : PyCharm
"""
from ..utils import *
def cascader(
items: List[Union[str, dict, CasItem]] = None,
index: Union[int, List[int]] = None,
label: str = None,
description: str = None,
format_func: Union[Formatter, Callable] = None,
placeholder: str = 'Please choose',
color: Union[MantineColor, str] = None,
multiple: bool = False,
disabled: bool = False,
search: bool = False,
clear: bool = False,
strict: bool = False,
return_index: bool = False,
on_change: Callable = None,
args: Tuple[Any, ...] = None,
kwargs: Dict[str, Any] = None,
key=None
) -> List[Union[str, int]]:
"""antd design cascader https://ant.design/components/cascader
:param items: cascader data
:param index: default selected cascader item index
:param label: cascader label,support str and markdown str
:param description: cascader description,support str and markdown str
:param format_func: label formatter function,receive str and return str
:param placeholder: placeholder
:param color: primary color,default streamlit primary color,support mantine color, hex and rgb color
:param multiple: multiple select
:param disabled: disabled status
:param search: allow search
:param clear: add clear all button
:param strict: parent item and children item are not associated
:param return_index: if True,return item index,default return label
:param on_change: item change callback
:param args: callback args
:param kwargs: callback kwargs
:param key: component unique identifier
:return: list of selected item label or index
"""
# register callback
register(key, on_change, args, kwargs)
# parse items
items, kv = ParseItems(items, format_func).multi(field='value')
# parse index
if index is None:
index = []
# component params
kw = update_kw(locals(), items=items)
# component default
default = get_default(index, return_index, kv)
# pass component id and params to frontend
return component(id=get_func_name(), kw=kw, default=default, key=key)