components

package

v1.1.4 Latest Latest Go to latest Published: Mar 29, 2025 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/faelmori/xtui

Links

Open Source Insights

Documentation ¶

Index ¶

func DisplayErrorNotification(message string)
func DisplayInfoNotification(message string)
func DisplayNotification(message, messageType string)
func DisplayWarningNotification(message string)
func GetTableScreen(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) string
func NavigateAndExecuteForm(config FormConfig) (map[string]string, error)
func NavigateAndExecuteTable(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) error
func ShowForm(config FormConfig) (map[string]string, error)
func ShowFormWithNotification(config FormConfig) (map[string]string, error)
func ShowNotification(notification Notification)
func StartTableScreen(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) error
func StartTableScreenFromRenderer(k *TableRenderer) error
type FormModel
type Notification
type NotificationType
type TableRenderer
- func NewTableRenderer(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) *TableRenderer

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DisplayErrorNotification ¶ added in v1.1.2

func DisplayErrorNotification(message string)

func DisplayInfoNotification ¶ added in v1.1.2

func DisplayInfoNotification(message string)

func DisplayNotification ¶ added in v1.1.2

func DisplayNotification(message, messageType string)

func DisplayWarningNotification ¶ added in v1.1.2

func DisplayWarningNotification(message string)

func GetTableScreen ¶

func GetTableScreen(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) string

func NavigateAndExecuteForm ¶ added in v1.1.2

func NavigateAndExecuteForm(config FormConfig) (map[string]string, error)

func NavigateAndExecuteTable ¶ added in v1.1.2

func NavigateAndExecuteTable(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) error

func ShowForm ¶

func ShowForm(config FormConfig) (map[string]string, error)

func ShowFormWithNotification ¶ added in v1.1.2

func ShowFormWithNotification(config FormConfig) (map[string]string, error)

func ShowNotification ¶ added in v1.1.2

func ShowNotification(notification Notification)

func StartTableScreen ¶

func StartTableScreen(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) error

func StartTableScreenFromRenderer ¶ added in v1.1.2

func StartTableScreenFromRenderer(k *TableRenderer) error

Types ¶

type FormModel ¶

type FormModel struct {
	Title        string
	FocusIndex   int
	Inputs       []textinput.Model
	CursorMode   cursor.Mode
	Fields       []FormInputObject[any]
	ErrorMessage string
}

func (*FormModel) Init ¶

func (m *FormModel) Init() tea.Cmd

func (*FormModel) Update ¶

func (m *FormModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*FormModel) View ¶

func (m *FormModel) View() string

type Notification ¶ added in v1.1.2

type Notification struct {
	Message string
	Type    NotificationType
}

type NotificationType ¶ added in v1.1.2

type NotificationType string

const (
	Info    NotificationType = "info"
	Warning NotificationType = "warning"
	Error   NotificationType = "error"
)

type TableRenderer ¶

type TableRenderer struct {
	// contains filtered or unexported fields
}

func NewTableRenderer ¶

func NewTableRenderer(tbHandler TableDataHandler, customStyles map[string]lipgloss.Color) *TableRenderer

func (*TableRenderer) ApplyFilter ¶

func (k *TableRenderer) ApplyFilter()

func (*TableRenderer) ExportToCSV ¶

func (k *TableRenderer) ExportToCSV(filename string)

func (*TableRenderer) ExportToExcel ¶

func (k *TableRenderer) ExportToExcel(filename string)

func (*TableRenderer) ExportToJSON ¶

func (k *TableRenderer) ExportToJSON(filename string)

func (*TableRenderer) ExportToMarkdown ¶

func (k *TableRenderer) ExportToMarkdown(filename string)

func (*TableRenderer) ExportToPDF ¶

func (k *TableRenderer) ExportToPDF(filename string)

func (*TableRenderer) ExportToXML ¶

func (k *TableRenderer) ExportToXML(filename string)

func (*TableRenderer) ExportToYAML ¶

func (k *TableRenderer) ExportToYAML(filename string)

func (*TableRenderer) GetArrayMap ¶ added in v1.1.2

func (k *TableRenderer) GetArrayMap() map[string][]string

func (*TableRenderer) GetByteMap ¶ added in v1.1.2

func (k *TableRenderer) GetByteMap() map[string][]byte

func (*TableRenderer) GetCurrentPageRows ¶

func (k *TableRenderer) GetCurrentPageRows() [][]string

func (*TableRenderer) GetHashMap ¶ added in v1.1.2

func (k *TableRenderer) GetHashMap() map[string]string

func (*TableRenderer) GetHeaders ¶ added in v1.1.2

func (k *TableRenderer) GetHeaders() []string

func (*TableRenderer) GetObjectMap ¶ added in v1.1.2

func (k *TableRenderer) GetObjectMap() []map[string]string

func (*TableRenderer) GetRows ¶ added in v1.1.2

func (k *TableRenderer) GetRows() [][]string

func (*TableRenderer) Init ¶

func (k *TableRenderer) Init() tea.Cmd

func (*TableRenderer) RowsNavigate ¶

func (k *TableRenderer) RowsNavigate(direction string) error

func (*TableRenderer) SortRows ¶

func (k *TableRenderer) SortRows()

func (*TableRenderer) ToggleColumnVisibility ¶ added in v1.1.2

func (k *TableRenderer) ToggleColumnVisibility()

func (*TableRenderer) Update ¶

func (k *TableRenderer) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*TableRenderer) View ¶

func (k *TableRenderer) View() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL