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

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

import * as React from 'react';
import { CodeRef, Extension, ExtensionDeclaration } from '../types';
import { Humanize, TopConsumerPopoverProps } from './console-types';
/** Adds a new inventory item into project overview page. */
export type ProjectOverviewInventoryItem = ExtensionDeclaration<'console.project-overview/inventory-item', {
    /** The component to be rendered. */
    component: CodeRef<React.ComponentType<{
        projectName: string;
    }>>;
}>;
export type GetProjectQuery = (projectName: string) => string;
/** Adds a new project overview utilization item. */
export type ProjectOverviewUtilizationItem = ExtensionDeclaration<'console.project-overview/utilization-item', {
    /** The title of the utilization item. */
    title: string;
    /** Prometheus utilization query. */
    getUtilizationQuery: CodeRef<GetProjectQuery>;
    /** Convert prometheus data to human readable form. */
    humanize: CodeRef<Humanize>;
    /** Prometheus total query. */
    getTotalQuery?: CodeRef<GetProjectQuery>;
    /** Prometheus request query. */
    getRequestQuery?: CodeRef<GetProjectQuery>;
    /** Prometheus limit query. */
    getLimitQuery?: CodeRef<GetProjectQuery>;
    /** Shows Top consumer popover instead of plain value */
    TopConsumerPopover?: CodeRef<React.ComponentType<TopConsumerPopoverProps>>;
}>;
export declare const isProjectOverviewInventoryItem: (e: Extension) => e is ProjectOverviewInventoryItem;
export declare const isProjectOverviewUtilizationItem: (e: Extension) => e is ProjectOverviewUtilizationItem;