library

Documentation

Overview

library provides an API for defining component catalogs that can be registered with modules.

Index

• func ComponentID(v any) string
• func Filepath(subpaths ...string) string
• type Catalog
  • func (b *Catalog) Register(items ...Item) error
• type Component
  • func (c Component) ID() string
  • func (c Component) Name() string
  • func (c Component) New() any
• type Item

Functions

func ComponentID

func ComponentID(v any) string

when adding components to raw nodes, there is no catalog just consistent component IDs, so we make this available

func Filepath

func Filepath(subpaths ...string) string

Filepath returns the file path of the calling source file with an optional subpath

Types

type Catalog

type Catalog []Item

var DefaultCatalog Catalog

func (*Catalog) Register

func (b *Catalog) Register(items ...Item) error

type Component

type Component struct {
	Value  any
	Prefix string
	Source string
	Icon   string
	Desc   string
}

func (Component) ID

func (c Component) ID() string

func (Component) Name

func (c Component) Name() string

func (Component) New

func (c Component) New() any

type Item

type Item any