Skip to main content

Function: registerDetailsViewHeaderActionsProcessor()

function registerDetailsViewHeaderActionsProcessor(processor: HeaderActionsProcessor | HeaderActionFuncType): void;

Defined in: plugin/registry.tsx:522

Add a processor for the details view header actions. Allowing the modification of header actions.

Parameters​

ParameterTypeDescription
processorHeaderActionsProcessor | HeaderActionFuncTypeThe processor to add. Receives a resource (for which we are processing the header actions) and the current header actions and returns the new header actions. Return an empty array to remove all header actions.

Returns​

void

Example​

import { registerDetailsViewHeaderActionsProcessor, DetailsViewDefaultHeaderActions } from '@kinvolk/headlamp-plugin/lib';

// Processor that removes the default edit action.
registerDetailsViewHeaderActionsProcessor((resource, headerActions) => {
 return headerActions.filter(action => action.name !== DetailsViewDefaultHeaderActions.EDIT);
});

More complete detail view example in plugins/examples/details-view:
@see {@link https://github.com/kubernetes-sigs/headlamp/tree/main/plugins/examples/details-view Detail View Example}