Documentation
¶
Overview ¶
Package debug preserves the Debug panel facade over neutral console primitives.
Index ¶
- Constants
- func PanelDefinitionHasAction(def PanelDefinition, actionID string) bool
- func PanelsForEventType(eventType string) []string
- func RegisterPanel(id string, config PanelConfig) error
- func RegistryVersion() string
- func SetRegistryVersion(version string)
- func UnregisterPanel(id string)
- type PanelActionEvent
- type PanelActionHandler
- type PanelActionHandlerResolver
- type PanelActionRequest
- type PanelActionResult
- type PanelClearCheckFunc
- type PanelClearFunc
- type PanelConfig
- type PanelDefinition
- type PanelDefinitionFilter
- type PanelRegistration
- type PanelRegistry
- type PanelSnapshotFunc
- type PanelUI
- type PanelUIAction
- type PanelUIActionField
- type PanelUIActionForm
- type PanelUIActionLayout
- type PanelUIActionOption
- type PanelUIActionOptionSource
- type PanelUIColumn
- type PanelUICount
- type PanelUIEventPolicy
- type PanelUIField
- type PanelUIFilter
- type PanelUIMetric
- type PanelUIView
- func GridStackView(sections ...PanelUIView) *PanelUIView
- func IdentityView(bind string) *PanelUIView
- func JSONView(bind string) *PanelUIView
- func KeyValueView(bind string) *PanelUIView
- func MetricsView(bind string) *PanelUIView
- func PanelView(renderer, bind string) *PanelUIView
- func StackView(sections ...PanelUIView) *PanelUIView
- func StatusListView(bind string) *PanelUIView
- func TableView(bind string) *PanelUIView
- func TimelineView(bind string) *PanelUIView
- type PanelUIViews
Constants ¶
const ( PanelUISchemaVersion = consolecore.PanelUISchemaVersion PanelRendererMetrics = consolecore.PanelRendererMetrics PanelRendererKeyValue = consolecore.PanelRendererKeyValue PanelRendererIdentity = consolecore.PanelRendererIdentity PanelRendererTable = consolecore.PanelRendererTable PanelRendererStatusList = consolecore.PanelRendererStatusList PanelRendererTimeline = consolecore.PanelRendererTimeline PanelRendererJSON = consolecore.PanelRendererJSON PanelRendererStack = consolecore.PanelRendererStack PanelStackLayoutGrid = consolecore.PanelStackLayoutGrid PanelCountArrayLength = consolecore.PanelCountArrayLength PanelCountObjectKeys = consolecore.PanelCountObjectKeys PanelCountTruthy = consolecore.PanelCountTruthy PanelCountNumber = consolecore.PanelCountNumber PanelFilterSearch = consolecore.PanelFilterSearch PanelFilterSelect = consolecore.PanelFilterSelect PanelFilterCheckbox = consolecore.PanelFilterCheckbox PanelEventReplace = consolecore.PanelEventReplace PanelEventAppend = consolecore.PanelEventAppend PanelEventMerge = consolecore.PanelEventMerge PanelEventUpsert = consolecore.PanelEventUpsert PanelActionLayoutList = consolecore.PanelActionLayoutList PanelActionLayoutSelect = consolecore.PanelActionLayoutSelect )
Variables ¶
This section is empty.
Functions ¶
func PanelDefinitionHasAction ¶ added in v0.100.0
func PanelDefinitionHasAction(def PanelDefinition, actionID string) bool
func PanelsForEventType ¶
PanelsForEventType returns panel IDs that subscribe to an event type.
func RegisterPanel ¶
func RegisterPanel(id string, config PanelConfig) error
RegisterPanel registers a panel in the default registry.
func RegistryVersion ¶
func RegistryVersion() string
RegistryVersion returns the default registry version identifier.
func SetRegistryVersion ¶
func SetRegistryVersion(version string)
SetRegistryVersion sets a version identifier for the default registry.
func UnregisterPanel ¶
func UnregisterPanel(id string)
UnregisterPanel removes a panel from the default registry.
Types ¶
type PanelActionEvent ¶ added in v0.69.0
type PanelActionEvent = consolecore.PanelActionEvent
type PanelActionHandler ¶ added in v0.69.0
type PanelActionHandler = consolecore.PanelActionHandler
type PanelActionHandlerResolver ¶ added in v0.116.0
type PanelActionHandlerResolver = consolecore.PanelActionHandlerResolver
type PanelActionRequest ¶ added in v0.69.0
type PanelActionRequest = consolecore.PanelActionRequest
type PanelActionResult ¶ added in v0.69.0
type PanelActionResult = consolecore.PanelActionResult
type PanelClearCheckFunc ¶ added in v0.124.0
type PanelClearCheckFunc = consolecore.PanelClearCheckFunc
type PanelClearFunc ¶
type PanelClearFunc = consolecore.PanelClearFunc
type PanelConfig ¶
type PanelConfig = consolecore.PanelConfig
type PanelDefinition ¶
type PanelDefinition = consolecore.PanelDefinition
func PanelDefinitionFor ¶
func PanelDefinitionFor(id string) (PanelDefinition, bool)
PanelDefinitionFor retrieves panel metadata from the default registry.
func PanelDefinitionForContext ¶ added in v0.88.0
func PanelDefinitionForContext(ctx context.Context, id string) (PanelDefinition, bool)
PanelDefinitionForContext retrieves panel metadata adapted for a request context.
func PanelDefinitions ¶
func PanelDefinitions() []PanelDefinition
PanelDefinitions returns definitions for all registered panels.
func PanelDefinitionsWithContext ¶ added in v0.88.0
func PanelDefinitionsWithContext(ctx context.Context) []PanelDefinition
PanelDefinitionsWithContext returns definitions adapted for a request context.
type PanelDefinitionFilter ¶ added in v0.88.0
type PanelDefinitionFilter = consolecore.PanelDefinitionFilter
type PanelRegistration ¶
type PanelRegistration = consolecore.PanelRegistration
func Panel ¶
func Panel(id string) (PanelRegistration, bool)
Panel retrieves a registered panel from the default registry.
func PanelRegistrations ¶
func PanelRegistrations() []PanelRegistration
PanelRegistrations returns all registered panels with hooks.
type PanelRegistry ¶
type PanelRegistry = consolecore.PanelRegistry
func DefaultRegistry ¶ added in v0.139.0
func DefaultRegistry() *PanelRegistry
DefaultRegistry returns the legacy Debug-only registry. New consoles require an explicit registry.
func NewPanelRegistry ¶
func NewPanelRegistry() *PanelRegistry
type PanelSnapshotFunc ¶
type PanelSnapshotFunc = consolecore.PanelSnapshotFunc
type PanelUI ¶ added in v0.69.0
type PanelUI = consolecore.PanelUI
func NewPanelUI ¶ added in v0.69.0
func NewPanelUI(console, toolbar *PanelUIView) *PanelUI
type PanelUIAction ¶ added in v0.69.0
type PanelUIAction = consolecore.PanelUIAction
type PanelUIActionField ¶ added in v0.88.0
type PanelUIActionField = consolecore.PanelUIActionField
type PanelUIActionForm ¶ added in v0.116.0
type PanelUIActionForm = consolecore.PanelUIActionForm
type PanelUIActionLayout ¶ added in v0.90.0
type PanelUIActionLayout = consolecore.PanelUIActionLayout
type PanelUIActionOption ¶ added in v0.114.4
type PanelUIActionOption = consolecore.PanelUIActionOption
type PanelUIActionOptionSource ¶ added in v0.114.4
type PanelUIActionOptionSource = consolecore.PanelUIActionOptionSource
type PanelUIColumn ¶ added in v0.69.0
type PanelUIColumn = consolecore.PanelUIColumn
type PanelUICount ¶ added in v0.69.0
type PanelUICount = consolecore.PanelUICount
type PanelUIEventPolicy ¶ added in v0.69.0
type PanelUIEventPolicy = consolecore.PanelUIEventPolicy
type PanelUIField ¶ added in v0.69.0
type PanelUIField = consolecore.PanelUIField
type PanelUIFilter ¶ added in v0.69.0
type PanelUIFilter = consolecore.PanelUIFilter
type PanelUIMetric ¶ added in v0.69.0
type PanelUIMetric = consolecore.PanelUIMetric
type PanelUIView ¶ added in v0.69.0
type PanelUIView = consolecore.PanelUIView
func GridStackView ¶ added in v0.123.0
func GridStackView(sections ...PanelUIView) *PanelUIView
func IdentityView ¶ added in v0.123.0
func IdentityView(bind string) *PanelUIView
func JSONView ¶ added in v0.69.0
func JSONView(bind string) *PanelUIView
func KeyValueView ¶ added in v0.69.0
func KeyValueView(bind string) *PanelUIView
func MetricsView ¶ added in v0.69.0
func MetricsView(bind string) *PanelUIView
func PanelView ¶ added in v0.69.0
func PanelView(renderer, bind string) *PanelUIView
func StackView ¶ added in v0.69.0
func StackView(sections ...PanelUIView) *PanelUIView
func StatusListView ¶ added in v0.69.0
func StatusListView(bind string) *PanelUIView
func TableView ¶ added in v0.69.0
func TableView(bind string) *PanelUIView
func TimelineView ¶ added in v0.69.0
func TimelineView(bind string) *PanelUIView
type PanelUIViews ¶ added in v0.69.0
type PanelUIViews = consolecore.PanelUIViews