types

package
v1.0.0-exp1 Latest Latest
Warning

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

Go to latest
Published: Sep 9, 2023 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CopyAction   = "copy"
	OpenAction   = "open"
	RunAction    = "run"
	ShareAction  = "share"
	PasteAction  = "paste"
	ReloadAction = "reload"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Action

type Action struct {
	Title string     `json:"title,omitempty"`
	Type  ActionType `json:"type"`
	Key   string     `json:"key,omitempty"`

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

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

	// push
	Page string `json:"page,omitempty"`

	// run
	Command *Command `json:"command,omitempty"`

	// share
	Params Params `json:"params,omitempty"`
}

func (Action) Output

func (a Action) Output(ctx context.Context) ([]byte, error)

type ActionType

type ActionType string

type Command added in v0.9.0

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

func (Command) Cmd added in v0.9.0

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

func (Command) Output added in v0.9.0

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

func (Command) Run added in v0.9.0

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

func (*Command) UnmarshalJSON added in v0.9.0

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

type Detail

type Detail struct {
	Title     string   `json:"title,omitempty"`
	Actions   []Action `json:"actions,omitempty"`
	Highlight string   `json:"highlight,omitempty"`
	Text      string   `json:"text"`
}
type DropDownItem struct {
	Title string `json:"title"`
	Value string `json:"value"`
}

type EmptyView added in v0.9.23

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

type Form

type Form struct {
	Title        string  `json:"title,omitempty"`
	SubmitAction *Action `json:"submitAction,omitempty"`
}

type FormInputType

type FormInputType string
const (
	TextInput     FormInputType = "text"
	TextAreaInput FormInputType = "textarea"
	SelectInput   FormInputType = "select"
	CheckboxInput FormInputType = "checkbox"
)

type Input added in v0.7.0

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 added in v0.9.23

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

func NewDropDown added in v0.9.23

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

func NewTextAreaInput added in v0.9.23

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

func NewTextInput added in v0.9.23

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

type List

type List struct {
	Title     string     `json:"title,omitempty"`
	EmptyView *EmptyView `json:"emptyView,omitempty"`
	Items     []ListItem `json:"items"`
}

type ListItem

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

type Params

type Params struct {
	Text  string `json:"text,omitempty"`
	Title string `json:"title,omitempty"`
	Url   string `json:"url,omitempty"`
}

type Request

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

func (Request) Do

func (r Request) Do(ctx context.Context) ([]byte, error)

func (*Request) UnmarshalJSON

func (r *Request) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

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