feed

package

v1.5.1 Latest Latest Go to latest Published: Aug 5, 2023 License: GPL-3.0 Imports: 21 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 ChosenFeedMsg
type Keymap
- func (m *Keymap) SetEnabled(enabled bool)
type Model
- func New(colors *theme.Colors, width, height int, title string, fetcher backend.Fetcher) Model
type Popup
- func NewPopup(colors *theme.Colors, bgRaw string, width, height int, ...) Popup

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/ctrl+r", "Refresh"),
	),
	SaveArticle: key.NewBinding(
		key.WithKeys("s", "ctrl+s"),
		key.WithHelp("s/ctrl+s", "Save"),
	),
	DeleteFromSaved: key.NewBinding(
		key.WithKeys("d", "ctrl+d"),
		key.WithHelp("d/ctrl+d", "Delete from saved"),
	),
	CycleSelection: key.NewBinding(
		key.WithKeys("g"),
		key.WithHelp("g", "Cycle selection"),
	),
	MarkAsUnread: key.NewBinding(
		key.WithKeys("u"),
		key.WithHelp("u", "Mark as unread"),
	),
}

DefaultKeymap contains the default key bindings for this tab

Functions ¶

This section is empty.

Types ¶

type ChosenFeedMsg ¶

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

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

type Keymap ¶

type Keymap struct {
	Open            key.Binding
	ToggleFocus     key.Binding
	RefreshArticles key.Binding
	SaveArticle     key.Binding
	DeleteFromSaved key.Binding
	CycleSelection  key.Binding
	MarkAsUnread    key.Binding
}

Keymap contains the key bindings for this tab

func (*Keymap) SetEnabled ¶ added in v1.5.1

func (m *Keymap) SetEnabled(enabled bool)

SetEnabled allows to disable/enable shortcuts

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 ¶

func (m Model) DisableDeleting() Model

DisableDeleting disables the deleting of the article

func (Model) DisableSaving ¶

func (m Model) DisableSaving() Model

DisableSaving disables the saving of the article

func (Model) FullHelp ¶

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

FullHelp returns the full help for the tab

func (Model) Init ¶

func (m Model) Init() tea.Cmd

Init initializes the tab

func (Model) SetSize ¶

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

SetSize sets the dimensions of the tab

func (Model) ShortHelp ¶

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

ShortHelp returns the short help for the tab

func (Model) Style ¶

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) (tea.Model, 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 ¶

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

NewPopup returns a new feed popup.

func (p Popup) Init() tea.Cmd

Init initializes the popup.

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

Update updates the popup.

func (p Popup) View() string

View renders the popup.

Source Files ¶

View all Source files

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