Documentation
¶
Overview ¶
Package dashboard provides a Forge dashboard contributor for CtrlPlane. It renders pages, widgets, and settings in the Forge dashboard UI using templ components and the ForgeUI component library.
The contributor is automatically discovered by the Forge dashboard extension when the CtrlPlane extension implements DashboardAware.
Index ¶
- func NewManifest() *contributor.Manifest
- type Contributor
- func (c *Contributor) Manifest() *contributor.Manifest
- func (c *Contributor) RenderPage(ctx context.Context, route string, params contributor.Params) (templ.Component, error)
- func (c *Contributor) RenderSettings(ctx context.Context, settingID string) (templ.Component, error)
- func (c *Contributor) RenderWidget(ctx context.Context, widgetID string) (templ.Component, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewManifest ¶
func NewManifest() *contributor.Manifest
NewManifest builds a contributor.Manifest for the ctrlplane dashboard.
Types ¶
type Contributor ¶
type Contributor struct {
// contains filtered or unexported fields
}
Contributor implements the dashboard LocalContributor for CtrlPlane.
func New ¶
func New(manifest *contributor.Manifest, cp *app.CtrlPlane) *Contributor
New creates a new ctrlplane dashboard contributor.
func (*Contributor) Manifest ¶
func (c *Contributor) Manifest() *contributor.Manifest
Manifest returns the contributor manifest.
func (*Contributor) RenderPage ¶
func (c *Contributor) RenderPage(ctx context.Context, route string, params contributor.Params) (templ.Component, error)
RenderPage renders a page for the given route.
func (*Contributor) RenderSettings ¶
func (c *Contributor) RenderSettings(ctx context.Context, settingID string) (templ.Component, error)
RenderSettings renders a settings panel by ID.
func (*Contributor) RenderWidget ¶
RenderWidget renders a widget by ID.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
templ: version: v0.3.1001
|
templ: version: v0.3.1001 |
|
templ: version: v0.3.1001
|
templ: version: v0.3.1001 |
|
templ: version: v0.3.1001
|
templ: version: v0.3.1001 |
|
templ: version: v0.3.1001
|
templ: version: v0.3.1001 |
Click to show internal directories.
Click to hide internal directories.