Documentation
¶
Overview ¶
Package capabilities holds the curated capability table for the GoWebComponents framework and renders the generated capability-matrix reference page. The page is never hand-maintained: TestCapabilityMatrixIsGenerated regenerates it from the table below and fails if the committed page drifts, so the matrix always reflects what actually exists on disk.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderPage ¶
func RenderPage(parseCaps []Capability) string
RenderPage renders the capability-matrix reference page as a GitHub-Flavored Markdown string from the provided capability rows. Row order is preserved. When a Capability's ExampleSlug is empty the Example cell renders "—" rather than a broken link.
Types ¶
type Capability ¶
type Capability struct {
// Name is the human-readable capability label shown in the matrix.
Name string
// Packages lists the Go package path suffixes (relative to the module root)
// that implement this capability, e.g. []string{"ui"} or []string{"html",
// "html/shorthand"}.
Packages []string
// ExampleSlug is the name of the directory under examples/public/ that best
// demonstrates this capability. Empty means no public example exists yet.
ExampleSlug string
// Chapter is the filename of the reference-manual chapter that covers this
// capability, e.g. "04-ui-rendering-and-hooks.md".
Chapter string
}
Capability is one row in the framework capability matrix, mapping a named capability to the packages that implement it, a representative public example slug, and the reference-manual chapter that covers it in depth.
ExampleSlug is the subdirectory name under examples/public/; an empty string means no public example exists yet and the Example cell renders "—". Chapter is the filename (not path) of the markdown chapter under docs/REFERENCE_MANUAL/.
func Capabilities ¶
func Capabilities() []Capability
Capabilities returns the curated capability table in stable reading order. Do not sort the slice; callers that need a different order should copy and sort.
Source Files