feed

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2023 License: GPL-3.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DefaultKeymap = Keymap{
	Open: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("Enter", "Open"),
	),
	ToggleFocus: key.NewBinding(
		key.WithKeys("left", "right", "h", "l"),
		key.WithHelp("←/→", "Move left/right"),
	),
	RefreshArticles: key.NewBinding(
		key.WithKeys("r", "ctrl+r"),
		key.WithHelp("r/C-r", "Refresh"),
	),
	SaveArticle: key.NewBinding(
		key.WithKeys("s", "ctrl+s"),
		key.WithHelp("s/C-s", "Save"),
	),
	DeleteFromSaved: key.NewBinding(
		key.WithKeys("d", "ctrl+d"),
		key.WithHelp("d/C-d", "Delete from saved"),
	),
	CycleSelection: key.NewBinding(
		key.WithKeys("g"),
		key.WithHelp("g", "Cycle selection"),
	),
}

DefaultKeymap contains the default key bindings for this tab

Functions

This section is empty.

Types

type ChosenFeedMsg added in v1.1.0

type ChosenFeedMsg struct {
	Name           string
	URL            string
	OldName        string
	ParentCategory string
	IsEdit         bool
}

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

type Keymap added in v1.1.0

type Keymap struct {
	Open            key.Binding
	ToggleFocus     key.Binding
	RefreshArticles key.Binding
	SaveArticle     key.Binding
	DeleteFromSaved key.Binding
	CycleSelection  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 the tab

func (Keymap) ShortHelp added in v1.1.0

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

ShortHelp returns the short help for the tab

type Model

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

Model contains the state of this tab

func New

func New(colors *theme.Colors, width, height int, title string, fetcher backend.Fetcher) Model

New creates a new feed tab with sensible defaults

func (Model) DisableDeleting added in v1.2.0

func (m Model) DisableDeleting() Model

DisableDeleting disables the deleting of the article

func (Model) DisableSaving added in v1.2.0

func (m Model) DisableSaving() Model

DisableSaving disables the saving of the article

func (Model) GetKeyBinds added in v1.2.0

func (m Model) GetKeyBinds() []key.Binding

GetKeyBinds returns the key bindings of the tab

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) Style added in v1.2.0

func (m Model) Style() tab.Style

Style returns the style of the tab

func (Model) Title

func (m Model) Title() string

Title returns the title of the tab

func (Model) Update

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

Update the variables of the tab

func (Model) View

func (m Model) View() string

View the tab

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

Popup is the feed popup where a user can create/edit a feed.

func NewPopup added in v1.1.0

func NewPopup(colors *theme.Colors, bgRaw string, width, height int,
	oldName, oldURL, parentCategory string) Popup

NewPopup returns a new feed popup.

func (Popup) Init added in v1.1.0

func (p Popup) Init() tea.Cmd

Init initializes the popup.

func (Popup) Update added in v1.1.0

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

Update updates the popup.

func (Popup) View added in v1.1.0

func (p Popup) View() string

View renders the popup.

Jump to

Keyboard shortcuts

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