Class: default

    plugin/registry .default

    Constructors

    constructor

    + new default(): default

    Returns: default

    Methods

    registerAppBarAction

    registerAppBarAction(actionName: string, actionFunc: (…args: any[]) => null | Element): void

    Add a component into the app bar (at the top of the app).

    example

    register.registerAppBarAction('monitor', () => <MonitorLink /> );
    

    Parameters:

    Name Type Description
    actionName string a unique name for it
    actionFunc (…args: any[]) => null | Element a function that returns your component

    Returns: void

    Defined in: plugin/registry.tsx:101


    registerDetailsViewHeaderAction

    registerDetailsViewHeaderAction(actionName: string, actionFunc: (…args: any[]) => null | Element): void

    Add a component into the details view header.

    example

    register.registerDetailsViewHeaderAction('traces', (props) =>
      <TraceIcon {...props} />
    );
    

    Parameters:

    Name Type Description
    actionName string a unique name for it
    actionFunc (…args: any[]) => null | Element a function that returns your component with props to pass into it.

    Returns: void

    Defined in: plugin/registry.tsx:82


    registerRoute

    registerRoute(routeSpec: Route): void

    Add a Route for a component.

    see Route examples

    example

    // Add a route that will display the given component and select
    // the "traces" sidebar item.
    register.registerRoute({
      path: '/traces',
      sidebar: 'traces',
      component: () => <TraceList />
    });
    

    Parameters:

    Name Type Description
    routeSpec Route details of URL, highlighted sidebar and component to use.

    Returns: void

    Defined in: plugin/registry.tsx:63


    registerSidebarItem

    registerSidebarItem(parentName: string, itemName: string, itemLabel: string, url: string, opts?: { useClusterURL: boolean = true }): void

    Add a SidebarItem.

    example

    registerSidebarItem('cluster', 'traces', 'Traces', '/traces');
    

    Parameters:

    Name Type Default value Description
    parentName string - the name of the parent SidebarItem.
    itemName string - name of this SidebarItem.
    itemLabel string - label to display.
    url string - the URL to go to, when this item is followed.
    opts object - … todo
    opts.useClusterURL boolean true -

    Returns: void

    Defined in: plugin/registry.tsx:26