Skip to main content

Function: registerRouteFilter()

function registerRouteFilter(filterFunc: (entry: Route) => Route | null): void;

Defined in: plugin/registry.tsx:444

Filter or modify routes.

Parameters​

ParameterTypeDescription
filterFunc(entry: Route) => Route | nulla function for filtering or modifying routes. Return null to remove the route, or the (optionally modified) route to keep it.

Returns​

void

Example​

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

registerRouteFilter(route => (route.path === '/workloads' ? null : route));