https://github.com/s5bug/deku

A wrapper around ncurses.cr that provides a manageable framework to build reactive UI elements.
https://github.com/s5bug/deku

Last synced: 17 days ago
JSON representation

A wrapper around ncurses.cr that provides a manageable framework to build reactive UI elements.

• Host: GitHub
• URL: https://github.com/s5bug/deku
• Owner: s5bug
• License: mit
• Created: 2017-11-14T03:28:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-14T03:41:41.000Z (about 7 years ago)
• Last Synced: 2024-11-10T16:12:41.292Z (2 months ago)
• Language: Crystal
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# deku

A wrapper around [agatan/ncurses.cr](https://github.com/agatan/ncurses.cr) that

provides a manageable framework to build reactive UI elements.

### Why the name `deku`?

The name `The Crystal UI Kit` popped into my head at some point, so I just

switched some letters around to get `DE crystal Ui Kit`.

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  deku:

    github: TsundereBug/deku

```

## Usage

```crystal

require "deku"

```

A basic popup window in the terminal:

```crystal

require "deku"

popup = Deku::UI::Popup.new(title: "Hello World", description: "This is a test popup.", buttons: {0 => "Ok"})

window = Deku::Window.init

window.add(popup)

window.run

```

## Development

TODO: Write development instructions here

## Contributing

1. Fork it ( https://github.com/TsundereBug/deku/fork )

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request

## Contributors

- [TsundereBug](https://github.com/TsundereBug) Anthony Cerruti - creator, maintainer