plugin/registry

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	-
AppThemeRegistrationOptions	Options that control app theme registration.
CallbackActionOptions	-
ClusterChooserProps	-
ClusterSettingsViewLoadedEvent	Event fired when the cluster settings view is loaded.
CreateProjectEvent	Event fired when a project is to be created.
CreateResourceEvent	Event fired when creating a resource.
DeleteProjectEvent	Event fired when a project is to be deleted.
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	-
PluginDetailsViewLoadedEvent	Event fired when a plugin's settings details view is loaded.
PluginListViewLoadedEvent	Event fired when the plugin list is loaded in the settings view.
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.
ProjectDetailsTabChangeEvent	Event fired when the user switches to a different tab in the project details view.
ProjectDetailsViewLoadedEvent	Event fired when a project is loaded in the project details view.
ProjectListViewLoadedEvent	Event fired when the project list view is loaded.
Relation	-
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	-
SettingsViewLoadedEvent	Event fired when the general settings view is loaded.
SidebarEntryProps	Represents an entry in the sidebar menu.
TerminalEvent	Event fired when using the terminal.

Type Aliases

Type Alias	Description
AppBarActionProcessorType	-
AppLogoType	-
ClusterChooserType	-
DetailsViewHeaderActionsProcessor	-
DetailsViewHeaderActionType	-
DetailsViewSectionType	-
GraphSource	Graph Source defines a group of Nodes and Edges that can be loaded on the Map
HeadlampEventCallback	-
PluginRunCommand	Runs a shell command and returns an object that mimics the interface of a ChildProcess object returned by Node's spawn function.
PluginSettingsComponentType	PluginSettingsComponentType is the type of the component associated with the plugin's settings.
sectionFunc	-

Variables

Variable	Description
DefaultCreateProject	IDs plugins can register to replace Headlamp's built-in project creation options.
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
registerClusterEmptyState	Replace the empty state shown on the Home page when no clusters are configured.
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.
registerHomeSidebarEntryFilter	Filter HOME sidebar menu items (return null to remove, or return a modified entry to update it).
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.
registerProjectApiResource	Register a custom API resource to be included in Project resource fetching.
registerProjectDeleteButton	Override default project delete button
registerProjectDetailsTab	Register a new tab in the project details view.
registerProjectGrouping	Register custom grouping for project namespaces.
registerProjectHeaderAction	Register a new action button in the project details header.
registerProjectOverviewSection	Register a new section in the project overview page.
registerResourceRelationProvider	Registers a custom resource relation definition (a Relation object) for the Resource Map.
registerResourceTableColumnsProcessor	Add a processor for the resource table columns. Allowing the modification of what tables show.
registerRoute	Add a Route for a component.
registerRouteFilter	Filter or modify routes.
registerSetTokenFunction	Override headlamp setToken method
registerSidebarEntry	Add a Sidebar Entry to the menu (on the left side of Headlamp).
registerSidebarEntryFilter	Filter or modify IN_CLUSTER sidebar menu items.
registerUIPanel	Registers a UI panel in the application's UI.
runCommand	-

References

ApiResource

Re-exports ApiResource