paon

README

🦚 - Paon

A framework to build efficient, thread-aware, highly composable widgets based terminal user interface.

NOTE: Paon is still under active development, API is not stable.

Widgets

• Text
• TextInput
• PasswordInput
• Button
• Drop-down
• Checkbox
• Radio

Layouts

• HBox
• VBox
• Table
• ScrollView
• Form

🌠 Show your support

Please give a ⭐ if this project helped you!

📜 License

Apache2.0 © Alexandre Negrel

Documentation

Overview

Elegant TUI framework.

Index

• type Application
  • func NewApp() (*Application, error)
  • func (app *Application) DoChannel() chan<- func()
  • func (app *Application) Start(ctx context.Context, root widgets.Root) error

Types

type Application

type Application struct {
	// contains filtered or unexported fields
}

Application define a TUI application object.

func NewApp

func NewApp() (*Application, error)

NewApp returns a new Application object.

func (*Application) DoChannel

func (app *Application) DoChannel() chan<- func()

DoChannel returns a write-only channel that can be used to execute function on the main thread. Any write to the channel will enqueue a rendering of widgets tree. Note that rendering is throttled to avoid excessive rendering.

func (*Application) Start

func (app *Application) Start(ctx context.Context, root widgets.Root) error

Start starts the application console, event loop.