category

package

v1.1.0 Latest Latest Go to latest Published: Jul 5, 2023 License: GPL-3.0 Imports: 11 Imported by: 0

Details

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

Repository

github.com/TypicalAM/goread

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type ChosenCategoryMsg
type Keymap
- func (k Keymap) FullHelp() [][]key.Binding
- func (k Keymap) ShortHelp() []key.Binding
type Model
- func New(colors colorscheme.Colorscheme, width, height int, title string, ...) Model
type Popup
- func NewPopup(colors colorscheme.Colorscheme, bgRaw string, width, height int, ...) Popup

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultKeymap = Keymap{
	CloseTab: key.NewBinding(
		key.WithKeys("c", "ctrl+w"),
		key.WithHelp("c/ctrl+w", "Close tab"),
	),
	CycleTabs: key.NewBinding(
		key.WithKeys("tab"),
		key.WithHelp("tab", "Cycle tabs"),
	),
	SelectFeed: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "Open"),
	),
	NewFeed: key.NewBinding(
		key.WithKeys("n", "ctrl+n"),
		key.WithHelp("n/ctrl+n", "New"),
	),
	EditFeed: key.NewBinding(
		key.WithKeys("e", "ctrl+e"),
		key.WithHelp("e/ctrl+e", "Edit"),
	),
	DeleteFeed: key.NewBinding(
		key.WithKeys("d", "ctrl+d"),
		key.WithHelp("d/ctrl+d", "Delete"),
	),
}

DefaultKeymap contains the default key bindings for this tab

Functions ¶

This section is empty.

Types ¶

type ChosenCategoryMsg ¶ added in v1.1.0

type ChosenCategoryMsg struct {
	Name    string
	Desc    string
	OldName string
	IsEdit  bool
}

ChosenCategoryMsg is the message displayed when a category is successfully chosen.

type Keymap ¶ added in v1.1.0

type Keymap struct {
	CloseTab   key.Binding
	CycleTabs  key.Binding
	SelectFeed key.Binding
	NewFeed    key.Binding
	EditFeed   key.Binding
	DeleteFeed key.Binding
}

Keymap contains the key bindings for this tab

func (Keymap) FullHelp ¶ added in v1.1.0

func (k Keymap) FullHelp() [][]key.Binding

FullHelp returns the full help for this tab

func (Keymap) ShortHelp ¶ added in v1.1.0

func (k Keymap) ShortHelp() []key.Binding

ShortHelp returns the short help for this tab

type Model ¶

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

Model contains the state of this tab

func New ¶

func New(colors colorscheme.Colorscheme, width, height int, title string, reader func(string) tea.Cmd) Model

New creates a new category tab with sensible defaults

func (Model) Init ¶

func (m Model) Init() tea.Cmd

Init initializes the tab

func (Model) SetSize ¶ added in v1.0.4

func (m Model) SetSize(width, height int) tab.Tab

SetSize sets the dimensions of the tab

func (Model) ShowHelp ¶ added in v1.0.3

func (m Model) ShowHelp() string

ShowHelp shows the help for this tab

func (Model) Title ¶

func (m Model) Title() string

Title returns the title of the tab

func (Model) Type ¶

func (m Model) Type() tab.Type

Type returns the type of the tab

func (Model) Update ¶

func (m Model) Update(msg tea.Msg) (tab.Tab, tea.Cmd)

Update updates the variables of the tab

func (Model) View ¶

func (m Model) View() string

View returns the view of the tab

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

Popup is the category popup where a user can create a category.

func NewPopup ¶ added in v1.1.0

func NewPopup(colors colorscheme.Colorscheme, bgRaw string, width, height int, oldName, oldDesc string) Popup

NewPopup creates a new popup window in which the user can choose a new category.

func (p Popup) Init() tea.Cmd

Init the popup window.

func (p Popup) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update the popup window.

func (p Popup) View() string

View renders the popup window.

Source Files ¶

View all Source files

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