Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ObservedObserver/streamlit-shadcn-ui
Using shadcn-ui components in streamlit
https://github.com/ObservedObserver/streamlit-shadcn-ui
shadcn shadcn-ui streamlit tailwindcss
Last synced: 3 months ago
JSON representation
Using shadcn-ui components in streamlit
- Host: GitHub
- URL: https://github.com/ObservedObserver/streamlit-shadcn-ui
- Owner: ObservedObserver
- License: mit
- Created: 2023-09-30T06:33:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-08T10:24:22.000Z (9 months ago)
- Last Synced: 2024-07-04T23:51:44.469Z (7 months ago)
- Topics: shadcn, shadcn-ui, streamlit, tailwindcss
- Language: TypeScript
- Homepage: https://shadcn.streamlit.app/
- Size: 316 KB
- Stars: 641
- Watchers: 9
- Forks: 48
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ObservedObserver/streamlit-shadcn-ui - Using shadcn-ui components in streamlit (TypeScript)
README
# streamlit-shadcn-ui :construction:
[](https://pypi.org/project/streamlit-shadcn-ui/)
[](https://shadcn.streamlit.app/)
Using shadcn-ui components in streamlit
## Installation
```bash
pip install streamlit-shadcn-ui
```
example:
```py
import streamlit_shadcn_ui as ui
trigger_btn = ui.button(text="Trigger Button", key="trigger_btn")
ui.alert_dialog(show=trigger_btn, title="Alert Dialog", description="This is an alert dialog", confirm_label="OK", cancel_label="Cancel", key="alert_dialog1")
```
## Components
Check docs and compoenent examples in [](https://shadcn.streamlit.app/)
+ [x] button
+ [x] checkbox
+ [x] select
+ [x] tabs
+ [x] card
+ [x] avatar
+ [x] date_picker
+ [x] date_range_picker (date_picker with mode="range")
+ [x] table
+ [x] input
+ [x] slider
+ [x] textarea
+ [x] switch
+ [x] radio_group
+ [x] alert_dialog
+ [x] hover_card
+ [x] badges
+ [x] link_button
## One more thing
There is a new component in testing, it will allows you to nest all streamlit-shadcn-ui components together.
It will not treat each component as an independent streamlit custom component in iframe, but parse the component structure as data and render them all at once in one iframe.
example ([live demo](https://shadcn.streamlit.app/Experiment(Cool))):
```py
with ui.card(key="card1"):
with ui.card(key="card2"):
ui.element("input", key="card2_input")
ui.element("button", key="card2_btn", text="Nest Submmit", variant="outline")
ui.element("button", key="card1_btn", text="Hello World")
```
## Development Guide
There are several scripts in `scripts` folder to help you develop this project.
```sh
# For local development
./scripts/frontend.sh # frontend dev server
./scripts/dev.sh # streamlit dev server
```
This repo follows the streamlit custom component structure.
+ `./streamlit_shadcn_ui` is the python package
+ `./streamlit_shadcn_ui/components` is the frontend mono repo
+ `./streamlit_shadcn_ui/components/packages/frontend` is the custom components collection.
+ `./streamlit_shadcn_ui/components/packages/streamlit-components-lib` is a patch of streamlit-components-lib for react 18 (For now, only the react/react-dom version is changed).
+ `./streamlit_shadcn_ui/py_components` is the python level API for components.
## Reference
+ [streamlit-shadcn-ui examples and docs repo](https://github.com/ObservedObserver/steamlit-shadcn-ui-docs)
+ [Streamlit](https://streamlit.io/)
+ [shadcn-ui](https://ui.shadcn.com/)
# License
This repo is under MIT license. See [LICENSE](LICENSE) for details.
`streamlit_shadcn_ui/components/packages/streamlit-components-lib` is under its original Apache-2.0 license. It is a temporal patch for streamlit-components-lib in react 18.