Metadata-Version: 2.2
Name: hyperlink_button
Version: 0.1.3
Summary: Streamlit custom component: hyperlink-like button with stock button API
Author: OpenCode
License: MIT
Project-URL: Homepage, https://github.com/maxim-saplin/hyperlink_button
Project-URL: Source, https://github.com/maxim-saplin/hyperlink_button
Project-URL: Issues, https://github.com/maxim-saplin/hyperlink_button/issues
Keywords: streamlit,component,ui,web,python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: streamlit
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: requests; extra == "dev"
Requires-Dist: playwright; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: ruff; extra == "dev"

# hyperlink_button

`hyperlink_button` is a Streamlit custom component that looks like a hoverable text link, but behaves like `st.button`.

<img width="650" alt="image" src="https://github.com/user-attachments/assets/32e07e55-a575-4c6d-aa87-30da35915d11" />

## Install

From PyPI:
```
pip install hyperlink-button
```

From source (dev):

```bash
python -m pip install -e ".[dev]"
```

## Usage

```python
import streamlit as st
from hyperlink_button import hyperlink_button

clicked = hyperlink_button(
    "Open details",
    help="Does a normal Streamlit rerun",
    type="secondary",
)

st.write("clicked", clicked)
```

## Development

- Build frontend: `cd hyperlink_button/frontend && npm install && npm run build`
- Run demo: `streamlit run examples/demo_app.py`

Streamlit reference docs are available via the local `st_docs/` symlink.
