SwiftTUI Documentation

To use SwiftTUI, create an executable Swift package and add the repository as a dependency. Use the main branch to access the latest features. Import SwiftTUI in your Swift files and define your UI using views and modifiers similar to SwiftUI.

To launch the application, use the Application struct in your main.swift file, providing a rootView and calling .start().

import SwiftTUI

struct MyTerminalView: View {
  var body: some View {
    Text("Hello, world!")
  }
}

// In main.swift
Application(
  rootView: MyTerminalView()
)
.start()

Once your application is written, you can run it from your terminal by navigating to your package's directory and using the Swift Package Manager command:

swift run

Once your application is defined, run it from your terminal emulator (such as macOS Terminal) by navigating to your package directory and executing the following command:

swift run

SwiftTUI implements many core SwiftUI concepts for the terminal environment. Supported features include:

Property Wrappers

• @State
• @Binding
• @Environment
• @ObservedObject

Layout and Structure

• Stacks (HStack/VStack)
• .frame()
• .padding()
• GeometryReader
• @ViewBuilder
• ForEach
• Group
• ScrollView for scrollable lists

UI Components

• Button
• TextField (supports moving focus with arrow keys)
• Text (supports bold, italic, underscore, and ^strikethrough^ variants)

Styling and Modifiers

• Color support for ANSI, xterm, and TrueColor
• .onAppear()
• .border()
• .foregroundColor()
• .backgroundColor()
• Modifiers applied to collections of views