api-report.md

API Report File for "@backstage/dev-utils"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="react" />

import { ApiFactory } from '@backstage/core-plugin-api';
import { AppTheme } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { ComponentType } from 'react';
import { Entity } from '@backstage/catalog-model';
import { GridProps } from '@material-ui/core';
import { IconComponent } from '@backstage/core-plugin-api';
import { PropsWithChildren } from 'react';
import { ReactNode } from 'react';

// @public
export function createDevApp(): DevAppBuilder;

// @public
export class DevAppBuilder {
  addPage(opts: DevAppPageOptions): DevAppBuilder;
  addRootChild(node: ReactNode): DevAppBuilder;
  addThemes(themes: AppTheme[]): this;
  build(): ComponentType<PropsWithChildren<{}>>;
  registerApi<
    Api,
    Impl extends Api,
    Deps extends {
      [name in string]: unknown;
    },
  >(factory: ApiFactory<Api, Impl, Deps>): DevAppBuilder;
  registerPlugin(...plugins: BackstagePlugin[]): DevAppBuilder;
  render(): void;
}

// @public (undocumented)
export type DevAppPageOptions = {
  path?: string;
  element: JSX.Element;
  children?: JSX.Element;
  title?: string;
  icon?: IconComponent;
};

// @public (undocumented)
export const EntityGridItem: (
  props: Omit<GridProps, 'item' | 'container'> & {
    entity: Entity;
  },
) => JSX.Element;