Metadata-Version: 2.1
Name: streamlit-cardselectable
Version: 0.0.4
Summary: Card that the user can select one of the available options. It was created as an alternative to the radio button.
Home-page: https://github.com/Mathtzt/st_cardselectable
Author: Matheus Ferreira
Author-email: matheus.cn10@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: streamlit (>=0.63)

# streamlit-cardselectable: A flexible and extensible content container selectable in Streamlit! <img src="https://streamlit.io/images/brand/streamlit-mark-color.png" alt="drawing" width="40"/>
<a href="https://github.com/Mathtzt/st_cardselectable"><img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white"></a>

## Installation

```python
pip install streamlit-cardselectable
```

## Usage

Currently, there is one function defined:

`st_cardselectable()`: In this function there are some params: 

* `label`: label name.
* `options`: cards header.
* `explanation`: card text.
* `default` [optional]: index of the card that will be selected at the first moment.

## Example

### State: Initial
<img src="https://github.com/Mathtzt/st_cardselectable/raw/master/example/cards_init.png" alt="state_initial" width="max_content"/>

### State: Selected
<img src="https://github.com/Mathtzt/st_cardselectable/raw/master/example/card_selected.png" alt="drawing" width="max_content"/>

