Declarative GTK+ programming in Haskell
Switch branches/tags
Clone or download
owickstrom Merge pull request #20 from ludat/master
Make run return the last state of the application after exiting
Latest commit f2e9db4 Dec 16, 2018

README.md

gi-gtk-declarative

Declarative GTK+ programming in Haskell

Hackage Hackage Build Status

Motivation & Goal

Using declarative markup to construct user interfaces, in a purely functional fashion, is a great joy. Instead of imperatively building up stateful objects in IO, you construct a regular data structure describing the user interface to render.

In web development, declarative user interfaces are supported not only by HTML and related standards, but more recently also by "virtual DOM" technologies, as found in React and Elm. Web technologies have then spread to desktop applications through embedded web views, enabled by technologies like Electron.

But what about regular (non-web) GUI frameworks for desktop, like GTK+? We should be able to benefit from the declarative programming model, stealing ideas from virtual DOM implementations and web front end frameworks, while using the battle-tested native GUI technologies on the desktop.

This is the goal of gi-gtk-declarative; a declarative and purely functional programming model for GTK+ user interfaces. The library aims to extend the haskell-gi family of packages as transparently as possible, not having to reimplement or manually wrap large parts of existing GTK+ widgets.

The Simple.App Architecture

In addition to gi-gtk-declarative (the markup library), there's an even more experimental application architecture in the style of Pux, in gi-gtk-declarative-app-simple. You might use it if you don't want to set up your own main loop with gi-gtk, and figure out how all of that works.

Examples

There are some examples in examples/, using the GI.Gtk.Declarative.App.Simple architecture, which also showcase GI.Gtk.Declarative (the markup library.)

As an example, to run the examples/Hello.hs example, follow these steps (assuming you have a recent version of Cabal):

cabal new-run example Hello

You might also build in a Cabal sandbox, using Stack, or with Nix.

Status

EXPERIMENTAL! Do not bet your business on this quite yet.

Requirements

Follow the installation instructions at haskell-gi to make sure you have the required GObject and GTK+ libraries installed.

As this package relies heavily on OverloadedLabels and the haskell-gi-overloading functionality, the restrictions apply as described in the haskell-gi package documentation, i.e. you cannot compile this package with GHC 8.2.x.

License

Copyright 2018 Ⓒ Oskar Wickström

Mozilla Public License Version 2.0