sharptui

A small retained-tree TUI framework for G#.

Install

Requires the .NET 10 SDK.

dotnet new install Gsharp.Templates@0.4.59
dotnet new gsharp-console -n MyApp
dotnet add MyApp/MyApp.gsproj package SharpTui.Framework --version 0.1.1
dotnet run --project MyApp/MyApp.gsproj

Example

Replace MyApp/Main.gs with:

package Demo

import SharpTui

func Main(args []string) int32 {
  let root = Column{
    Padding: CellInsets.All(1),
    GapCells: 1,
    Children: {
      Label{ Text: "sharptui" },
      Row{
        GrowWeight: 1,
        Children: {
          Box{ Width: CellLength.Cells(24), ShowBorder: true, Title: "Files" },
          MarkdownView{ GrowWeight: 1, Source: "# Hello" },
        },
      },
    },
  }
  let app = App()
  app.Run(root)
  return 0
}

Escape or Ctrl+C quits.

Documentation

• API guides and reference
• HTML manual
• Examples
• Performance
• G#

Run the bundled example picker with dotnet run -c Release --project SharpTui.Examples.gsproj. Install its Linux x64 NativeAOT build with ./tools/install-tuitool.

ChatGPT plugin

codex plugin marketplace add obselate/sharptui
codex plugin add sharptui@sharptui

See the privacy policy and terms.

License

MIT. Yoga.Net provenance is recorded in UPSTREAM.md.