dxui

dxui: A Declarative Desktop GUI Framework for Go

dxui is an innovative framework designed for building desktop graphical user interfaces (GUIs) using the Go programming language. With a focus on declarative programming, dxui allows developers to define user interfaces in a straightforward manner, enhancing productivity and maintainability.

Key Features

• Declarative Syntax: Build user interfaces by composing immutable View descriptions with strongly-typed properties and callbacks. The framework employs an internal retained tree to efficiently reconcile changes.
• Cgo-Free Building: Enjoy straightforward builds with no dependencies on cgo, facilitating a smoother and more consistent development experience, especially with environments set to CGO_ENABLED=0.
• On-Demand Rendering: Benefit from an event-driven loop that optimally waits during idle times, improving performance and responsiveness.
• Component Diversity: Create a range of common interface elements using a unified styling and interaction model, including inputs, buttons, tabs, and overlays.
• Customizable Themes: Leverage typed theme tokens for theming, enabling light/dark switching, customization of borders, rounded corners, shadows, and interaction states.
• Support for Larger Applications: Designed to efficiently manage larger applications, the framework allows for independent native child windows and includes features like a keyed, fixed-height virtual list for extensive data collections.
• Go-Native Resource Handling: Utilize pure-Go capabilities for text and image processing, along with individually linkable Lucide icons through github.com/dxui-org/dxui/icon.

Getting Started

Getting started with dxui is simple. It requires Go version 1.25 or newer and a native desktop environment to run GUI examples. Developers can quickly run example applications by navigating to the examples directory and executing them using go run.

Application Development Example

Here's a basic example of how to set up a simple application using dxui:

package main

import (
	"log"
	"github.com/dxui-org/dxui"
)

func main() {
	app := dxui.NewApp(dxui.AppOptions{
		Title: "Hello dxui", Width: 480, Height: 240,
	})
	name := ""

	root := func() dxui.View {
		return dxui.Box(dxui.BoxProps{
			Style: dxui.Style{Padding: dxui.Padding(24)},
			Gap:   12,
		},
			dxui.Label("What is your name?"),
			dxui.Input(dxui.InputProps{
				Key: "name", Value: name, Placeholder: "Your name",
				OnChange: dxui.Assign(&name),
			}),
			dxui.Label("Hello, " + name + "!"),
			dxui.TextButton(dxui.ButtonProps{OnPress: app.Close}, "Close"),
		)
	}

	if err := app.Run(root); err != nil {
		log.Fatal(err)
	}
}

In this example, the application greets the user based on the input they provide.

Component Overview

dxui offers a comprehensive range of components suitable for various development needs:

• Layout Components: Box, Scroll, VirtualList
• Text and Media: Text, Label, Icon, Image, Avatar
• Action Elements: Button, TextButton, ButtonGroup, InputGroup
• Form Elements: Input, Textarea, Select, Checkbox, Radio, ToggleSwitch, Slider
• Navigation Tools: Tabs, Menu, Popover, Tooltip
• Status Indicators: Badge, ProgressBar

Explore Examples

The repository contains various examples to showcase the capabilities of dxui. Developers can run specific examples to see components in action, including:

• A component catalog that demonstrates theme customization and live properties.
• A login form showcasing input handling and component interactions.
• An interactive calculator that supports light and dark themes.

Contribution Guidelines

dxui encourages contributions in the form of bug reports, documentation enhancements, and focused code contributions. For detailed development and testing, a POSIX-compatible shell with make installed is recommended to execute testing and build scripts efficiently.