types

Documentation

Index

• Constants
• type Action
  • func NewCopyAction(title string, text string) Action
  • func NewOpenAction(title string, target string) Action
  • func NewPushAction(title string, page string) Action
  • func NewReloadAction() Action
  • func NewRunAction(title string, name string, args ...string) Action
• type ActionType
• type Body
  • func (b *Body) UnmarshalJSON(data []byte) error
• type Command
  • func (c Command) Cmd(ctx context.Context) *exec.Cmd
  • func (c Command) Output(ctx context.Context) ([]byte, error)
  • func (c Command) Run(ctx context.Context) error
  • func (c *Command) UnmarshalJSON(data []byte) error
• type DropDownItem
• type EmptyView
• type FormInputType
• type Input
  • func NewCheckbox(name string, title string, label string) Input
  • func NewDropDown(name string, title string, items ...DropDownItem) Input
  • func NewTextAreaInput(name string, title string, placeholder string) Input
  • func NewTextInput(name string, title string, placeholder string) Input
• type ListItem
• type Page
• type PageGenerator
  • func (p PageGenerator) MarshalJSON() ([]byte, error)
  • func (p *PageGenerator) UnmarshalJSON(data []byte) error
• type PageType
• type Request
  • func (r Request) Do() ([]byte, error)
• type TextOrCommandOrRequest
  • func (p TextOrCommandOrRequest) MarshalJSON() ([]byte, error)
  • func (p *TextOrCommandOrRequest) UnmarshalJSON(data []byte) error

Constants

const (
	CopyAction   = "copy"
	OpenAction   = "open"
	PushAction   = "push"
	RunAction    = "run"
	ExitAction   = "exit"
	PasteAction  = "paste"
	ReloadAction = "reload"
	FetchAction  = "fetch"
)

Types

type Action

type Action struct {
	Title  string     `json:"title,omitempty"`
	Type   ActionType `json:"type"`
	Key    string     `json:"key,omitempty"`
	Inputs []Input    `json:"inputs,omitempty"`

	// copy
	Text string `json:"text,omitempty"`

	// open
	Target string `json:"target,omitempty"`

	// push
	Page *PageGenerator `json:"page,omitempty"`

	// fetch
	Request *Request `json:"request,omitempty"`

	// run
	Command         *Command `json:"command,omitempty"`
	ReloadOnSuccess bool     `json:"reloadOnSuccess,omitempty"`
}

func NewCopyAction

func NewCopyAction(title string, text string) Action

func NewOpenAction

func NewOpenAction(title string, target string) Action

func NewPushAction

func NewPushAction(title string, page string) Action

func NewReloadAction

func NewReloadAction() Action

func NewRunAction

func NewRunAction(title string, name string, args ...string) Action

type ActionType

type ActionType string

type Body

type Body []byte

func (*Body) UnmarshalJSON

func (b *Body) UnmarshalJSON(data []byte) error

type Command

type Command struct {
	Name  string   `json:"name"`
	Args  []string `json:"args,omitempty"`
	Input string   `json:"input,omitempty"`
	Dir   string   `json:"dir,omitempty"`
}

func (Command) Cmd

func (c Command) Cmd(ctx context.Context) *exec.Cmd

func (Command) Output

func (c Command) Output(ctx context.Context) ([]byte, error)

func (Command) Run

func (c Command) Run(ctx context.Context) error

func (*Command) UnmarshalJSON

func (c *Command) UnmarshalJSON(data []byte) error

type DropDownItem

type DropDownItem struct {
	Title string `json:"title"`
	Value string `json:"value"`
}

type EmptyView

type EmptyView struct {
	Text    string   `json:"text,omitempty"`
	Actions []Action `json:"actions,omitempty"`
}

type FormInputType

type FormInputType string

const (
	TextFieldInput FormInputType = "textfield"
	TextAreaInput  FormInputType = "textarea"
	DropDownInput  FormInputType = "dropdown"
	CheckboxInput  FormInputType = "checkbox"
)

type Input

type Input struct {
	Name        string        `json:"name"`
	Type        FormInputType `json:"type"`
	Title       string        `json:"title"`
	Placeholder string        `json:"placeholder,omitempty"`
	Default     any           `json:"default,omitempty"`
	Optional    bool          `json:"optional,omitempty"`

	// Only for dropdown
	Items []DropDownItem `json:"items,omitempty"`

	// Only for checkbox
	Label             string `json:"label,omitempty"`
	TrueSubstitution  string `json:"trueSubstitution,omitempty"`
	FalseSubstitution string `json:"falseSubstitution,omitempty"`
}

func NewCheckbox

func NewCheckbox(name string, title string, label string) Input

func NewDropDown

func NewDropDown(name string, title string, items ...DropDownItem) Input

func NewTextAreaInput

func NewTextAreaInput(name string, title string, placeholder string) Input

func NewTextInput

func NewTextInput(name string, title string, placeholder string) Input

type ListItem

type ListItem struct {
	Id          string                  `json:"id,omitempty"`
	Title       string                  `json:"title"`
	Subtitle    string                  `json:"subtitle,omitempty"`
	Preview     *TextOrCommandOrRequest `json:"preview,omitempty"`
	Accessories []string                `json:"accessories,omitempty"`
	Actions     []Action                `json:"actions,omitempty"`
}

type Page

type Page struct {
	Type    PageType `json:"type"`
	Title   string   `json:"title,omitempty"`
	Actions []Action `json:"actions,omitempty"`

	// Detail page
	Preview *TextOrCommandOrRequest `json:"preview,omitempty"`

	// List page
	ShowPreview   bool       `json:"showPreview,omitempty"`
	OnQueryChange *Command   `json:"onQueryChange,omitempty"`
	EmptyView     *EmptyView `json:"emptyView,omitempty"`
	Items         []ListItem `json:"items,omitempty"`
}

type PageGenerator

type PageGenerator struct {
	Command *Command `json:"command,omitempty"`
	Request *Request `json:"request,omitempty"`
	Path    string   `json:"path,omitempty"`
}

func (PageGenerator) MarshalJSON

func (p PageGenerator) MarshalJSON() ([]byte, error)

func (*PageGenerator) UnmarshalJSON

func (p *PageGenerator) UnmarshalJSON(data []byte) error

type PageType

type PageType string

const (
	DetailPage PageType = "detail"
	ListPage   PageType = "list"
)

type Request

type Request struct {
	Url     string            `json:"url"`
	Method  string            `json:"method,omitempty"`
	Headers map[string]string `json:"headers,omitempty"`
	Body    Body              `json:"body,omitempty"`
}

func (Request) Do

func (r Request) Do() ([]byte, error)

type TextOrCommandOrRequest

type TextOrCommandOrRequest struct {
	Text    string   `json:"text,omitempty"`
	Command *Command `json:"command,omitempty"`
	Request *Request `json:"request,omitempty"`
}

func (TextOrCommandOrRequest) MarshalJSON

func (p TextOrCommandOrRequest) MarshalJSON() ([]byte, error)

func (*TextOrCommandOrRequest) UnmarshalJSON

func (p *TextOrCommandOrRequest) UnmarshalJSON(data []byte) error