@openshift-console/dynamic-plugin-sdk/lib/extensions/navigation.d.ts

Provides core APIs, types and utilities used by dynamic plugins at runtime.

import { ExtensionK8sModel } from '../api/common-types';
import { Extension, ExtensionDeclaration } from '../types';
type NavItemProperties = {
    /** A unique identifier for this item. */
    id: string;
    /** The perspective ID to which this item belongs to. If not specified, contributes to the default perspective. */
    perspective?: string;
    /** Navigation section to which this item belongs to. If not specified, render this item as a top level link. */
    section?: string;
    /** Adds data attributes to the DOM. */
    dataAttributes?: {
        [key: string]: string;
    };
    /** Mark this item as active when the URL starts with one of these paths. */
    startsWith?: string[];
    /** Insert this item before the item referenced here. For arrays, the first one found in order is used. */
    insertBefore?: string | string[];
    /** Insert this item after the item referenced here. For arrays, the first one found in order is used. `insertBefore` takes precedence. */
    insertAfter?: string | string[];
};
export type NavItem = ExtensionDeclaration<'console.navigation/href', NavItemProperties & {
    name: string;
}>;
/** This extension can be used to contribute a navigation item that points to a specific link in the UI. */
export type HrefNavItem = ExtensionDeclaration<'console.navigation/href', NavItemProperties & {
    /** The name of this item. */
    name: string;
    /** The link href value. */
    href: string;
    /** if true, adds /ns/active-namespace to the end */
    namespaced?: boolean;
    /** if true, adds /k8s/ns/active-namespace to the begining */
    prefixNamespaced?: boolean;
}>;
/** This extension can be used to contribute a navigation item that points to a namespaced resource details page.
    The K8s model of that resource can be used to define the navigation item. */
export type ResourceNSNavItem = ExtensionDeclaration<'console.navigation/resource-ns', NavItemProperties & {
    /** Overrides the default name. If not supplied the name of the link will equal the plural value of the model. */
    name?: string;
    /** The model for which this nav item links to. */
    model: ExtensionK8sModel;
}>;
/** This extension can be used to contribute a navigation item that points to a cluster resource details page.
    The K8s model of that resource can be used to define the navigation item. */
export type ResourceClusterNavItem = ExtensionDeclaration<'console.navigation/resource-cluster', NavItemProperties & {
    /** Overrides the default name. If not supplied the name of the link will equal the plural value of the model. */
    name?: string;
    /** The model for which this nav item links to. */
    model: ExtensionK8sModel;
}>;
/** This extension can be used to add a separator between navigation items in the navigation. */
export type Separator = ExtensionDeclaration<'console.navigation/separator', Omit<NavItemProperties, 'startsWith'>>;
/** This extension can be used to define a new section of navigation items in the navigation tab. */
export type NavSection = ExtensionDeclaration<'console.navigation/section', Omit<NavItemProperties, 'startsWith' | 'section'> & {
    /** Name of this section. If not supplied, only a separator will be shown above the section. */
    name?: string;
}>;
export type ResourceNavItem = ResourceClusterNavItem | ResourceNSNavItem;
export type NavExtension = NavSection | Separator | HrefNavItem | ResourceNSNavItem | ResourceClusterNavItem;
export declare const isHrefNavItem: (e: Extension) => e is HrefNavItem;
export declare const isResourceNSNavItem: (e: Extension) => e is ResourceNSNavItem;
export declare const isResourceClusterNavItem: (e: Extension) => e is ResourceClusterNavItem;
export declare const isResourceNavItem: (e: Extension) => e is ResourceNavItem;
export declare const isSeparator: (e: Extension) => e is Separator;
export declare const isNavSection: (e: Extension) => e is NavSection;
export declare const isNavItem: (e: Extension) => e is NavItem;
export declare const isNavItemOrSeparator: (e: Extension) => e is NavItem | Separator;
export declare const isNavExtension: (e: Extension) => e is NavExtension;
export {};