field

package

v0.4.3 Latest Latest Go to latest Published: Apr 7, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kyleu/admini

Links

Open Source Insights

Documentation ¶

Overview ¶

Package field - Content managed by Project Forge, see [projectforge.md] for details.

Index ¶

type Field
- func NewFieldByType(key string, t reflect.Type, ro bool, md *Metadata) *Field
type Fields
- func (s Fields) Get(key string) (int, *Field)
- func (s Fields) Names() []string
type Metadata

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Field ¶

type Field struct {
	Key      string         `json:"key"`
	Type     *types.Wrapped `json:"type"`
	Title    string         `json:"-"` // override only
	Plural   string         `json:"-"` // override only
	Hidden   bool           `json:"-"` // override only
	Default  any            `json:"default,omitempty"`
	ReadOnly bool           `json:"readOnly,omitempty"`
	Metadata *Metadata      `json:"metadata,omitempty"`
}

func NewFieldByType ¶

func NewFieldByType(key string, t reflect.Type, ro bool, md *Metadata) *Field

func (*Field) DefaultClean ¶

func (f *Field) DefaultClean() any

func (*Field) Description ¶

func (f *Field) Description() string

func (*Field) Name ¶

func (f *Field) Name() string

func (*Field) PluralName ¶

func (f *Field) PluralName() string

func (*Field) String ¶

func (f *Field) String() string

type Fields ¶

type Fields []*Field

func (Fields) Get ¶

func (s Fields) Get(key string) (int, *Field)

func (Fields) Names ¶

func (s Fields) Names() []string

type Metadata ¶

type Metadata struct {
	Description string   `json:"description,omitempty"`
	Comments    []string `json:"comments,omitempty"`
	Source      string   `json:"source,omitempty"`
	Line        int      `json:"line,omitempty"`
	Column      int      `json:"column,omitempty"`
}

Source Files ¶

View all Source files

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