Categorygithub.com/epiclabs-io/winman
modulepackage
0.0.0-20220901164457-3d8c4b3ae090
Repository: https://github.com/epiclabs-io/winman.git
Documentation: pkg.go.dev

# README

Winman - go Window Manager for terminal UIs

Build Status Go Report Godoc Reference

Winman is a basic yet powerful window manager in go for terminal-based user interfaces that plugs into tview.

Screenshot

It supports floating windows that can be dragged, resized and maximized. Windows can have buttons on the title bar, for example to close them, help commands or maximize / minimize.

Windows can also be modal, meaning that other windows don't receive input while a modal window is on top. You can control whether the user can drag or resize windows around the screen.

Windows can overlap each other by setting their Z-index. Any tview.Primitive can be added to a window, thus you can combine with any other existing tview widget! Check tview for a complete list of available widgets you can use.

Installation

go get github.com/epiclabs-io/winman

Hello world

package main

import (
	"github.com/epiclabs-io/winman"
	"github.com/rivo/tview"
)

func main() {

	app := tview.NewApplication()
	wm := winman.NewWindowManager()

	content := tview.NewTextView().
		SetText("Hello, world!").       // set content of the text view
		SetTextAlign(tview.AlignCenter) // align text to the center of the text view

	window := wm.NewWindow(). // create new window and add it to the window manager
					Show().                   // make window visible
					SetRoot(content).         // have the text view above be the content of the window
					SetDraggable(true).       // make window draggable around the screen
					SetResizable(true).       // make the window resizable
					SetTitle("Hi!").          // set the window title
					AddButton(&winman.Button{ // create a button with an X to close the application
			Symbol:  'X',
			OnClick: func() { app.Stop() }, // close the application
		})

	window.SetRect(5, 5, 30, 10) // place the window

	// now, execute the application:
	if err := app.SetRoot(wm, true).EnableMouse(true).Run(); err != nil {
		panic(err)
	}
}

hello world

Documentation

Refer to https://pkg.go.dev/github.com/epiclabs-io/winman for the package's documentation. The demos directory contains a showcase demonstrating the different aspects of this library

Dependencies

This package works with tview and its dependencies.

Your Feedback

Add your issue here on GitHub. Feel free to get in touch if you have any questions.

Author(s)

This package is written and maintained by Javier Peletier (@jpeletier) - Epic Labs

# Packages

No description provided by the author

# Functions

NewClipRegion Creates a new clipped screen with the given rectangular coordinates.
NewRect instantiates a new Rect with the given coordinates.
NewWindow creates a new window.
NewWindowManager returns a ready to use window manager.

# Constants

ButtonLeft will set the button to be drawn on the left.
ButtonRight will set the button to be drawn on the right.
Different window edges.
Different window edges.
Different window edges.
Different window edges.
Different window edges.
Different window edges.
Different window edges.
WindowZBottom is used with SetZ to move a window to the bottom.
WindowZTop is used with SetZ to move a window to the top.

# Variables

MinWindowHeight sets the minimum height a window can have as part of a window manager.
MinWindowWidth sets the minimum width a window can have as part of a window manager.

# Structs

Button represents a button on the window title bar.
ClipRegion implements tcell.Screen and only allows setting content within a defined region.
Manager represents a Window Manager primitive.
Rect represents rectangular coordinates.
WindowBase defines a basic window.

# Interfaces

Window interface defines primitives that can be managed by the Window Manager.

# Type aliases

ButtonSide determines the alignment of a window button.
Stack represents a stack of unique items.
WindowEdge enumerates the different window edges and corners.