cmsv1

package
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: May 16, 2023 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Config_PublishMode_name = map[int32]string{
		0: "PUBLISH_MODE_UNSPECIFIED",
		1: "EDITORIAL_WORKFLOW",
	}
	Config_PublishMode_value = map[string]int32{
		"PUBLISH_MODE_UNSPECIFIED": 0,
		"EDITORIAL_WORKFLOW":       1,
	}
)

Enum value maps for Config_PublishMode.

View Source
var (
	Config_Slug_Encoding_name = map[int32]string{
		0: "ENCODING_UNSPECIFIED",
		1: "UNICODE",
		2: "ASCII",
	}
	Config_Slug_Encoding_value = map[string]int32{
		"ENCODING_UNSPECIFIED": 0,
		"UNICODE":              1,
		"ASCII":                2,
	}
)

Enum value maps for Config_Slug_Encoding.

View Source
var (
	MapWidget_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "POINT",
		2: "LINE_STRING",
		3: "POLYGON",
	}
	MapWidget_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"POINT":            1,
		"LINE_STRING":      2,
		"POLYGON":          3,
	}
)

Enum value maps for MapWidget_Type.

View Source
var (
	NumberWidget_ValueType_name = map[int32]string{
		0: "VALUE_TYPE_UNSPECIFIED",
		1: "INT",
		2: "FLOAT",
		3: "STRING",
	}
	NumberWidget_ValueType_value = map[string]int32{
		"VALUE_TYPE_UNSPECIFIED": 0,
		"INT":                    1,
		"FLOAT":                  2,
		"STRING":                 3,
	}
)

Enum value maps for NumberWidget_ValueType.

View Source
var (
	// $((16#$(echo einride.netlify.cms.v1.collection | sha256sum | cut -c 1-7)))
	//
	// optional einride.netlify.cms.v1.Collection collection = 73371499;
	E_Collection = &file_einride_netlify_cms_v1_annotations_proto_extTypes[1]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var (
	// $((16#$(echo einride.netlify.cms.v1.config | sha256sum | cut -c 1-7)))
	//
	// optional einride.netlify.cms.v1.Config config = 220007734;
	E_Config = &file_einride_netlify_cms_v1_annotations_proto_extTypes[0]
)

Extension fields to descriptorpb.FileOptions.

View Source
var (
	// $((16#$(echo einride.netlify.cms.v1.field | sha256sum | cut -c 1-7)))
	//
	// optional einride.netlify.cms.v1.Field field = 265097061;
	E_Field = &file_einride_netlify_cms_v1_annotations_proto_extTypes[2]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var File_einride_netlify_cms_v1_annotations_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BooleanWidget

type BooleanWidget struct {

	// Default value.
	DefaultValue bool `protobuf:"varint,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

The boolean widget translates a toggle switch input to a true/false value.

func (*BooleanWidget) Descriptor deprecated

func (*BooleanWidget) Descriptor() ([]byte, []int)

Deprecated: Use BooleanWidget.ProtoReflect.Descriptor instead.

func (*BooleanWidget) GetDefaultValue

func (x *BooleanWidget) GetDefaultValue() bool

func (*BooleanWidget) ProtoMessage

func (*BooleanWidget) ProtoMessage()

func (*BooleanWidget) ProtoReflect

func (x *BooleanWidget) ProtoReflect() protoreflect.Message

func (*BooleanWidget) Reset

func (x *BooleanWidget) Reset()

func (*BooleanWidget) String

func (x *BooleanWidget) String() string

type CodeWidget

type CodeWidget struct {

	// Default language to use.
	DefaultLanguage string `protobuf:"bytes,1,opt,name=default_language,json=defaultLanguage,proto3" json:"default_language,omitempty"`
	// Allows syntax to be changed.
	AllowLanguageSelection bool `` /* 130-byte string literal not displayed */
	// Sets key names if outputting to an object.
	Keys *CodeWidget_Keys `protobuf:"bytes,3,opt,name=keys,proto3" json:"keys,omitempty"`
	// contains filtered or unexported fields
}

The code widget provides a code editor (powered by Codemirror) with optional syntax awareness.

func (*CodeWidget) Descriptor deprecated

func (*CodeWidget) Descriptor() ([]byte, []int)

Deprecated: Use CodeWidget.ProtoReflect.Descriptor instead.

func (*CodeWidget) GetAllowLanguageSelection

func (x *CodeWidget) GetAllowLanguageSelection() bool

func (*CodeWidget) GetDefaultLanguage

func (x *CodeWidget) GetDefaultLanguage() string

func (*CodeWidget) GetKeys

func (x *CodeWidget) GetKeys() *CodeWidget_Keys

func (*CodeWidget) ProtoMessage

func (*CodeWidget) ProtoMessage()

func (*CodeWidget) ProtoReflect

func (x *CodeWidget) ProtoReflect() protoreflect.Message

func (*CodeWidget) Reset

func (x *CodeWidget) Reset()

func (*CodeWidget) String

func (x *CodeWidget) String() string

type CodeWidget_Keys

type CodeWidget_Keys struct {

	// Key name for code. Defaults to 'code'.
	Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	// Key name for lang. Defaults to 'lang'.
	Lang string `protobuf:"bytes,2,opt,name=lang,proto3" json:"lang,omitempty"`
	// contains filtered or unexported fields
}

Sets key names if outputting to an object.

func (*CodeWidget_Keys) Descriptor deprecated

func (*CodeWidget_Keys) Descriptor() ([]byte, []int)

Deprecated: Use CodeWidget_Keys.ProtoReflect.Descriptor instead.

func (*CodeWidget_Keys) GetCode

func (x *CodeWidget_Keys) GetCode() string

func (*CodeWidget_Keys) GetLang

func (x *CodeWidget_Keys) GetLang() string

func (*CodeWidget_Keys) ProtoMessage

func (*CodeWidget_Keys) ProtoMessage()

func (*CodeWidget_Keys) ProtoReflect

func (x *CodeWidget_Keys) ProtoReflect() protoreflect.Message

func (*CodeWidget_Keys) Reset

func (x *CodeWidget_Keys) Reset()

func (*CodeWidget_Keys) String

func (x *CodeWidget_Keys) String() string

type Collection

type Collection struct {

	// Unique identifier for the collection, used as the key when referenced in other contexts
	// (like the relation widget).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An entry's title when viewing a list of entries, and is used in slug creation.
	IdentifierField string `protobuf:"bytes,2,opt,name=identifier_field,json=identifierField,proto3" json:"identifier_field,omitempty"`
	// Label for the collection in the editor UI; defaults to the value of name.
	Label string `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"`
	// Singular label for certain elements in the editor; defaults to the value of label.
	LabelSingular string `protobuf:"bytes,4,opt,name=label_singular,json=labelSingular,proto3" json:"label_singular,omitempty"`
	// Optional text, displayed below the label when viewing a collection.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// Folder location.
	Folder string `protobuf:"bytes,6,opt,name=folder,proto3" json:"folder,omitempty"`
	// True allows users to create new items in the collection; defaults to false.
	Create bool `protobuf:"varint,7,opt,name=create,proto3" json:"create,omitempty"`
	// TODO.
	Format string `protobuf:"bytes,8,opt,name=format,proto3" json:"format,omitempty"`
	// TODO.
	Summary string `protobuf:"bytes,9,opt,name=summary,proto3" json:"summary,omitempty"`
	// Editor config.
	Editor *Collection_Editor `protobuf:"bytes,10,opt,name=editor,proto3" json:"editor,omitempty"`
	// Maps editor UI widgets to field-value pairs in the saved file.
	Fields []*Field `protobuf:"bytes,11,rep,name=fields,proto3" json:"fields,omitempty"`
	// Owner of the collection.
	Owner *Owner `protobuf:"bytes,12,opt,name=owner,proto3" json:"owner,omitempty"`
	// contains filtered or unexported fields
}

Netlify CMS collection config.

func (*Collection) Descriptor deprecated

func (*Collection) Descriptor() ([]byte, []int)

Deprecated: Use Collection.ProtoReflect.Descriptor instead.

func (*Collection) GetCreate

func (x *Collection) GetCreate() bool

func (*Collection) GetDescription

func (x *Collection) GetDescription() string

func (*Collection) GetEditor

func (x *Collection) GetEditor() *Collection_Editor

func (*Collection) GetFields

func (x *Collection) GetFields() []*Field

func (*Collection) GetFolder

func (x *Collection) GetFolder() string

func (*Collection) GetFormat

func (x *Collection) GetFormat() string

func (*Collection) GetIdentifierField

func (x *Collection) GetIdentifierField() string

func (*Collection) GetLabel

func (x *Collection) GetLabel() string

func (*Collection) GetLabelSingular

func (x *Collection) GetLabelSingular() string

func (*Collection) GetName

func (x *Collection) GetName() string

func (*Collection) GetOwner

func (x *Collection) GetOwner() *Owner

func (*Collection) GetSummary

func (x *Collection) GetSummary() string

func (*Collection) ProtoMessage

func (*Collection) ProtoMessage()

func (*Collection) ProtoReflect

func (x *Collection) ProtoReflect() protoreflect.Message

func (*Collection) Reset

func (x *Collection) Reset()

func (*Collection) String

func (x *Collection) String() string

type Collection_Editor

type Collection_Editor struct {

	// Set to false to disable the preview pane for this collection or file.
	Preview bool `protobuf:"varint,1,opt,name=preview,proto3" json:"preview,omitempty"`
	// contains filtered or unexported fields
}

Editor config.

func (*Collection_Editor) Descriptor deprecated

func (*Collection_Editor) Descriptor() ([]byte, []int)

Deprecated: Use Collection_Editor.ProtoReflect.Descriptor instead.

func (*Collection_Editor) GetPreview

func (x *Collection_Editor) GetPreview() bool

func (*Collection_Editor) ProtoMessage

func (*Collection_Editor) ProtoMessage()

func (*Collection_Editor) ProtoReflect

func (x *Collection_Editor) ProtoReflect() protoreflect.Message

func (*Collection_Editor) Reset

func (x *Collection_Editor) Reset()

func (*Collection_Editor) String

func (x *Collection_Editor) String() string

type ColorWidget

type ColorWidget struct {

	// Sets the default value.
	DefaultValue string `protobuf:"bytes,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// Allows manual editing of the color input value.
	AllowInput bool `protobuf:"varint,2,opt,name=allow_input,json=allowInput,proto3" json:"allow_input,omitempty"`
	// Enables alpha editing.
	EnableAlpha bool `protobuf:"varint,3,opt,name=enable_alpha,json=enableAlpha,proto3" json:"enable_alpha,omitempty"`
	// contains filtered or unexported fields
}

The color widget translates a color picker to a color string.

func (*ColorWidget) Descriptor deprecated

func (*ColorWidget) Descriptor() ([]byte, []int)

Deprecated: Use ColorWidget.ProtoReflect.Descriptor instead.

func (*ColorWidget) GetAllowInput

func (x *ColorWidget) GetAllowInput() bool

func (*ColorWidget) GetDefaultValue

func (x *ColorWidget) GetDefaultValue() string

func (*ColorWidget) GetEnableAlpha

func (x *ColorWidget) GetEnableAlpha() bool

func (*ColorWidget) ProtoMessage

func (*ColorWidget) ProtoMessage()

func (*ColorWidget) ProtoReflect

func (x *ColorWidget) ProtoReflect() protoreflect.Message

func (*ColorWidget) Reset

func (x *ColorWidget) Reset()

func (*ColorWidget) String

func (x *ColorWidget) String() string

type Config

type Config struct {

	// Specifies how to access the content for your site,
	// including authentication.
	Backend *Config_Backend `protobuf:"bytes,1,opt,name=backend,proto3" json:"backend,omitempty"`
	// Local backend configuration.
	LocalBackend *Config_LocalBackend `protobuf:"bytes,2,opt,name=local_backend,json=localBackend,proto3" json:"local_backend,omitempty"`
	// Allows you to enable "Editorial Workflow" mode for more control
	// over the content publishing phases.
	PublishMode Config_PublishMode `` /* 142-byte string literal not displayed */
	// Specifies the folder path where uploaded files should be saved,
	// relative to the base of the repo.
	MediaFolder string `protobuf:"bytes,4,opt,name=media_folder,json=mediaFolder,proto3" json:"media_folder,omitempty"`
	// Change the logo displayed at the top of the login page,
	// allowing you to brand the CMS with your own logo.
	LogoUrl string `protobuf:"bytes,5,opt,name=logo_url,json=logoUrl,proto3" json:"logo_url,omitempty"`
	// The slug configuration.
	Slug *Config_Slug `protobuf:"bytes,6,opt,name=slug,proto3" json:"slug,omitempty"`
	// The heart of your Netlify CMS configuration,
	// as it determines how content types and editor fields in the UI generate files
	// and content in your repository.
	Collections []*Collection `protobuf:"bytes,7,rep,name=collections,proto3" json:"collections,omitempty"`
	// contains filtered or unexported fields
}

Netlify CMS config.

func (*Config) Descriptor deprecated

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetBackend

func (x *Config) GetBackend() *Config_Backend

func (*Config) GetCollections

func (x *Config) GetCollections() []*Collection

func (*Config) GetLocalBackend added in v0.3.0

func (x *Config) GetLocalBackend() *Config_LocalBackend

func (*Config) GetLogoUrl

func (x *Config) GetLogoUrl() string

func (*Config) GetMediaFolder

func (x *Config) GetMediaFolder() string

func (*Config) GetPublishMode

func (x *Config) GetPublishMode() Config_PublishMode

func (*Config) GetSlug

func (x *Config) GetSlug() *Config_Slug

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string

type Config_Backend

type Config_Backend struct {

	// Name of the backend.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The git repo.
	// Required for github, gitlab, and bitbucket backends; ignored by git-gateway.
	// Follows the pattern [org-or-username]/[repo-name].
	Repo string `protobuf:"bytes,2,opt,name=repo,proto3" json:"repo,omitempty"`
	// The branch where published content is stored.
	// All CMS commits and PRs are made to this branch.
	Branch string `protobuf:"bytes,3,opt,name=branch,proto3" json:"branch,omitempty"`
	// The squash merge option causes all commits to be "squashed" into a single commit
	// when the pull request is merged, and the resulting commit is rebased onto
	// the target branch.
	SquashMerges bool `protobuf:"varint,4,opt,name=squash_merges,json=squashMerges,proto3" json:"squash_merges,omitempty"`
	// Customize the templates used by Netlify CMS to generate commit messages.
	CommitMessages *Config_Backend_CommitMessages `protobuf:"bytes,5,opt,name=commit_messages,json=commitMessages,proto3" json:"commit_messages,omitempty"`
	// OAuth client hostname (just the base domain, no path).
	BaseUrl string `protobuf:"bytes,6,opt,name=base_url,json=baseUrl,proto3" json:"base_url,omitempty"`
	// Sets the site_id query param sent to the API endpoint.
	SiteDomain string `protobuf:"bytes,7,opt,name=site_domain,json=siteDomain,proto3" json:"site_domain,omitempty"`
	// contains filtered or unexported fields
}

Backend config.

func (*Config_Backend) Descriptor deprecated

func (*Config_Backend) Descriptor() ([]byte, []int)

Deprecated: Use Config_Backend.ProtoReflect.Descriptor instead.

func (*Config_Backend) GetBaseUrl

func (x *Config_Backend) GetBaseUrl() string

func (*Config_Backend) GetBranch

func (x *Config_Backend) GetBranch() string

func (*Config_Backend) GetCommitMessages

func (x *Config_Backend) GetCommitMessages() *Config_Backend_CommitMessages

func (*Config_Backend) GetName

func (x *Config_Backend) GetName() string

func (*Config_Backend) GetRepo

func (x *Config_Backend) GetRepo() string

func (*Config_Backend) GetSiteDomain

func (x *Config_Backend) GetSiteDomain() string

func (*Config_Backend) GetSquashMerges

func (x *Config_Backend) GetSquashMerges() bool

func (*Config_Backend) ProtoMessage

func (*Config_Backend) ProtoMessage()

func (*Config_Backend) ProtoReflect

func (x *Config_Backend) ProtoReflect() protoreflect.Message

func (*Config_Backend) Reset

func (x *Config_Backend) Reset()

func (*Config_Backend) String

func (x *Config_Backend) String() string

type Config_Backend_CommitMessages

type Config_Backend_CommitMessages struct {

	// A new entry is created.
	Create string `protobuf:"bytes,1,opt,name=create,proto3" json:"create,omitempty"`
	// An existing entry is changed.
	Update string `protobuf:"bytes,2,opt,name=update,proto3" json:"update,omitempty"`
	// An existing entry is deleted.
	Delete string `protobuf:"bytes,3,opt,name=delete,proto3" json:"delete,omitempty"`
	// A media file is uploaded.
	UploadMedia string `protobuf:"bytes,4,opt,name=upload_media,json=uploadMedia,proto3" json:"upload_media,omitempty"`
	// A media file is deleted.
	DeleteMedia string `protobuf:"bytes,5,opt,name=delete_media,json=deleteMedia,proto3" json:"delete_media,omitempty"`
	// A commit is made via a forked repository.
	OpenAuthoring string `protobuf:"bytes,6,opt,name=open_authoring,json=openAuthoring,proto3" json:"open_authoring,omitempty"`
	// contains filtered or unexported fields
}

Commit message templates.

func (*Config_Backend_CommitMessages) Descriptor deprecated

func (*Config_Backend_CommitMessages) Descriptor() ([]byte, []int)

Deprecated: Use Config_Backend_CommitMessages.ProtoReflect.Descriptor instead.

func (*Config_Backend_CommitMessages) GetCreate

func (x *Config_Backend_CommitMessages) GetCreate() string

func (*Config_Backend_CommitMessages) GetDelete

func (x *Config_Backend_CommitMessages) GetDelete() string

func (*Config_Backend_CommitMessages) GetDeleteMedia

func (x *Config_Backend_CommitMessages) GetDeleteMedia() string

func (*Config_Backend_CommitMessages) GetOpenAuthoring

func (x *Config_Backend_CommitMessages) GetOpenAuthoring() string

func (*Config_Backend_CommitMessages) GetUpdate

func (x *Config_Backend_CommitMessages) GetUpdate() string

func (*Config_Backend_CommitMessages) GetUploadMedia

func (x *Config_Backend_CommitMessages) GetUploadMedia() string

func (*Config_Backend_CommitMessages) ProtoMessage

func (*Config_Backend_CommitMessages) ProtoMessage()

func (*Config_Backend_CommitMessages) ProtoReflect

func (*Config_Backend_CommitMessages) Reset

func (x *Config_Backend_CommitMessages) Reset()

func (*Config_Backend_CommitMessages) String

type Config_LocalBackend added in v0.3.0

type Config_LocalBackend struct {

	// URL of the local backend.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

Local backend configuration.

func (*Config_LocalBackend) Descriptor deprecated added in v0.3.0

func (*Config_LocalBackend) Descriptor() ([]byte, []int)

Deprecated: Use Config_LocalBackend.ProtoReflect.Descriptor instead.

func (*Config_LocalBackend) GetUrl added in v0.3.0

func (x *Config_LocalBackend) GetUrl() string

func (*Config_LocalBackend) ProtoMessage added in v0.3.0

func (*Config_LocalBackend) ProtoMessage()

func (*Config_LocalBackend) ProtoReflect added in v0.3.0

func (x *Config_LocalBackend) ProtoReflect() protoreflect.Message

func (*Config_LocalBackend) Reset added in v0.3.0

func (x *Config_LocalBackend) Reset()

func (*Config_LocalBackend) String added in v0.3.0

func (x *Config_LocalBackend) String() string

type Config_PublishMode

type Config_PublishMode int32

Publish mode.

const (
	// Default value. This value is unused.
	Config_PUBLISH_MODE_UNSPECIFIED Config_PublishMode = 0
	// All unpublished entries will be arranged in a board according to their status,
	// and they can be further reviewed and edited before going live.
	Config_EDITORIAL_WORKFLOW Config_PublishMode = 1
)

func (Config_PublishMode) Descriptor

func (Config_PublishMode) Enum

func (Config_PublishMode) EnumDescriptor deprecated

func (Config_PublishMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Config_PublishMode.Descriptor instead.

func (Config_PublishMode) Number

func (Config_PublishMode) String

func (x Config_PublishMode) String() string

func (Config_PublishMode) Type

type Config_Slug

type Config_Slug struct {

	// The slug encoding.
	Encoding Config_Slug_Encoding `protobuf:"varint,1,opt,name=encoding,proto3,enum=einride.netlify.cms.v1.Config_Slug_Encoding" json:"encoding,omitempty"`
	// Set to true to remove diacritics from slug characters before sanitizing.
	// This is often helpful when using ascii encoding.
	CleanAccents bool `protobuf:"varint,2,opt,name=clean_accents,json=cleanAccents,proto3" json:"clean_accents,omitempty"`
	// The replacement string used to substitute unsafe characters, defaults to -.
	SanitizeReplacement string `protobuf:"bytes,3,opt,name=sanitize_replacement,json=sanitizeReplacement,proto3" json:"sanitize_replacement,omitempty"`
	// contains filtered or unexported fields
}

Slug configuration.

The slug option allows you to change how filenames for entries are created and sanitized. It also applies to filenames of media inserted via the default media library.

func (*Config_Slug) Descriptor deprecated

func (*Config_Slug) Descriptor() ([]byte, []int)

Deprecated: Use Config_Slug.ProtoReflect.Descriptor instead.

func (*Config_Slug) GetCleanAccents

func (x *Config_Slug) GetCleanAccents() bool

func (*Config_Slug) GetEncoding

func (x *Config_Slug) GetEncoding() Config_Slug_Encoding

func (*Config_Slug) GetSanitizeReplacement

func (x *Config_Slug) GetSanitizeReplacement() string

func (*Config_Slug) ProtoMessage

func (*Config_Slug) ProtoMessage()

func (*Config_Slug) ProtoReflect

func (x *Config_Slug) ProtoReflect() protoreflect.Message

func (*Config_Slug) Reset

func (x *Config_Slug) Reset()

func (*Config_Slug) String

func (x *Config_Slug) String() string

type Config_Slug_Encoding

type Config_Slug_Encoding int32

Slug encoding.

const (
	// Default value. This value is unused.
	Config_Slug_ENCODING_UNSPECIFIED Config_Slug_Encoding = 0
	// Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec.
	// This spec allows non-ASCII (or non-Latin) characters to exist in URLs.
	Config_Slug_UNICODE Config_Slug_Encoding = 1
	// Sanitize filenames (slugs) according to RFC3986.
	// The only allowed characters are (0-9, a-z, A-Z, _, -, ~).
	Config_Slug_ASCII Config_Slug_Encoding = 2
)

func (Config_Slug_Encoding) Descriptor

func (Config_Slug_Encoding) Enum

func (Config_Slug_Encoding) EnumDescriptor deprecated

func (Config_Slug_Encoding) EnumDescriptor() ([]byte, []int)

Deprecated: Use Config_Slug_Encoding.Descriptor instead.

func (Config_Slug_Encoding) Number

func (Config_Slug_Encoding) String

func (x Config_Slug_Encoding) String() string

func (Config_Slug_Encoding) Type

type CustomWidget added in v0.4.0

type CustomWidget struct {

	// Type of the custom widget.
	Widget string `protobuf:"bytes,1,opt,name=widget,proto3" json:"widget,omitempty"`
	// Widget options, as raw YAML strings appended to the custom widget.
	Options []string `protobuf:"bytes,2,rep,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

The boolean widget translates a toggle switch input to a true/false value.

func (*CustomWidget) Descriptor deprecated added in v0.4.0

func (*CustomWidget) Descriptor() ([]byte, []int)

Deprecated: Use CustomWidget.ProtoReflect.Descriptor instead.

func (*CustomWidget) GetOptions added in v0.4.0

func (x *CustomWidget) GetOptions() []string

func (*CustomWidget) GetWidget added in v0.4.0

func (x *CustomWidget) GetWidget() string

func (*CustomWidget) ProtoMessage added in v0.4.0

func (*CustomWidget) ProtoMessage()

func (*CustomWidget) ProtoReflect added in v0.4.0

func (x *CustomWidget) ProtoReflect() protoreflect.Message

func (*CustomWidget) Reset added in v0.4.0

func (x *CustomWidget) Reset()

func (*CustomWidget) String added in v0.4.0

func (x *CustomWidget) String() string

type DateTimeWidget

type DateTimeWidget struct {

	// Accepts a datetime string. Defaults to current datetime.
	DefaultValue string `protobuf:"bytes,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// Sets storage format. Accepts Moment.js tokens. Defaults to raw Date object.
	Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
	// Sets date display format in UI. Accepts Moment.js tokens.
	DateFormat string `protobuf:"bytes,3,opt,name=date_format,json=dateFormat,proto3" json:"date_format,omitempty"`
	// Sets time display format in UI. Accepts Moment.js tokens.
	TimeFormat string `protobuf:"bytes,4,opt,name=time_format,json=timeFormat,proto3" json:"time_format,omitempty"`
	// When set to true, the datetime picker will display times in UTC.
	PickerUtc bool `protobuf:"varint,5,opt,name=picker_utc,json=pickerUtc,proto3" json:"picker_utc,omitempty"`
	// contains filtered or unexported fields
}

The datetime widget translates a datetime picker to a datetime string.

func (*DateTimeWidget) Descriptor deprecated

func (*DateTimeWidget) Descriptor() ([]byte, []int)

Deprecated: Use DateTimeWidget.ProtoReflect.Descriptor instead.

func (*DateTimeWidget) GetDateFormat

func (x *DateTimeWidget) GetDateFormat() string

func (*DateTimeWidget) GetDefaultValue

func (x *DateTimeWidget) GetDefaultValue() string

func (*DateTimeWidget) GetFormat

func (x *DateTimeWidget) GetFormat() string

func (*DateTimeWidget) GetPickerUtc

func (x *DateTimeWidget) GetPickerUtc() bool

func (*DateTimeWidget) GetTimeFormat

func (x *DateTimeWidget) GetTimeFormat() string

func (*DateTimeWidget) ProtoMessage

func (*DateTimeWidget) ProtoMessage()

func (*DateTimeWidget) ProtoReflect

func (x *DateTimeWidget) ProtoReflect() protoreflect.Message

func (*DateTimeWidget) Reset

func (x *DateTimeWidget) Reset()

func (*DateTimeWidget) String

func (x *DateTimeWidget) String() string

type Field

type Field struct {

	// Unique identifier for the field.
	// Used as the key when referenced in other contexts (like the relation widget).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Label for the field in the editor UI; defaults to the value of name.
	Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	// Optional comment to add before the field (only supported for yaml).
	Comment string `protobuf:"bytes,3,opt,name=comment,proto3" json:"comment,omitempty"`
	// The field widget.
	Widget *Widget `protobuf:"bytes,4,opt,name=widget,proto3" json:"widget,omitempty"`
	// Flag indicating that this field should be ignored by Netlify CMS.
	Ignore bool `protobuf:"varint,5,opt,name=ignore,proto3" json:"ignore,omitempty"`
	// Owner of the field (automatically appended to the label).
	Owner *Owner `protobuf:"bytes,6,opt,name=owner,proto3" json:"owner,omitempty"`
	// contains filtered or unexported fields
}

Netlify CMS field config.

func (*Field) Descriptor deprecated

func (*Field) Descriptor() ([]byte, []int)

Deprecated: Use Field.ProtoReflect.Descriptor instead.

func (*Field) GetComment

func (x *Field) GetComment() string

func (*Field) GetIgnore

func (x *Field) GetIgnore() bool

func (*Field) GetLabel

func (x *Field) GetLabel() string

func (*Field) GetName

func (x *Field) GetName() string

func (*Field) GetOwner

func (x *Field) GetOwner() *Owner

func (*Field) GetWidget

func (x *Field) GetWidget() *Widget

func (*Field) ProtoMessage

func (*Field) ProtoMessage()

func (*Field) ProtoReflect

func (x *Field) ProtoReflect() protoreflect.Message

func (*Field) Reset

func (x *Field) Reset()

func (*Field) String

func (x *Field) String() string

type FileWidget

type FileWidget struct {

	// Accepts a file path string.
	DefaultValue string `protobuf:"bytes,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"` // TODO: Add remaining fields.
	// contains filtered or unexported fields
}

The file widget allows editors to upload a file or select an existing one from the media library.

func (*FileWidget) Descriptor deprecated

func (*FileWidget) Descriptor() ([]byte, []int)

Deprecated: Use FileWidget.ProtoReflect.Descriptor instead.

func (*FileWidget) GetDefaultValue

func (x *FileWidget) GetDefaultValue() string

func (*FileWidget) ProtoMessage

func (*FileWidget) ProtoMessage()

func (*FileWidget) ProtoReflect

func (x *FileWidget) ProtoReflect() protoreflect.Message

func (*FileWidget) Reset

func (x *FileWidget) Reset()

func (*FileWidget) String

func (x *FileWidget) String() string

type HiddenWidget

type HiddenWidget struct {

	// Accepts any valid data type.
	//
	// Types that are assignable to DefaultValue:
	//
	//	*HiddenWidget_DefaultBool
	//	*HiddenWidget_DefaultString
	//	*HiddenWidget_DefaultDouble
	//	*HiddenWidget_DefaultInt64
	DefaultValue isHiddenWidget_DefaultValue `protobuf_oneof:"default_value"`
	// contains filtered or unexported fields
}

Hidden widgets do not display in the UI.

func (*HiddenWidget) Descriptor deprecated

func (*HiddenWidget) Descriptor() ([]byte, []int)

Deprecated: Use HiddenWidget.ProtoReflect.Descriptor instead.

func (*HiddenWidget) GetDefaultBool

func (x *HiddenWidget) GetDefaultBool() bool

func (*HiddenWidget) GetDefaultDouble

func (x *HiddenWidget) GetDefaultDouble() float64

func (*HiddenWidget) GetDefaultInt64

func (x *HiddenWidget) GetDefaultInt64() int64

func (*HiddenWidget) GetDefaultString

func (x *HiddenWidget) GetDefaultString() string

func (*HiddenWidget) GetDefaultValue

func (m *HiddenWidget) GetDefaultValue() isHiddenWidget_DefaultValue

func (*HiddenWidget) ProtoMessage

func (*HiddenWidget) ProtoMessage()

func (*HiddenWidget) ProtoReflect

func (x *HiddenWidget) ProtoReflect() protoreflect.Message

func (*HiddenWidget) Reset

func (x *HiddenWidget) Reset()

func (*HiddenWidget) String

func (x *HiddenWidget) String() string

type HiddenWidget_DefaultBool

type HiddenWidget_DefaultBool struct {
	// Default bool.
	DefaultBool bool `protobuf:"varint,1,opt,name=default_bool,json=defaultBool,proto3,oneof"`
}

type HiddenWidget_DefaultDouble

type HiddenWidget_DefaultDouble struct {
	// Default double.
	DefaultDouble float64 `protobuf:"fixed64,3,opt,name=default_double,json=defaultDouble,proto3,oneof"`
}

type HiddenWidget_DefaultInt64

type HiddenWidget_DefaultInt64 struct {
	// Default int64.
	DefaultInt64 int64 `protobuf:"varint,4,opt,name=default_int64,json=defaultInt64,proto3,oneof"`
}

type HiddenWidget_DefaultString

type HiddenWidget_DefaultString struct {
	// Default string.
	DefaultString string `protobuf:"bytes,2,opt,name=default_string,json=defaultString,proto3,oneof"`
}

type ImageWidget

type ImageWidget struct {

	// Accepts a file path string.
	DefaultValue string `protobuf:"bytes,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"` // TODO: Add remaining fields.
	// contains filtered or unexported fields
}

The image widget allows editors to upload an image or select an existing one from the media library.

func (*ImageWidget) Descriptor deprecated

func (*ImageWidget) Descriptor() ([]byte, []int)

Deprecated: Use ImageWidget.ProtoReflect.Descriptor instead.

func (*ImageWidget) GetDefaultValue

func (x *ImageWidget) GetDefaultValue() string

func (*ImageWidget) ProtoMessage

func (*ImageWidget) ProtoMessage()

func (*ImageWidget) ProtoReflect

func (x *ImageWidget) ProtoReflect() protoreflect.Message

func (*ImageWidget) Reset

func (x *ImageWidget) Reset()

func (*ImageWidget) String

func (x *ImageWidget) String() string

type ListWidget

type ListWidget struct {

	// Shows the button to add additional items.
	AllowAdd bool `protobuf:"varint,1,opt,name=allow_add,json=allowAdd,proto3" json:"allow_add,omitempty"`
	// Collapse the entries.
	Collapsed bool `protobuf:"varint,2,opt,name=collapsed,proto3" json:"collapsed,omitempty"`
	// Specify the label displayed on collapsed entries.
	Summary string `protobuf:"bytes,3,opt,name=summary,proto3" json:"summary,omitempty"`
	// Collapse the list widget to hide all of it's entries.
	MinimizeCollapsed bool `protobuf:"varint,4,opt,name=minimize_collapsed,json=minimizeCollapsed,proto3" json:"minimize_collapsed,omitempty"`
	// Text to show on the add button.
	LabelSingular string `protobuf:"bytes,5,opt,name=label_singular,json=labelSingular,proto3" json:"label_singular,omitempty"`
	// Widget fields to be included in each repeatable iteration.
	Fields []*Field `protobuf:"bytes,6,rep,name=fields,proto3" json:"fields,omitempty"`
	// Maximum number of items in the list.
	MaxItems int64 `protobuf:"varint,7,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
	// Minimum number of items in the list.
	MinItems int64 `protobuf:"varint,8,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
	// Add new entries to the top of the list.
	AddToTop bool `protobuf:"varint,9,opt,name=add_to_top,json=addToTop,proto3" json:"add_to_top,omitempty"`
	// contains filtered or unexported fields
}

The list widget allows you to create a repeatable item in the UI which saves as a list of widget values.

func (*ListWidget) Descriptor deprecated

func (*ListWidget) Descriptor() ([]byte, []int)

Deprecated: Use ListWidget.ProtoReflect.Descriptor instead.

func (*ListWidget) GetAddToTop

func (x *ListWidget) GetAddToTop() bool

func (*ListWidget) GetAllowAdd

func (x *ListWidget) GetAllowAdd() bool

func (*ListWidget) GetCollapsed

func (x *ListWidget) GetCollapsed() bool

func (*ListWidget) GetFields

func (x *ListWidget) GetFields() []*Field

func (*ListWidget) GetLabelSingular

func (x *ListWidget) GetLabelSingular() string

func (*ListWidget) GetMaxItems

func (x *ListWidget) GetMaxItems() int64

func (*ListWidget) GetMinItems

func (x *ListWidget) GetMinItems() int64

func (*ListWidget) GetMinimizeCollapsed

func (x *ListWidget) GetMinimizeCollapsed() bool

func (*ListWidget) GetSummary

func (x *ListWidget) GetSummary() string

func (*ListWidget) ProtoMessage

func (*ListWidget) ProtoMessage()

func (*ListWidget) ProtoReflect

func (x *ListWidget) ProtoReflect() protoreflect.Message

func (*ListWidget) Reset

func (x *ListWidget) Reset()

func (*ListWidget) String

func (x *ListWidget) String() string

type MapWidget

type MapWidget struct {

	// Accepts a number to specify precision of saved coordinates.
	// Defaults to 7 decimals.
	Decimals int64 `protobuf:"varint,1,opt,name=decimals,proto3" json:"decimals,omitempty"`
	// Accepts a GeoJSON string containing a single geometry.
	DefaultValue string `protobuf:"bytes,2,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// The type of GeoJSON object.
	Type MapWidget_Type `protobuf:"varint,3,opt,name=type,proto3,enum=einride.netlify.cms.v1.MapWidget_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

The map widget allows you to edit spatial data using an interactive map.

func (*MapWidget) Descriptor deprecated

func (*MapWidget) Descriptor() ([]byte, []int)

Deprecated: Use MapWidget.ProtoReflect.Descriptor instead.

func (*MapWidget) GetDecimals

func (x *MapWidget) GetDecimals() int64

func (*MapWidget) GetDefaultValue

func (x *MapWidget) GetDefaultValue() string

func (*MapWidget) GetType

func (x *MapWidget) GetType() MapWidget_Type

func (*MapWidget) ProtoMessage

func (*MapWidget) ProtoMessage()

func (*MapWidget) ProtoReflect

func (x *MapWidget) ProtoReflect() protoreflect.Message

func (*MapWidget) Reset

func (x *MapWidget) Reset()

func (*MapWidget) String

func (x *MapWidget) String() string

type MapWidget_Type

type MapWidget_Type int32

GeoJSON type.

const (
	// Default value. This value is unused.
	MapWidget_TYPE_UNSPECIFIED MapWidget_Type = 0
	// Point.
	MapWidget_POINT MapWidget_Type = 1
	// LineString.
	MapWidget_LINE_STRING MapWidget_Type = 2
	// Polygon.
	MapWidget_POLYGON MapWidget_Type = 3
)

func (MapWidget_Type) Descriptor

func (MapWidget_Type) Enum

func (x MapWidget_Type) Enum() *MapWidget_Type

func (MapWidget_Type) EnumDescriptor deprecated

func (MapWidget_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use MapWidget_Type.Descriptor instead.

func (MapWidget_Type) Number

func (MapWidget_Type) String

func (x MapWidget_Type) String() string

func (MapWidget_Type) Type

type MarkdownWidget

type MarkdownWidget struct {

	// Accepts markdown content.
	DefaultValue string `protobuf:"bytes,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// Sets the widget height to minimum possible.
	Minimal bool `protobuf:"varint,2,opt,name=minimal,proto3" json:"minimal,omitempty"` // TODO: Add more fields.
	// contains filtered or unexported fields
}

The markdown widget provides a full fledged text editor allowing users to format text with features such as headings and blockquotes.

func (*MarkdownWidget) Descriptor deprecated

func (*MarkdownWidget) Descriptor() ([]byte, []int)

Deprecated: Use MarkdownWidget.ProtoReflect.Descriptor instead.

func (*MarkdownWidget) GetDefaultValue

func (x *MarkdownWidget) GetDefaultValue() string

func (*MarkdownWidget) GetMinimal

func (x *MarkdownWidget) GetMinimal() bool

func (*MarkdownWidget) ProtoMessage

func (*MarkdownWidget) ProtoMessage()

func (*MarkdownWidget) ProtoReflect

func (x *MarkdownWidget) ProtoReflect() protoreflect.Message

func (*MarkdownWidget) Reset

func (x *MarkdownWidget) Reset()

func (*MarkdownWidget) String

func (x *MarkdownWidget) String() string

type NumberWidget

type NumberWidget struct {

	// Default value.
	DefaultValue float64 `protobuf:"fixed64,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// The value type.
	ValueType NumberWidget_ValueType `` /* 140-byte string literal not displayed */
	// Minimum value accepted.
	MinValue float64 `protobuf:"fixed64,3,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// Maximum value accepted.
	MaxValue float64 `protobuf:"fixed64,4,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// Number for stepping up/down values. 1 by default.
	Step float64 `protobuf:"fixed64,5,opt,name=step,proto3" json:"step,omitempty"`
	// contains filtered or unexported fields
}

The markdown widget provides a full fledged text editor allowing users to format text with features such as headings and blockquotes.

func (*NumberWidget) Descriptor deprecated

func (*NumberWidget) Descriptor() ([]byte, []int)

Deprecated: Use NumberWidget.ProtoReflect.Descriptor instead.

func (*NumberWidget) GetDefaultValue

func (x *NumberWidget) GetDefaultValue() float64

func (*NumberWidget) GetMaxValue

func (x *NumberWidget) GetMaxValue() float64

func (*NumberWidget) GetMinValue

func (x *NumberWidget) GetMinValue() float64

func (*NumberWidget) GetStep

func (x *NumberWidget) GetStep() float64

func (*NumberWidget) GetValueType

func (x *NumberWidget) GetValueType() NumberWidget_ValueType

func (*NumberWidget) ProtoMessage

func (*NumberWidget) ProtoMessage()

func (*NumberWidget) ProtoReflect

func (x *NumberWidget) ProtoReflect() protoreflect.Message

func (*NumberWidget) Reset

func (x *NumberWidget) Reset()

func (*NumberWidget) String

func (x *NumberWidget) String() string

type NumberWidget_ValueType

type NumberWidget_ValueType int32

Value type of the number widget.

const (
	// Default value. This value is unused.
	NumberWidget_VALUE_TYPE_UNSPECIFIED NumberWidget_ValueType = 0
	// Int.
	NumberWidget_INT NumberWidget_ValueType = 1
	// Float.
	NumberWidget_FLOAT NumberWidget_ValueType = 2
	// String.
	NumberWidget_STRING NumberWidget_ValueType = 3
)

func (NumberWidget_ValueType) Descriptor

func (NumberWidget_ValueType) Enum

func (NumberWidget_ValueType) EnumDescriptor deprecated

func (NumberWidget_ValueType) EnumDescriptor() ([]byte, []int)

Deprecated: Use NumberWidget_ValueType.Descriptor instead.

func (NumberWidget_ValueType) Number

func (NumberWidget_ValueType) String

func (x NumberWidget_ValueType) String() string

func (NumberWidget_ValueType) Type

type ObjectWidget

type ObjectWidget struct {

	// Collapse the widgets content by default.
	Collapsed bool `protobuf:"varint,1,opt,name=collapsed,proto3" json:"collapsed,omitempty"`
	// Specify the label displayed when the object is collapsed.
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// A nested list of widget fields.
	Fields []*Field `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

The object widget allows you to group multiple widgets together, nested under a single field.

func (*ObjectWidget) Descriptor deprecated

func (*ObjectWidget) Descriptor() ([]byte, []int)

Deprecated: Use ObjectWidget.ProtoReflect.Descriptor instead.

func (*ObjectWidget) GetCollapsed

func (x *ObjectWidget) GetCollapsed() bool

func (*ObjectWidget) GetFields

func (x *ObjectWidget) GetFields() []*Field

func (*ObjectWidget) GetSummary

func (x *ObjectWidget) GetSummary() string

func (*ObjectWidget) ProtoMessage

func (*ObjectWidget) ProtoMessage()

func (*ObjectWidget) ProtoReflect

func (x *ObjectWidget) ProtoReflect() protoreflect.Message

func (*ObjectWidget) Reset

func (x *ObjectWidget) Reset()

func (*ObjectWidget) String

func (x *ObjectWidget) String() string

type Owner

type Owner struct {

	// Display name of the owner.
	DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// URI of the owner.
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

An owner.

func (*Owner) Descriptor deprecated

func (*Owner) Descriptor() ([]byte, []int)

Deprecated: Use Owner.ProtoReflect.Descriptor instead.

func (*Owner) GetDisplayName

func (x *Owner) GetDisplayName() string

func (*Owner) GetUri

func (x *Owner) GetUri() string

func (*Owner) ProtoMessage

func (*Owner) ProtoMessage()

func (*Owner) ProtoReflect

func (x *Owner) ProtoReflect() protoreflect.Message

func (*Owner) Reset

func (x *Owner) Reset()

func (*Owner) String

func (x *Owner) String() string

type RelationWidget

type RelationWidget struct {

	// Name of the referenced collection.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Name of the field from the referenced collection.
	ValueField string `protobuf:"bytes,2,opt,name=value_field,json=valueField,proto3" json:"value_field,omitempty"`
	// Names of fields in the to search for the typed value.
	SearchFields []string `protobuf:"bytes,3,rep,name=search_fields,json=searchFields,proto3" json:"search_fields,omitempty"`
	// Names of fields in the that will render in the autocomplete menu.
	DisplayFields []string `protobuf:"bytes,4,rep,name=display_fields,json=displayFields,proto3" json:"display_fields,omitempty"`
	// Flag indicating if multiple values are supported.
	Multiple bool `protobuf:"varint,5,opt,name=multiple,proto3" json:"multiple,omitempty"`
	// contains filtered or unexported fields
}

The relation widget allows you to reference items from another collection.

func (*RelationWidget) Descriptor deprecated

func (*RelationWidget) Descriptor() ([]byte, []int)

Deprecated: Use RelationWidget.ProtoReflect.Descriptor instead.

func (*RelationWidget) GetCollection

func (x *RelationWidget) GetCollection() string

func (*RelationWidget) GetDisplayFields

func (x *RelationWidget) GetDisplayFields() []string

func (*RelationWidget) GetMultiple

func (x *RelationWidget) GetMultiple() bool

func (*RelationWidget) GetSearchFields

func (x *RelationWidget) GetSearchFields() []string

func (*RelationWidget) GetValueField

func (x *RelationWidget) GetValueField() string

func (*RelationWidget) ProtoMessage

func (*RelationWidget) ProtoMessage()

func (*RelationWidget) ProtoReflect

func (x *RelationWidget) ProtoReflect() protoreflect.Message

func (*RelationWidget) Reset

func (x *RelationWidget) Reset()

func (*RelationWidget) String

func (x *RelationWidget) String() string

type SelectWidget

type SelectWidget struct {

	// Default value.
	DefaultValue []string `protobuf:"bytes,1,rep,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// Selectable options.
	Options []*SelectWidget_Option `protobuf:"bytes,2,rep,name=options,proto3" json:"options,omitempty"`
	// Allow multiple selection.
	Multiple bool `protobuf:"varint,3,opt,name=multiple,proto3" json:"multiple,omitempty"`
	// Minimum selection of multiple items.
	MultipleMin int64 `protobuf:"varint,4,opt,name=multiple_min,json=multipleMin,proto3" json:"multiple_min,omitempty"`
	// Maximum selection of multiple items.
	MultipleMax int64 `protobuf:"varint,5,opt,name=multiple_max,json=multipleMax,proto3" json:"multiple_max,omitempty"`
	// contains filtered or unexported fields
}

The select widget allows you to pick a string value from a dropdown menu.

func (*SelectWidget) Descriptor deprecated

func (*SelectWidget) Descriptor() ([]byte, []int)

Deprecated: Use SelectWidget.ProtoReflect.Descriptor instead.

func (*SelectWidget) GetDefaultValue

func (x *SelectWidget) GetDefaultValue() []string

func (*SelectWidget) GetMultiple

func (x *SelectWidget) GetMultiple() bool

func (*SelectWidget) GetMultipleMax

func (x *SelectWidget) GetMultipleMax() int64

func (*SelectWidget) GetMultipleMin

func (x *SelectWidget) GetMultipleMin() int64

func (*SelectWidget) GetOptions

func (x *SelectWidget) GetOptions() []*SelectWidget_Option

func (*SelectWidget) ProtoMessage

func (*SelectWidget) ProtoMessage()

func (*SelectWidget) ProtoReflect

func (x *SelectWidget) ProtoReflect() protoreflect.Message

func (*SelectWidget) Reset

func (x *SelectWidget) Reset()

func (*SelectWidget) String

func (x *SelectWidget) String() string

type SelectWidget_Option

type SelectWidget_Option struct {

	// The label.
	Label string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`
	// The value.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Option with label and value.

func (*SelectWidget_Option) Descriptor deprecated

func (*SelectWidget_Option) Descriptor() ([]byte, []int)

Deprecated: Use SelectWidget_Option.ProtoReflect.Descriptor instead.

func (*SelectWidget_Option) GetLabel

func (x *SelectWidget_Option) GetLabel() string

func (*SelectWidget_Option) GetValue

func (x *SelectWidget_Option) GetValue() string

func (*SelectWidget_Option) ProtoMessage

func (*SelectWidget_Option) ProtoMessage()

func (*SelectWidget_Option) ProtoReflect

func (x *SelectWidget_Option) ProtoReflect() protoreflect.Message

func (*SelectWidget_Option) Reset

func (x *SelectWidget_Option) Reset()

func (*SelectWidget_Option) String

func (x *SelectWidget_Option) String() string

type StringWidget

type StringWidget struct {

	// Default value.
	DefaultValue string `protobuf:"bytes,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

The string widget translates a basic text input to a string value. For larger textarea inputs, use the text widget.

func (*StringWidget) Descriptor deprecated

func (*StringWidget) Descriptor() ([]byte, []int)

Deprecated: Use StringWidget.ProtoReflect.Descriptor instead.

func (*StringWidget) GetDefaultValue

func (x *StringWidget) GetDefaultValue() string

func (*StringWidget) ProtoMessage

func (*StringWidget) ProtoMessage()

func (*StringWidget) ProtoReflect

func (x *StringWidget) ProtoReflect() protoreflect.Message

func (*StringWidget) Reset

func (x *StringWidget) Reset()

func (*StringWidget) String

func (x *StringWidget) String() string

type TextWidget

type TextWidget struct {

	// Default value.
	DefaultValue string `protobuf:"bytes,1,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

The text widget takes a multiline text field and saves it as a string. For shorter text inputs, use the string widget.

func (*TextWidget) Descriptor deprecated

func (*TextWidget) Descriptor() ([]byte, []int)

Deprecated: Use TextWidget.ProtoReflect.Descriptor instead.

func (*TextWidget) GetDefaultValue

func (x *TextWidget) GetDefaultValue() string

func (*TextWidget) ProtoMessage

func (*TextWidget) ProtoMessage()

func (*TextWidget) ProtoReflect

func (x *TextWidget) ProtoReflect() protoreflect.Message

func (*TextWidget) Reset

func (x *TextWidget) Reset()

func (*TextWidget) String

func (x *TextWidget) String() string

type Widget

type Widget struct {

	// Whether the widget is mandatory.
	RequiredValue bool `protobuf:"varint,1,opt,name=required_value,json=requiredValue,proto3" json:"required_value,omitempty"`
	// Helper text directly below the widget.
	Hint string `protobuf:"bytes,2,opt,name=hint,proto3" json:"hint,omitempty"`
	// The validation pattern.
	Pattern *Widget_Pattern `protobuf:"bytes,3,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// The widget type.
	//
	// Types that are assignable to WidgetType:
	//
	//	*Widget_BooleanWidget
	//	*Widget_CodeWidget
	//	*Widget_ColorWidget
	//	*Widget_DateTimeWidget
	//	*Widget_FileWidget
	//	*Widget_HiddenWidget
	//	*Widget_ImageWidget
	//	*Widget_ListWidget
	//	*Widget_MapWidget
	//	*Widget_MarkdownWidget
	//	*Widget_NumberWidget
	//	*Widget_ObjectWidget
	//	*Widget_RelationWidget
	//	*Widget_SelectWidget
	//	*Widget_StringWidget
	//	*Widget_TextWidget
	//	*Widget_CustomWidget
	WidgetType isWidget_WidgetType `protobuf_oneof:"widget_type"`
	// contains filtered or unexported fields
}

Widgets define the data type and interface for entry fields.

func (*Widget) Descriptor deprecated

func (*Widget) Descriptor() ([]byte, []int)

Deprecated: Use Widget.ProtoReflect.Descriptor instead.

func (*Widget) GetBooleanWidget

func (x *Widget) GetBooleanWidget() *BooleanWidget

func (*Widget) GetCodeWidget

func (x *Widget) GetCodeWidget() *CodeWidget

func (*Widget) GetColorWidget

func (x *Widget) GetColorWidget() *ColorWidget

func (*Widget) GetCustomWidget added in v0.4.0

func (x *Widget) GetCustomWidget() *CustomWidget

func (*Widget) GetDateTimeWidget

func (x *Widget) GetDateTimeWidget() *DateTimeWidget

func (*Widget) GetFileWidget

func (x *Widget) GetFileWidget() *FileWidget

func (*Widget) GetHiddenWidget

func (x *Widget) GetHiddenWidget() *HiddenWidget

func (*Widget) GetHint

func (x *Widget) GetHint() string

func (*Widget) GetImageWidget

func (x *Widget) GetImageWidget() *ImageWidget

func (*Widget) GetListWidget

func (x *Widget) GetListWidget() *ListWidget

func (*Widget) GetMapWidget

func (x *Widget) GetMapWidget() *MapWidget

func (*Widget) GetMarkdownWidget

func (x *Widget) GetMarkdownWidget() *MarkdownWidget

func (*Widget) GetNumberWidget

func (x *Widget) GetNumberWidget() *NumberWidget

func (*Widget) GetObjectWidget

func (x *Widget) GetObjectWidget() *ObjectWidget

func (*Widget) GetPattern

func (x *Widget) GetPattern() *Widget_Pattern

func (*Widget) GetRelationWidget

func (x *Widget) GetRelationWidget() *RelationWidget

func (*Widget) GetRequiredValue

func (x *Widget) GetRequiredValue() bool

func (*Widget) GetSelectWidget

func (x *Widget) GetSelectWidget() *SelectWidget

func (*Widget) GetStringWidget

func (x *Widget) GetStringWidget() *StringWidget

func (*Widget) GetTextWidget

func (x *Widget) GetTextWidget() *TextWidget

func (*Widget) GetWidgetType

func (m *Widget) GetWidgetType() isWidget_WidgetType

func (*Widget) ProtoMessage

func (*Widget) ProtoMessage()

func (*Widget) ProtoReflect

func (x *Widget) ProtoReflect() protoreflect.Message

func (*Widget) Reset

func (x *Widget) Reset()

func (*Widget) String

func (x *Widget) String() string

type Widget_BooleanWidget

type Widget_BooleanWidget struct {
	// Boolean widget.
	BooleanWidget *BooleanWidget `protobuf:"bytes,4,opt,name=boolean_widget,json=booleanWidget,proto3,oneof"`
}

type Widget_CodeWidget

type Widget_CodeWidget struct {
	// Code widget.
	CodeWidget *CodeWidget `protobuf:"bytes,5,opt,name=code_widget,json=codeWidget,proto3,oneof"`
}

type Widget_ColorWidget

type Widget_ColorWidget struct {
	// Color widget.
	ColorWidget *ColorWidget `protobuf:"bytes,6,opt,name=color_widget,json=colorWidget,proto3,oneof"`
}

type Widget_CustomWidget added in v0.4.0

type Widget_CustomWidget struct {
	// Custom widget.
	CustomWidget *CustomWidget `protobuf:"bytes,21,opt,name=custom_widget,json=customWidget,proto3,oneof"`
}

type Widget_DateTimeWidget

type Widget_DateTimeWidget struct {
	// DateTime widget.
	DateTimeWidget *DateTimeWidget `protobuf:"bytes,8,opt,name=date_time_widget,json=dateTimeWidget,proto3,oneof"`
}

type Widget_FileWidget

type Widget_FileWidget struct {
	// File widget.
	FileWidget *FileWidget `protobuf:"bytes,9,opt,name=file_widget,json=fileWidget,proto3,oneof"`
}

type Widget_HiddenWidget

type Widget_HiddenWidget struct {
	// Hidden widget.
	HiddenWidget *HiddenWidget `protobuf:"bytes,10,opt,name=hidden_widget,json=hiddenWidget,proto3,oneof"`
}

type Widget_ImageWidget

type Widget_ImageWidget struct {
	// Image widget.
	ImageWidget *ImageWidget `protobuf:"bytes,11,opt,name=image_widget,json=imageWidget,proto3,oneof"`
}

type Widget_ListWidget

type Widget_ListWidget struct {
	// List widget.
	ListWidget *ListWidget `protobuf:"bytes,12,opt,name=list_widget,json=listWidget,proto3,oneof"`
}

type Widget_MapWidget

type Widget_MapWidget struct {
	// Map widget.
	MapWidget *MapWidget `protobuf:"bytes,13,opt,name=map_widget,json=mapWidget,proto3,oneof"`
}

type Widget_MarkdownWidget

type Widget_MarkdownWidget struct {
	// Markdown widget.
	MarkdownWidget *MarkdownWidget `protobuf:"bytes,14,opt,name=markdown_widget,json=markdownWidget,proto3,oneof"`
}

type Widget_NumberWidget

type Widget_NumberWidget struct {
	// Number widget.
	NumberWidget *NumberWidget `protobuf:"bytes,15,opt,name=number_widget,json=numberWidget,proto3,oneof"`
}

type Widget_ObjectWidget

type Widget_ObjectWidget struct {
	// Object widget.
	ObjectWidget *ObjectWidget `protobuf:"bytes,16,opt,name=object_widget,json=objectWidget,proto3,oneof"`
}

type Widget_Pattern

type Widget_Pattern struct {

	// Regexp to use for validation.
	Regexp string `protobuf:"bytes,1,opt,name=regexp,proto3" json:"regexp,omitempty"`
	// Error message when validation fails.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Add field validation by specifying a list with a regex pattern and an error message. More extensive validation can be achieved with custom widgets.

func (*Widget_Pattern) Descriptor deprecated

func (*Widget_Pattern) Descriptor() ([]byte, []int)

Deprecated: Use Widget_Pattern.ProtoReflect.Descriptor instead.

func (*Widget_Pattern) GetErrorMessage

func (x *Widget_Pattern) GetErrorMessage() string

func (*Widget_Pattern) GetRegexp

func (x *Widget_Pattern) GetRegexp() string

func (*Widget_Pattern) ProtoMessage

func (*Widget_Pattern) ProtoMessage()

func (*Widget_Pattern) ProtoReflect

func (x *Widget_Pattern) ProtoReflect() protoreflect.Message

func (*Widget_Pattern) Reset

func (x *Widget_Pattern) Reset()

func (*Widget_Pattern) String

func (x *Widget_Pattern) String() string

type Widget_RelationWidget

type Widget_RelationWidget struct {
	// Relation widget.
	RelationWidget *RelationWidget `protobuf:"bytes,17,opt,name=relation_widget,json=relationWidget,proto3,oneof"`
}

type Widget_SelectWidget

type Widget_SelectWidget struct {
	// Select widget.
	SelectWidget *SelectWidget `protobuf:"bytes,18,opt,name=select_widget,json=selectWidget,proto3,oneof"`
}

type Widget_StringWidget

type Widget_StringWidget struct {
	// String widget.
	StringWidget *StringWidget `protobuf:"bytes,19,opt,name=string_widget,json=stringWidget,proto3,oneof"`
}

type Widget_TextWidget

type Widget_TextWidget struct {
	// Text widget.
	TextWidget *TextWidget `protobuf:"bytes,20,opt,name=text_widget,json=textWidget,proto3,oneof"`
}

Jump to

Keyboard shortcuts

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