forms

Documentation

Index

• func Lower(_ context.Context, s string) (string, error)
• func NotEmpty(_ context.Context, s string) (string, error)
• func Strip(_ context.Context, s string) (string, error)
• type Field
  • func NewHiddenField(name string) Field
  • func NewPasswordField(name, label string) Field
  • func NewSelectField(name, label string, choices []Option) Field
  • func NewTextField(name, label string) Field
  • func (f Field) WithDescription(s string) Field
  • func (f Field) WithValidators(validators ...FieldValidatorFunc) Field
• type FieldValidatorFunc
  • func EqualTo(expected string) FieldValidatorFunc
  • func GoodQualityPassword(minScore int, dictionary []string) FieldValidatorFunc
  • func MinLength(n int) FieldValidatorFunc
  • func OneOf(choices []Option) FieldValidatorFunc
• type Form
  • func (f *Form) AddError(err error)
  • func (f *Form) Get(name string) string
  • func (f *Form) GetField(name string) Field
  • func (f *Form) ValidateOnSubmit(req *http.Request) (*Form, bool)
  • func (f *Form) WithDefaults(dflt map[string]string) *Form
• type FormValidatorFunc
  • func FormFieldsDiffer(a, b, errMsg string) FormValidatorFunc
  • func FormFieldsEqual(a, b, errMsg string) FormValidatorFunc
• type Option

Functions

func Lower

func Lower(_ context.Context, s string) (string, error)

func NotEmpty

func NotEmpty(_ context.Context, s string) (string, error)

func Strip

func Strip(_ context.Context, s string) (string, error)

Types

type Field

type Field struct {
	Name        string
	Type        string
	Label       string
	Description string

	Choices []Option
	Value   string
	Errors  []string

	Validators []FieldValidatorFunc
}

func NewHiddenField

func NewHiddenField(name string) Field

func NewPasswordField

func NewPasswordField(name, label string) Field

func NewSelectField

func NewSelectField(name, label string, choices []Option) Field

func NewTextField

func NewTextField(name, label string) Field

func (Field) WithDescription

func (f Field) WithDescription(s string) Field

func (Field) WithValidators

func (f Field) WithValidators(validators ...FieldValidatorFunc) Field

type FieldValidatorFunc

type FieldValidatorFunc func(context.Context, string) (string, error)

func EqualTo

func EqualTo(expected string) FieldValidatorFunc

func GoodQualityPassword

func GoodQualityPassword(minScore int, dictionary []string) FieldValidatorFunc

func MinLength

func MinLength(n int) FieldValidatorFunc

func OneOf

func OneOf(choices []Option) FieldValidatorFunc

type Form

type Form struct {
	Fields     []Field
	Errors     []string
	Validators []FormValidatorFunc
}

func (*Form) AddError

func (f *Form) AddError(err error)

func (*Form) Get

func (f *Form) Get(name string) string

func (*Form) GetField

func (f *Form) GetField(name string) Field

func (*Form) ValidateOnSubmit

func (f *Form) ValidateOnSubmit(req *http.Request) (*Form, bool)

func (*Form) WithDefaults

func (f *Form) WithDefaults(dflt map[string]string) *Form

type FormValidatorFunc

type FormValidatorFunc func(context.Context, *Form) error

func FormFieldsDiffer

func FormFieldsDiffer(a, b, errMsg string) FormValidatorFunc

func FormFieldsEqual

func FormFieldsEqual(a, b, errMsg string) FormValidatorFunc

type Option

type Option struct {
	Name  string
	Value string
}