How can I start to use skeleton, what is simplest way?

[canack]

Do you have any examples? What is the simplest way to start?

[github-actions]

🤖 AI Issue Assistant

Here's a comprehensive guide to getting started with the Skeleton library:

1. Installation

First, install the Skeleton library:

go get github.com/termkit/skeleton

2. Minimal Example

Here's the simplest possible Skeleton application:

package main

import (
	"github.com/termkit/skeleton"
	tea "github.com/charmbracelet/bubbletea"
)

// Simple model for a tab
type simpleModel struct {}

func (m simpleModel) Init() tea.Cmd { return nil }

func (m simpleModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
	return m, nil
}

func (m simpleModel) View() string {
	return "Hello, Skeleton!"
}

func main() {
	// Create a new Skeleton instance
	s := skeleton.NewSkeleton()

	// Add a page to the Skeleton
	s.AddPage("main", "Main Tab", simpleModel{})

	// Start the program
	if err := tea.NewProgram(s).Start(); err != nil {
		panic(err)
	}
}

3. Key Features Demonstration

package main

import (
	"fmt"
	"time"

	"github.com/termkit/skeleton"
	tea "github.com/charmbracelet/bubbletea"
)

// Enhanced model with some interactivity
type dynamicModel struct {
	count int
}

func (m *dynamicModel) Init() tea.Cmd { return nil }

func (m *dynamicModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
	switch msg := msg.(type) {
	case tea.KeyMsg:
		if msg.String() == "+" {
			m.count++
		} else if msg.String() == "-" {
			m.count--
		}
	}
	return m, nil
}

func (m *dynamicModel) View() string {
	return fmt.Sprintf("Count: %d\n\nPress + to increment\nPress - to decrement", m.count)
}

func main() {
	// Create Skeleton
	s := skeleton.NewSkeleton()

	// Add multiple pages
	s.AddPage("counter", "Counter", &dynamicModel{})
	s.AddPage("second", "Second Tab", &dynamicModel{})

	// Add widgets
	s.AddWidget("time", time.Now().Format("15:04:05"))

	// Update time widget every second
	go func() {
		for {
			time.Sleep(time.Second)
			s.UpdateWidgetValue("time", time.Now().Format("15:04:05"))
		}
	}()

	// Customize appearance
	s.SetBorderColor("#ff0000")
	s.SetActiveTabBorderColor("#00ff00")

	// Start the program
	if err := tea.NewProgram(s).Start(); err != nil {
		panic(err)
	}
}

Key Concepts

1. Creating a Skeleton: Use skeleton.NewSkeleton()
2. Adding Pages: s.AddPage(key, title, model)
3. Adding Widgets: s.AddWidget(key, value)
4. Updating Widgets: s.UpdateWidgetValue(key, newValue)
5. Customizing Appearance: Various methods like SetBorderColor(), SetActiveTabBorderColor()

Recommended Next Steps

1. Explore the examples in the repository
2. Check out the documentation
3. Experiment with different models and widgets

Pro Tips

• Always provide a unique key for pages and widgets
• Use goroutines for background updates
• Leverage Bubble Tea's model pattern for complex interactions

---

This analysis was performed by Issue Assistant. If you have any questions, please contact the repository maintainers.

[github-actions]

🏷️ AI Label Assistant

I've added the following labels to this issue:

• good first issue
• question

Explanation:
This issue is clearly a question from a new user seeking guidance on getting started with the project. The 'question' label is highly appropriate as the user is explicitly asking for examples and the simplest way to begin. The 'good first issue' label is also relevant because this appears to be an entry-level inquiry that could help newcomers understand how to use the project.

---

This label analysis was performed by Issue Assistant. If you have any questions, please contact the repository maintainers.