Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rensbreur/SwiftTUI
SwiftUI for terminal applications
https://github.com/rensbreur/SwiftTUI
swift swiftui terminal
Last synced: 3 months ago
JSON representation
SwiftUI for terminal applications
- Host: GitHub
- URL: https://github.com/rensbreur/SwiftTUI
- Owner: rensbreur
- License: mit
- Created: 2022-08-03T10:52:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T10:40:04.000Z (7 months ago)
- Last Synced: 2024-04-14T05:28:31.874Z (7 months ago)
- Topics: swift, swiftui, terminal
- Language: Swift
- Homepage:
- Size: 5.31 MB
- Stars: 893
- Watchers: 12
- Forks: 33
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftTUI
An innovative, exceptionally simple way to build text-based user interfaces.
SwiftTUI brings SwiftUI to the terminal. It provides an API similar to SwiftUI to build terminal applications with a text-based user interface.
### What is working
Many features from SwiftUI are already working:
✓ Property wrappers `@State`, `@Binding`, `@Environment` and `@ObservedObject`
✓ Stacks, `.frame()`, `.padding()`, `GeometryReader`, `@ViewBuilder`, `ForEach`, `Group`
✓ Structural identity like in SwiftUI
✓ Scrollable lists with `ScrollView`
✓ `Button`, `TextField` and moving focus with the arrow keys
✓ `Color` with ANSI, xterm and TrueColor support
✓ `Text` with bold, italic, underscore and strikethrough variants
✓ `.onAppear()`, `.border()`, `.foregroundColor()`, `.backgroundColor`
✓ Modifiers applied to all views in a collection like in SwiftUI
### Getting started
To use SwiftTUI, you need to add the SwiftTUI package dependency. Import SwiftTUI in your files, and write your views like SwiftUI views with the supported features. Then, start the terminal application using one of your views as the root view. This is the simplest SwiftTUI app you can write:
```swift
import SwiftTUI
struct MyTerminalView: View {
var body: some View {
Text("Hello, world!")
}
}
Application(rootView: MyTerminalView()).start()
```
To run your app, change to your package's directory and run it from the terminal:
```
swift run
```
For more, and to see the supported functionality, check out the [documentation](https://rensbreur.github.io/SwiftTUI/documentation/swifttui/).
### Examples
These example projects are included in the repository.
#### ToDoList ([Examples/ToDoList](Examples/ToDoList))
This is a very simple to-do list application. Use the arrow keys to move around. To complete a to-do item, select it, and then press the enter key or space bar. To add a new to-do item, move to the text field, enter a description, and press the enter key to add it to the list. Completed items are automatically removed from the list after half a second.
#### Flags ([Examples/Flags](Examples/Flags))
This is a flag editor, which you will agree to if you come from a country which has a simple flag consisting of colors stacked horizontally or vertically. Select one of the colors of the flag to change it. Use the options on the right to change the number of colors or the flag orientation.
### Showcase
Are you working on a project that's using SwiftTUI? Get in touch with me if you'd like to have it featured here.
#### soundcld
This is a TUI application for SoundCloud. It's not (yet) available publicly.
### More
See a screen recording of SwiftTUI [in action](https://www.reddit.com/r/SwiftUI/comments/wlabyn/im_making_a_version_of_swiftui_for_terminal/) on Reddit.
Learn how [the diffing works](https://rensbr.eu/blog/swiftui-diffing/) on my blog.
### Documentation
You can find generated documentation [here](https://rensbreur.github.io/SwiftTUI/documentation/swifttui/).
### Contributing
This is an open-source project, contributions are welcome! The goal of SwiftTUI is to resemble SwiftUI when it comes to both API and inner workings, unless those don't make sense for terminal applications. Features that SwiftUI lacks but that would be useful for terminal applications might better live in a seperate project.