Metadata-Version: 2.1
Name: streamlit-antd-components-mod
Version: 0.1.5
Summary: streamlit custom components of Antd Design and Mantine, modded from jihaoran's streamlit-antd-components
Home-page: https://github.com/Cocopuffff/StreamlitAntdComponents
Author: kennethqzw
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: streamlit>=1.12.0

# Streamlit-Antd-Components-mod

[![Open in Streamlit][share_badge]][share_link]
[![GitHub][github_badge]][github_link]
[![PyPI][pypi_badge]][pypi_link]
[![download][download_badge]][download_link]

A modded library forked from the excellent Streamlit-Antd-Components project. https://github.com/nicedouble/StreamlitAntdComponents

This library provides component below:

- `buttons` A group of buttons component.
- `divider` A divider line separates different content
- `menu` A versatile menu for navigation
- `steps` A navigation bar that guides users through the steps of a task (modded to enable coloured icons in steps component)
- `cascader` Chooses cascade items in one float layer for better user experience.
- `rate` Rate component
- `switch` Switching between two states or on-off state
- `transfer` Double column transfer choice box
- `segmented` Segmented Controls.
- `tabs` A tabs component.
- `tree` A hierarchical list structure component.
- `alert` Alert component for feedback
- `result` Used to feed back the results of a series of operational tasks
- `tag` Tag for categorizing or markup
- `pagination` A long list can be divided into several pages

## Install

```shell script
pip install streamlit-antd-components-mod
```

## Quickstart

Create a list of steps,use more style params.

```python
import streamlit as st
import streamlit_antd_components_mod as sacm

items = [
    sacm.StepsItem(title='title A', description='description A', icon='check'),
    sacm.StepsItem(title='title B', description='description B', icon='circle-fill'),
    sacm.StepsItem(title='title C', description='description C', icon='x-circle'),
]
selected_step = sacm.steps(
    items=items,
    size='lg',
    color='grey',
    direction='vertical',
    icon_color_map={'check': 'green', 'circle-fill': 'yellow', 'x-circle': '#AA4A44'}
)
st.write(f'The selected step is: {selected_step}')
```

![steps](./img/steps.png)

[share_badge]: https://static.streamlit.io/badges/streamlit_badge_black_white.svg
[share_link]: https://nicedouble-streamlitantdcomponentsdemo-app-middmy.streamlit.app/
[github_badge]: https://badgen.net/badge/icon/GitHub?icon=github&color=black&label
[github_link]: https://github.com/Cocopuffff/StreamlitAntdComponents
[pypi_badge]: https://badgen.net/pypi/v/streamlit-antd-components-mod
[pypi_link]: https://pypi.org/project/streamlit-antd-components-mod/
[download_badge]: https://badgen.net/pypi/dm/streamlit-antd-components-mod
[download_link]: https://pypi.org/project/streamlit-antd-components-mod/#files
