plugin/registry

Index

Enumerations

Enumeration	Description
DefaultAppBarAction	-
DefaultDetailsViewSection	-
DefaultSidebars	-

Classes

Class	Description
ConfigStore	A class to manage the configuration state for plugins in a Redux store.
PluginManager	A wrapper class for initiating calls to Electron via desktopApi for managing plugins.
Registry	-

Interfaces

Interface	Description
AppLogoProps	-
CallbackActionOptions	-
ClusterChooserProps	-
CreateResourceEvent	Event fired when creating a resource.
DeleteResourceEvent	Event fired when a resource is to be deleted.
DetailsViewSectionProps	-
EditResourceEvent	Event fired when editing a resource.
ErrorBoundaryEvent	Event fired when an error boundary is triggered.
EventListEvent	Event fired when kubernetes events are loaded (for a resource or not).
HeadlampEvent	Represents a Headlamp event. It can be one of the default events or a custom event.
IconDefinition	-
LogsEvent	Event fired when viewing pod logs.
OverviewChartsProcessor	-
PluginLoadingErrorEvent	Event fired when there is an error while loading a plugin.
PluginSettingsDetailsProps	Props for PluginSettingsDetailsProps component.
PluginsLoadedEvent	Event fired when all plugins are loaded.
PodAttachEvent	Event fired when attaching to a pod.
ResourceDetailsViewLoadedEvent	Event fired when a resource is loaded in the details view.
ResourceListViewLoadedEvent	Event fired when a list view is loaded for a resource.
RestartResourceEvent	Event fired when restarting a resource.
ScaleResourceEvent	Event fired when scaling a resource.
SectionFuncProps	-
SidebarEntryProps	Represents an entry in the sidebar menu.
TerminalEvent	Event fired when using the terminal.

Type Aliases

Type alias	Description
AppBarActionProcessorType	-
AppLogoType	-
ClusterChooserType	-
DetailsViewHeaderActionType	-
DetailsViewHeaderActionsProcessor	-
DetailsViewSectionType	-
GraphSource	Graph Source defines a group of Nodes and Edges that can be loaded on the Map
HeadlampEventCallback	-
PluginSettingsComponentType	PluginSettingsComponentType is the type of the component associated with the plugin's settings.
sectionFunc	-

Variables

Variable	Description
DefaultHeadlampEvents	-
DetailsViewDefaultHeaderActions	-

Functions

Function	Description
clusterAction	Starts an action after a period of time giving the user an opportunity to cancel the action.
getHeadlampAPIHeaders	Returns headers for making API calls to the headlamp-server backend.
registerAddClusterProvider	For adding a card to the Add Cluster page in the providers list.
registerAppBarAction	Add a component into the app bar (at the top of the app).
registerAppLogo	Add a logo for Headlamp to use instead of the default one.
registerAppTheme	Add a new theme that will be available in the settings. Theme name should be unique
registerClusterChooser	Use a custom cluster chooser button
registerClusterProviderDialog	Register a new cluster provider dialog.
registerClusterProviderMenuItem	Register a new cluster action menu item.
registerClusterStatus	Register a new cluster status component.
registerCustomCreateProject	Register a new way to create Headlamp 'Projects'
registerDetailsViewHeaderAction	Add a component into the details view header.
registerDetailsViewHeaderActionsProcessor	Add a processor for the details view header actions. Allowing the modification of header actions.
registerDetailsViewSection	Append a component to the details view for a given resource.
registerDetailsViewSectionsProcessor	Add a processor for the details view sections. Allowing the modification of what sections are shown.
registerGetTokenFunction	Override headlamp getToken method
registerHeadlampEventCallback	Add a callback for headlamp events.
registerKindIcon	Register Icon for a resource kind
registerKubeObjectGlance	Custom glance component for Kubernetes objects in Headlamp's graph view.
registerMapSource	Registers a new graph source in the store.
registerOverviewChartsProcessor	Add a processor for the overview charts section. Allowing the addition or modification of charts.
registerPluginSettings	Register a plugin settings component.
registerProjectDeleteButton	Override default project delete button
registerProjectDetailsTab	Register a new tab in the project details view.
registerProjectOverviewSection	Register a new section in the project overview page.
registerResourceTableColumnsProcessor	Add a processor for the resource table columns. Allowing the modification of what tables show.
registerRoute	Add a Route for a component.
registerRouteFilter	Remove routes.
registerSetTokenFunction	Override headlamp setToken method
registerSidebarEntry	Add a Sidebar Entry to the menu (on the left side of Headlamp).
registerSidebarEntryFilter	Remove sidebar menu items.
registerUIPanel	Registers a UI panel in the application's UI.
runCommand	Runs a shell command and returns an object that mimics the interface of a ChildProcess object returned by Node's spawn function.