Packages

Toast-style notifications for Kino-based Elixir Livebook apps.

Current section

Files

Jump to
kino_toast README.md
Raw

README.md

[![Hex.pm](https://img.shields.io/hexpm/v/kino_toast.svg)](https://hex.pm/packages/kino_toast)
[![CI](https://github.com/arosenb2/kino_toast/actions/workflows/ci.yml/badge.svg)](https://github.com/arosenb2/kino_toast/actions/workflows/ci.yml)
# Kino Toast
A Kino component that adds dismissable notifications in a Livebook Cell.
## ๐Ÿš€ Features
- Create dismissable notifications for within a Livebook Cell.
- Use built-in options or customize the notifications.
## ๐Ÿ“– Getting Started
### Requirements
- Elixir >= 1.14
- Livebook
### Try it in Livebook
Click the button below to launch the notebook in Livebook:
[![Run in Livebook](https://livebook.dev/badge/v1/blue.svg)](https://livebook.dev/run?url=https%3A%2F%2Fgithub.com%2Farosenb2%2Fkino_toast%2Fblob%2Fmain%2Fkino_toast.livemd)
### Running Locally
```bash
mix deps.get
mix run
```
Or, if youโ€™re using Livebook:
1. Open Livebook
2. Paste the notebook URL or upload it locally
## ๐Ÿค Contributing
See CONTRIBUTORS.md for contributor guidelines.
## ๐Ÿ“„ License
This project is licensed under the terms of the MIT License.