https://github.com/osch/lua-lwtk

Lua Widget Toolkit: implement cross platform GUI widgets in pure Lua on top of LPugl or LÖVE 2D game engine
https://github.com/osch/lua-lwtk

cairo gui love2d love2d-gui love2d-gui-library love2d-library lua lua-gui lua-library widget-toolkit

Last synced: about 2 months ago
JSON representation

Lua Widget Toolkit: implement cross platform GUI widgets in pure Lua on top of LPugl or LÖVE 2D game engine

• Host: GitHub
• URL: https://github.com/osch/lua-lwtk
• Owner: osch
• License: other
• Created: 2020-02-05T09:34:13.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-19T23:10:33.000Z (3 months ago)
• Last Synced: 2024-12-09T13:08:18.706Z (about 2 months ago)
• Topics: cairo, gui, love2d, love2d-gui, love2d-gui-library, love2d-library, lua, lua-gui, lua-library, widget-toolkit
• Language: Lua
• Homepage:
• Size: 424 KB
• Stars: 58
• Watchers: 8
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lwtk - Lua Widget Toolkit

[![Licence](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)

[![build status](https://github.com/osch/lua-lwtk/workflows/test/badge.svg)](https://github.com/osch/lua-lwtk/actions)

[![Install](https://img.shields.io/badge/Install-LuaRocks-brightgreen.svg)](https://luarocks.org/modules/osch/lwtk)

This toolkit provides a foundation for building cross platform GUI widgets in pure [Lua] 

on top of [LPugl] or within the [LÖVE] 2D game engine. For [LPugl] only the cairo drawing backend 

is supported. Further Backend abstraction and support for other backends could be possible in 

the future.

This project is work in progress. First aim is to provide a basic infrastructure

for creating and customizing widgets. Second aim is to implement a reasonable set 

of standard widgets. So far only very simple standard widgets are provided, e.g. 

`lwtk.TextInput` and `lwtk.PushButton`.

#### Supported platforms: 

   * Linux (X11)

   * Windows

   * Mac OS X

   * [LÖVE] 2D game engine

#### Further reading:

   * [Documentation](doc/README.md)

   * [Examples](./example/README.md#lwtk-examples)

## First Example

* The first example demonstrates a simple "Hello World" dialog.

  The appearance of the widgets is configured in [lwtk.DefaultStyle](src/lwtk/DefaultStyle.lua).

  The key bindings are configured in [lwtk.DefaultKeyBinding](src/lwtk/DefaultKeyBinding.lua).

     ![Screenshot example01](./example/screenshot00.png)

    ```lua

    local lwtk = require("lwtk")

    

    local Application    = lwtk.Application

    local Column         = lwtk.Column

    local Row            = lwtk.Row

    local PushButton     = lwtk.PushButton

    local TitleText      = lwtk.TitleText

    local Space          = lwtk.Space

    

    local app = Application("example")

    

    local function quit()

        app:close()

    end

    

    local win = app:newWindow {

        title = "example",

        Column {

            TitleText  { text = "Hello World!", style = { textSize = 35 } },

            Row {

                Space {},

                PushButton { text = "&OK", onClicked = quit },

                Space {}

            }

        },

    }

    win:show()

    app:runEventLoop()

    ```

[lua]:                      https://www.lua.org/

[LÖVE]:                     https://love2d.org/

[lpugl]:                    https://github.com/osch/lua-lpugl#lpugl