field

Documentation

Index

• type Field
  • func NewField(fieldType *FieldType, name string, label string, help string, ...) (Field, error)
• type FieldType
  • func NewFieldType(name string) (*FieldType, error)
  • func (ft *FieldType) IsZero() bool
  • func (ft *FieldType) Name() string
  • func (ft *FieldType) String() string

Types

type Field

type Field interface {
	// Type defines the type of the field
	Type() *FieldType
	// Name defines the name of the field
	Name() string
	// Label defines a label suitable to be displayed to users
	Label() string
	// Help defines a text that gives hints to users
	Help() string
	// Placeholder defines a text used for placeholder attribute
	Placeholder() string
	// Rules defines a slice of rules that will be applied to check whether a value for the field is valid
	Rules() []rule.Rule
}

Field defines the configuration of a single attribute of an entity

func NewField

func NewField(
	fieldType *FieldType,
	name string,
	label string,
	help string,
	placeholder string,
	rules []rule.Rule,
) (Field, error)

NewField creates a new instance of CommonField

type FieldType

type FieldType struct {
	// contains filtered or unexported fields
}

FieldType defines the type of the field

var (
	// Date defines the checkbox field
	Date *FieldType = &FieldType{"DATE"}
	// Email defines the email field
	Email *FieldType = &FieldType{"EMAIL"}
	// Mobile defines the mobile field
	Mobile *FieldType = &FieldType{"MOBILE"}
	// MultiSelection defines the multi selection field
	MultiSelection *FieldType = &FieldType{"MULTI_SELECTION"}
	// Number defines the number field
	Number *FieldType = &FieldType{"NUMBER"}
	// SingleSelection defines the single selection field
	SingleSelection *FieldType = &FieldType{"SINGLE_SELECTION"}
	// Text defines the text field
	Text *FieldType = &FieldType{"TEXT"}
)

func NewFieldType

func NewFieldType(name string) (*FieldType, error)

NewFieldType creates an instance of FieldType

func (*FieldType) IsZero

func (ft *FieldType) IsZero() bool

IsZero defines whether FieldType is empty

func (*FieldType) Name

func (ft *FieldType) Name() string

Name returns the name of the field type

func (*FieldType) String

func (ft *FieldType) String() string

String defines the string interface