https://github.com/acalejos/kino_progress_bar

Seamless Progress Bar for Livebook
https://github.com/acalejos/kino_progress_bar

Last synced: 7 days ago
JSON representation

Seamless Progress Bar for Livebook

• Host: GitHub
• URL: https://github.com/acalejos/kino_progress_bar
• Owner: acalejos
• Created: 2024-03-27T01:58:42.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-12T16:24:22.000Z (3 months ago)
• Last Synced: 2024-08-12T19:00:54.441Z (3 months ago)
• Language: Elixir
• Size: 5.1 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-livebook - KinoProgressBar - Seamless Progress Bar for Livebook - _Tags: UI_  (Kinos)
• awesome-livebook - KinoProgressBar - Seamless Progress Bar for Livebook - _Tags: UI_  (Kinos)

README

        
# KinoProgressBar

KinoProgressBar is an Elixir library that provides interactive progress bars for Livebook using Kino. It allows you to easily create, update, and manage progress bars in your Livebook notebooks, enhancing the visual feedback for long-running processes or iterative tasks.

## Features

- Create customizable progress bars

- Update progress bar values and maximums dynamically

- Generate progress bars from enumerables

- Seamless integration with Livebook and Kino

## Installation

Add `kino_progress_bar` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:kino_progress_bar, "~> 0.3.0"}

  ]

end

```

## Usage

Here are some basic usage examples:

```elixir

# Create a new progress bar

progress_bar = KinoProgressBar.new(max: 100)

# Update the progress bar

KinoProgressBar.update(progress_bar, 50)

# Increment the value by 1

KinoProgressBar.increment(progress_bar)

# Decrement the value by arbitrary amount

KinoProgressBar.decrement(progress_bar, 5)

# Create a progress bar from an enumerable

1..100

|> KinoProgressBar.from_enumerable(progress_bar)

|> Enum.to_list()

```

For more detailed information and advanced usage, please refer to the HexDocs documentation.

## Documentation

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)

and published on [HexDocs](https://hexdocs.pm). Once published, the docs can

be found at .

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the LICENSE file for details.