layout

Documentation

Index

• type Input
• type Layout
  • func ComputeLayout(cmd cmds.Command, parsedLayers *layers.ParsedLayers) (*Layout, error)
• type Link
• type Option
• type Row
• type Section
  • func NewSectionFromParameterDefinitions(pds *parameters.ParameterDefinitions, values map[string]interface{}, ...) *Section
• type SectionOption
  • func WithSectionLongDescription(desc string) SectionOption
  • func WithSectionShortDescription(desc string) SectionOption
  • func WithSectionTitle(title string) SectionOption

Types

type Input

type Input struct {
	Name string

	Label   string
	Options []Option
	Default interface{}
	Help    string

	// this can be used to customizes the HTML output
	// see https://github.com/go-go-golems/parka/issues/28
	CSS      string
	Id       string
	Classes  string
	Template string
	Type     string

	ParameterDefinition *parameters.ParameterDefinition

	Value interface{}
}

type Layout

type Layout struct {
	Sections []*Section
}

Layout might look at first similar to glazed_layout.Layout, but it is actually the parsed and computed version used to render an HTML form.

func ComputeLayout

func ComputeLayout(
	cmd cmds.Command,
	parsedLayers *layers.ParsedLayers,
) (*Layout, error)

type Link

type Link struct {
	Href  string
	Text  string
	Class string
}

type Option

type Option struct {
	Label string
	Value interface{}
}

type Row

type Row struct {
	Inputs  []Input
	Style   string
	Classes string
}

type Section

type Section struct {
	Title            string
	ShortDescription string
	LongDescription  string
	Style            string
	Classes          string
	Rows             []Row
}

func NewSectionFromParameterDefinitions

func NewSectionFromParameterDefinitions(
	pds *parameters.ParameterDefinitions,
	values map[string]interface{},
	options ...SectionOption) *Section

type SectionOption

type SectionOption func(*Section)

func WithSectionLongDescription

func WithSectionLongDescription(desc string) SectionOption

func WithSectionShortDescription

func WithSectionShortDescription(desc string) SectionOption

func WithSectionTitle

func WithSectionTitle(title string) SectionOption