orus-dev/osui-go
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

bug fixes and clean code

Browse Source
This commit is contained in:
selimaj-dev
2024-09-29 21:22:25 +02:00
parent e873c01e50
commit dd8f1fbc1f
14 changed files with 89 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -1,9 +1,9 @@
# osui
A Component-based TUI library written in go!
![OSUI](osui.gif)
<h1 style="text-align:center;"><img src="assets/osui.png" width="170px"></img></h1>
<h1 style="text-align:center;"></img>A Component-based TUI library written in go</h1>
<p style="text-align:center;"><img src="assets/osui.gif"></img></p>
# Hello World
```go
package main
osui.gif → assets/osui.gif
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 270 KiB

After

Width:  |  Height:  |  Size: 270 KiB

assets/osui.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

example/main.go
+4 -5
View File
@@ -25,9 +25,8 @@ func App() *PaginatorComponent {
WithPosition(0, 0, Text("This blue square is a div. A div stores multiple components into one")),
WithPosition((w-30)/2, (h-4)/2,
WithSize(30, 5,
WithStyle(&DivStyle{Outline: colors.Blue},
Div(WithPosition(4, 1, Button("Hello, World!", BtnParams{Width: 19}))),
))),
Div(WithPosition(4, 1, Button("Hello, World!").Params(BtnParams{Width: 19}))).Params(DivParams{Style: DivStyle{Outline: colors.Blue}}),
)),
WithPosition(0, h-2, Text(colors.Blue+"Navigate: Ctrl+(W/A/S/D)")),
),
@@ -41,14 +40,14 @@ func App() *PaginatorComponent {
// Page 4
Div(
WithPosition(0, 0, Text("This is a Button. To click it press Enter. "+colors.Red+colors.Bold+"NOTE: This Button is inside a div")),
WithPosition((w-20)/2, (h-3)/2, Button("This is a button", BtnParams{OnClick: func(bc *ButtonComponent) bool { return false }})),
WithPosition((w-20)/2, (h-3)/2, Button("This is a button")),
WithPosition(0, h-2, Text(colors.Blue+"Navigate: Ctrl+(W/A/S/D). Click Button: Enter")),
),
// Page 5
Div(
WithPosition(0, 0, Text("This is a Menu. It prompts you to select a item. "+colors.Red+colors.Bold+"NOTE: This Menu is inside a div")),
WithPosition(0, 2, Menu("Item 1", "Item 2", "Item 3", "Item 4", "Item 5").OnSelected(func(m *MenuComponent, b bool) {})),
WithPosition(0, 2, Menu("Item 1", "Item 2", "Item 3", "Item 4", "Item 5").Params(MenuParams{})),
WithPosition(0, h-2, Text(colors.Blue+"Navigate: Ctrl+(W/A/S/D). Navigate Menu: W/S. Select: Enter. Exit Menu: Q. ")),
),
)
osui.go
-1
View File
@@ -21,7 +21,6 @@ type Component interface {
Render() string
GetComponentData() *ComponentData
Update(string) bool
SetStyle(interface{})
}
type Screen struct {
ui/README.md
+3 -2
View File
@@ -24,8 +24,9 @@ func (h *HelloComponent) Update(key string) bool {
return false
}
func (h *HelloComponent) SetStyle(c interface{}) {
h.Style = osui.SetDefaults(c.(*HelloStyle)).(*HelloStyle)
func (b *MenuComponent) Params(param MenuParams) *MenuComponent {
b.Style = osui.SetDefaults(&param.Style).(*MenuStyle)
return b
}
func Hello(name string) *HelloComponent {
ui/button.go
+24 -30
View File
@@ -10,6 +10,13 @@ import (
"github.com/orus-dev/osui/isKey"
)
type BtnParams struct {
Style ButtonStyle
Toggle bool
OnClick func(*ButtonComponent) bool
Width int
}
type ButtonStyle struct {
Background string `default:"" type:"bg"`
Foreground string `default:"" type:"fg"`
@@ -25,12 +32,12 @@ type ButtonStyle struct {
}
type ButtonComponent struct {
Data osui.ComponentData
Style *ButtonStyle
Text string
Toggle bool
Clicked bool
OnClick func(*ButtonComponent) bool
Data osui.ComponentData
Style *ButtonStyle
Text string
Toggle bool
Clicked bool
on_click func(*ButtonComponent) bool
}
func (b *ButtonComponent) Render() string {
@@ -67,7 +74,7 @@ func (b *ButtonComponent) Render() string {
func (b *ButtonComponent) Update(key string) bool {
if isKey.Enter(key) {
if !b.OnClick(b) {
if !b.on_click(b) {
if b.Toggle {
b.Clicked = !b.Clicked
return false
@@ -85,35 +92,22 @@ func (b *ButtonComponent) GetComponentData() *osui.ComponentData {
return &b.Data
}
func (b *ButtonComponent) SetStyle(style interface{}) {
b.Style = osui.SetDefaults(style).(*ButtonStyle)
}
type BtnParams struct {
Style ButtonStyle
Toggle bool
OnClick func(*ButtonComponent) bool
Width int
}
func Button(text string, p ...BtnParams) *ButtonComponent {
if len(p) > 0 {
param := p[0]
return &ButtonComponent{Text: text, Style: osui.SetDefaults(&param.Style).(*ButtonStyle),
Data: osui.ComponentData{
Width: osui.LogicValueInt(param.Width == 0, 20, param.Width),
Height: 1,
},
OnClick: fnLogicValue(param.OnClick),
}
func (b *ButtonComponent) Params(param BtnParams) *ButtonComponent {
b.Style = osui.SetDefaults(&param.Style).(*ButtonStyle)
if param.OnClick != nil {
b.on_click = param.OnClick
}
b.Data.Width = osui.LogicValueInt(param.Width == 0, 20, param.Width)
return b
}
func Button(text string) *ButtonComponent {
return &ButtonComponent{Text: text,
Style: osui.SetDefaults(&ButtonStyle{}).(*ButtonStyle),
Data: osui.ComponentData{
Width: 20,
Height: 1,
},
OnClick: func(bc *ButtonComponent) bool { return false },
on_click: func(bc *ButtonComponent) bool { return false },
}
}
ui/div.go
+10 -7
View File
@@ -8,6 +8,12 @@ import (
"github.com/orus-dev/osui/isKey"
)
type DivParams struct {
Style DivStyle
Width int
Height int
}
type DivStyle struct {
Background string `default:"" type:"bg"`
Foreground string `default:"" type:"fg"`
@@ -82,8 +88,10 @@ func (d *DivComponent) Update(key string) bool {
return false
}
func (d *DivComponent) SetStyle(c interface{}) {
d.Style = osui.SetDefaults(c.(*DivStyle)).(*DivStyle)
func (b *DivComponent) Params(param DivParams) *DivComponent {
b.Style = osui.SetDefaults(&param.Style).(*DivStyle)
b.Data.Width = osui.LogicValueInt(param.Width == 0, 20, param.Width)
return b
}
func (d *DivComponent) updateActive(newIndex int) {
@@ -92,11 +100,6 @@ func (d *DivComponent) updateActive(newIndex int) {
}
}
func (d *DivComponent) AddTo(c *DivComponent) *DivComponent {
*c = *d
return d
}
func Div(components ...osui.Component) *DivComponent {
return &DivComponent{
Components: components,
ui/inputBox.go
+11 -2
View File
@@ -9,6 +9,12 @@ import (
"github.com/orus-dev/osui/isKey"
)
type InputBoxParams struct {
Style DivStyle
Width int
Height int
}
type InputBoxStyle struct {
Background string `default:"" type:"bg"`
Foreground string `default:"" type:"fg"`
@@ -77,8 +83,11 @@ func (s *InputBoxComponent) Update(key string) bool {
return false
}
func (d *InputBoxComponent) SetStyle(c interface{}) {
d.Style = osui.SetDefaults(c.(*InputBoxStyle)).(*InputBoxStyle)
func (b *InputBoxComponent) Params(p interface{}) *InputBoxComponent {
param := p.(InputBoxParams)
b.Style = osui.SetDefaults(&param.Style).(*InputBoxStyle)
b.Data.Width = osui.LogicValueInt(param.Width == 0, 20, param.Width)
return b
}
func InputBox(max_size uint) *InputBoxComponent {
ui/menu.go
+8 -7
View File
@@ -8,6 +8,11 @@ import (
"github.com/orus-dev/osui/isKey"
)
type MenuParams struct {
Style MenuStyle
OnSelected func(*MenuComponent, bool)
}
type MenuStyle struct {
Fg string `default:"" type:"fg"`
Bg string `default:"" type:"bg"`
@@ -74,13 +79,9 @@ func (m *MenuComponent) Update(key string) bool {
return false
}
func (m *MenuComponent) SetStyle(c interface{}) {
m.Style = osui.SetDefaults(c.(*MenuStyle)).(*MenuStyle)
}
func (m *MenuComponent) OnSelected(f func(*MenuComponent, bool)) *MenuComponent {
m.onSelected = f
return m
func (b *MenuComponent) Params(param MenuParams) *MenuComponent {
b.Style = osui.SetDefaults(&param.Style).(*MenuStyle)
return b
}
func Menu(items ...string) *MenuComponent {
ui/paginator.go
+10 -2
View File
@@ -9,6 +9,12 @@ import (
"github.com/orus-dev/osui/isKey"
)
type PaginatorParams struct {
Style DivStyle
Width int
Height int
}
type PaginatorStyle struct {
Active string `default:"\033[32m"`
Inactive string `default:""`
@@ -92,8 +98,10 @@ func (p *PaginatorComponent) updateActive(newIndex int) {
}
}
func (p *PaginatorComponent) SetStyle(c interface{}) {
p.Style = osui.SetDefaults(c.(*PaginatorStyle)).(*PaginatorStyle)
func (b *PaginatorComponent) Params(p interface{}) *PaginatorComponent {
param := p.(PaginatorParams)
b.Style = osui.SetDefaults(&param.Style).(*PaginatorStyle)
return b
}
func Paginator(pages ...osui.Component) *PaginatorComponent {
ui/text.go
-2
View File
@@ -21,8 +21,6 @@ func (t TextComponent) Render() string {
return t.Text
}
func (t *TextComponent) SetStyle(interface{}) {}
func Text(text string) *TextComponent {
return &TextComponent{Text: text}
}
ui/utils.go
+14 -27
View File
@@ -8,6 +8,20 @@ import (
"github.com/orus-dev/osui"
)
func WithPosition(x, y int, c osui.Component) osui.Component {
data := c.GetComponentData()
data.X = x
data.Y = y
return c
}
func WithSize(width, height int, c osui.Component) osui.Component {
data := c.GetComponentData()
data.Width = width
data.Height = height
return c
}
func centerText(text string, width int) string {
if len(text) > width {
return text[:width]
@@ -19,33 +33,6 @@ func centerText(text string, width int) string {
return fmt.Sprintf("%s%s%s", leftPadding, text, rightPadding)
}
func fnLogicValue(f func(*ButtonComponent) bool) func(*ButtonComponent) bool {
if f == nil {
return func(*ButtonComponent) bool { return false }
} else {
return f
}
}
func WithPosition(x, y int, c osui.Component) osui.Component {
data := c.GetComponentData()
data.X = x
data.Y = y
return c
}
func WithStyle(style interface{}, c osui.Component) osui.Component {
c.SetStyle(style)
return c
}
func WithSize(width, height int, c osui.Component) osui.Component {
data := c.GetComponentData()
data.Width = width
data.Height = height
return c
}
func findClosestComponent(a []osui.Component, i int, d string) int {
if len(a) == 0 || i < 0 || i >= len(a) {
return -1 // Invalid input
utils.go
+1 -1
View File
@@ -174,7 +174,7 @@ func LogicValueInt(b bool, _if, _else int) int {
}
func GetTerminalSize() (int, int) {
w, h, err := term.GetSize(0)
w, h, err := term.GetSize(int(os.Stdin.Fd()))
if err != nil {
panic(err)
}