Skip to main content

Function: registerDetailsViewSectionsProcessor()

function registerDetailsViewSectionsProcessor(processor: DetailsViewSectionProcessorType | DetailsViewSectionsProcessor): void

Add a processor for the details view sections. Allowing the modification of what sections are shown.

Parameters

ParameterTypeDescription
processorDetailsViewSectionProcessorType | DetailsViewSectionsProcessorThe processor to add. Receives a resource (for which we are processing the sections) and the current sections and returns the new sections. Return an empty array to remove all sections.

Returns

void

Example

import { registerDetailsViewSectionsProcessor } from '@kinvolk/headlamp-plugin/lib';

registerDetailsViewSectionsProcessor(function addTopSection( resource, sections ) {
// Ignore if there is no resource.
if (!resource) {
return sections;
}

// Check if we already have added our custom section (this function may be called multiple times).
const customSectionId = 'my-custom-section';
if (sections.findIndex(section => section.id === customSectionId) !== -1) {
return sections;
}

return [
{
id: 'my-custom-section',
section: (
<SectionBox title="I'm the top of the world!" />
),
},
...sections,
];
});

Defined in

src/plugin/registry.tsx:522