Documentation
¶
Overview ¶
Package reference is the annotation-reference popup: what the swagger: directive on this line means, and what may be written under it, without leaving the file to go and look it up.
It follows the same contract as the other overlays - a concrete type the root model owns and drives, never a tea.Model. Unlike them it records nothing: there is no answer to collect, only something to read and dismiss.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Overlay ¶
type Overlay struct {
// contains filtered or unexported fields
}
Overlay is the annotation-reference modal.
The zero value is a closed overlay; the root model opens it with Show.
func (*Overlay) HandleKey ¶
HandleKey dismisses the popup.
There is nothing to navigate - it is a few lines of reference text - so every key that plausibly means "done" closes it, including the key that opened it. Everything else is swallowed, as with the other overlays: acting on a key whose effect is hidden behind the modal is worse than ignoring it.
Source Files