Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

props

package

Go to main page

Versions in this module

v0

v0.5.0

Apr 4, 2026

v0.4.1

Mar 27, 2026

v0.4.0

Mar 22, 2026

v0.3.2

Mar 16, 2026

v0.3.1

Mar 13, 2026

v0.3.0

Mar 13, 2026

Changes in this version

+ func FormatMarkdown(p ResolvedProp, variant Variant) string

+ func Register(def Definition)

+ func ValidateParams(def Definition, params map[string]string) error

+ func ValidateVariant(v Variant) error

+ type CategoryCount struct

+ Count int

+ Name string

+ func Categories() []CategoryCount

+ type Definition struct

+ Category string

+ DefaultAlt string

+ Description string

+ Format string

+ ID string

+ Provider Provider

+ Resolver PropResolver

+ func All() []Definition

+ func Get(id string) (Definition, bool)

+ func List(category string) []Definition

+ type ParamSpec struct

+ Default string

+ Help string

+ Name string

+ Required bool

+ type PropResolver interface

+ Resolve func(params map[string]string, opts RenderOptions) (ResolvedProp, error)

+ Schema func() PropSchema

+ type PropSchema struct

+ Example map[string]string

+ Params []ParamSpec

+ type Provider string

+ const ProviderNative

+ const ProviderShields

+ const ProviderStatic

+ type RenderOptions struct

+ Label string

+ Link string

+ Logo string

+ Style string

+ Variant Variant

+ type ResolvedProp struct

+ Alt string

+ ImageURL string

+ LinkURL string

+ func ResolveDefinition(def Definition, params map[string]string, opts RenderOptions) (ResolvedProp, error)

+ type ShieldsResolver struct

+ DefaultLogo string

+ Example map[string]string

+ LinkTemplate string

+ Params []ParamSpec

+ PathTemplate string

+ func (s ShieldsResolver) Resolve(params map[string]string, opts RenderOptions) (ResolvedProp, error)

+ func (s ShieldsResolver) Schema() PropSchema

+ type StaticResolver struct

+ Example map[string]string

+ ImageURL string

+ LinkURL string

+ Params []ParamSpec

+ func (s StaticResolver) Resolve(params map[string]string, opts RenderOptions) (ResolvedProp, error)

+ func (s StaticResolver) Schema() PropSchema

+ type ValidationError struct

+ Message string

+ Param string

+ TypeID string

+ func (e *ValidationError) Error() string

+ type Variant string

+ const VariantClassic