## API Report File for "@backstage/plugin-techdocs" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts import { AnyApiFactory } from '@backstage/frontend-plugin-api'; import { AnyRouteRefParams } from '@backstage/frontend-plugin-api'; import { ApiFactory } from '@backstage/frontend-plugin-api'; import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; import { defaultEntityContentGroups } from '@backstage/plugin-catalog-react/alpha'; import { Entity } from '@backstage/catalog-model'; import { ExtensionBlueprintParams } from '@backstage/frontend-plugin-api'; import { ExtensionDataRef } from '@backstage/frontend-plugin-api'; import { ExtensionInput } from '@backstage/frontend-plugin-api'; import { FilterPredicate } from '@backstage/filter-predicates'; import { IconComponent } from '@backstage/frontend-plugin-api'; import { IconElement } from '@backstage/frontend-plugin-api'; import { IconLinkVerticalProps } from '@backstage/core-components'; import { JSX as JSX_2 } from 'react'; import { JSXElementConstructor } from 'react'; import { OverridableExtensionDefinition } from '@backstage/frontend-plugin-api'; import { OverridableFrontendPlugin } from '@backstage/frontend-plugin-api'; import { ReactElement } from 'react'; import { RouteRef } from '@backstage/core-plugin-api'; import { RouteRef as RouteRef_2 } from '@backstage/frontend-plugin-api'; import { SearchResultItemExtensionComponent } from '@backstage/plugin-search-react/alpha'; import { SearchResultItemExtensionPredicate } from '@backstage/plugin-search-react/alpha'; import { SearchResultListItemBlueprintParams } from '@backstage/plugin-search-react/alpha'; import { TechDocsAddonOptions } from '@backstage/plugin-techdocs-react'; // @alpha (undocumented) const _default: OverridableFrontendPlugin< { root: RouteRef; docRoot: RouteRef<{ name: string; kind: string; namespace: string; }>; entityContent: RouteRef; }, {}, { 'api:techdocs': OverridableExtensionDefinition<{ kind: 'api'; name: undefined; config: {}; configInput: {}; output: ExtensionDataRef; inputs: {}; params: < TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown }, >( params: ApiFactory, ) => ExtensionBlueprintParams; }>; 'api:techdocs/addons': OverridableExtensionDefinition<{ config: {}; configInput: {}; output: ExtensionDataRef; inputs: { addons: ExtensionInput< ConfigurableExtensionDataRef< TechDocsAddonOptions, 'techdocs.addon', {} >, { singleton: false; optional: false; internal: false; } >; }; kind: 'api'; name: 'addons'; params: < TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown }, >( params: ApiFactory, ) => ExtensionBlueprintParams; }>; 'api:techdocs/storage': OverridableExtensionDefinition<{ kind: 'api'; name: 'storage'; config: {}; configInput: {}; output: ExtensionDataRef; inputs: {}; params: < TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown }, >( params: ApiFactory, ) => ExtensionBlueprintParams; }>; 'empty-state:techdocs/entity-content': OverridableExtensionDefinition<{ config: {}; configInput: {}; output: ExtensionDataRef< JSX_2.Element, 'core.reactElement', { optional: true; } >; inputs: { [x: string]: ExtensionInput< ExtensionDataRef, { singleton: boolean; optional: boolean; internal?: boolean; } >; }; params: never; kind: 'empty-state'; name: 'entity-content'; }>; 'entity-content:techdocs': OverridableExtensionDefinition<{ config: { path: string | undefined; title: string | undefined; filter: FilterPredicate | undefined; group: string | false | undefined; icon: string | undefined; }; configInput: { path?: string | undefined; title?: string | undefined; filter?: FilterPredicate | undefined; group?: string | false | undefined; icon?: string | undefined; }; output: | ExtensionDataRef | ExtensionDataRef< RouteRef_2, 'core.routing.ref', { optional: true; } > | ExtensionDataRef | ExtensionDataRef< (entity: Entity) => boolean, 'catalog.entity-filter-function', { optional: true; } > | ExtensionDataRef< string, 'catalog.entity-filter-expression', { optional: true; } > | ExtensionDataRef | ExtensionDataRef< string, 'catalog.entity-content-group', { optional: true; } > | ExtensionDataRef< string | ReactElement>, 'catalog.entity-content-icon', { optional: true; } >; inputs: { addons: ExtensionInput< ConfigurableExtensionDataRef< TechDocsAddonOptions, 'techdocs.addon', {} >, { singleton: false; optional: false; internal: false; } >; emptyState: ExtensionInput< ConfigurableExtensionDataRef< JSX_2.Element, 'core.reactElement', { optional: true; } >, { singleton: true; optional: true; internal: false; } >; }; kind: 'entity-content'; name: undefined; params: { defaultPath?: [Error: `Use the 'path' param instead`]; path: string; defaultTitle?: [Error: `Use the 'title' param instead`]; title: string; defaultGroup?: [Error: `Use the 'group' param instead`]; group?: keyof defaultEntityContentGroups | (string & {}); icon?: string | ReactElement; loader: () => Promise; routeRef?: RouteRef_2; filter?: string | FilterPredicate | ((entity: Entity) => boolean); }; }>; 'entity-icon-link:techdocs/read-docs': OverridableExtensionDefinition<{ kind: 'entity-icon-link'; name: 'read-docs'; config: { label: string | undefined; title: string | undefined; filter: FilterPredicate | undefined; }; configInput: { label?: string | undefined; title?: string | undefined; filter?: FilterPredicate | undefined; }; output: | ExtensionDataRef< (entity: Entity) => boolean, 'catalog.entity-filter-function', { optional: true; } > | ExtensionDataRef< string, 'catalog.entity-filter-expression', { optional: true; } > | ExtensionDataRef< () => IconLinkVerticalProps, 'entity-icon-link-props', {} >; inputs: {}; params: { useProps: () => Omit; filter?: FilterPredicate | ((entity: Entity) => boolean); }; }>; 'nav-item:techdocs': OverridableExtensionDefinition<{ kind: 'nav-item'; name: undefined; config: { title: string | undefined; }; configInput: { title?: string | undefined; }; output: ExtensionDataRef< { title: string; icon: IconComponent; routeRef: RouteRef_2; }, 'core.nav-item.target', {} >; inputs: {}; params: { title: string; icon: IconComponent; routeRef: RouteRef_2; }; }>; 'page:techdocs': OverridableExtensionDefinition<{ kind: 'page'; name: undefined; config: { path: string | undefined; title: string | undefined; }; configInput: { path?: string | undefined; title?: string | undefined; }; output: | ExtensionDataRef | ExtensionDataRef< RouteRef_2, 'core.routing.ref', { optional: true; } > | ExtensionDataRef | ExtensionDataRef< string, 'core.title', { optional: true; } > | ExtensionDataRef< IconElement, 'core.icon', { optional: true; } >; inputs: { pages: ExtensionInput< | ConfigurableExtensionDataRef | ConfigurableExtensionDataRef | ConfigurableExtensionDataRef< RouteRef_2, 'core.routing.ref', { optional: true; } > | ConfigurableExtensionDataRef< string, 'core.title', { optional: true; } > | ConfigurableExtensionDataRef< IconElement, 'core.icon', { optional: true; } >, { singleton: false; optional: false; internal: false; } >; }; params: { path: string; title?: string; icon?: IconElement; loader?: () => Promise; routeRef?: RouteRef_2; noHeader?: boolean; }; }>; 'page:techdocs/reader': OverridableExtensionDefinition<{ config: { withoutSearch: boolean; withoutHeader: boolean; path: string | undefined; title: string | undefined; }; configInput: { withoutSearch?: boolean | undefined; withoutHeader?: boolean | undefined; path?: string | undefined; title?: string | undefined; }; output: | ExtensionDataRef | ExtensionDataRef< RouteRef_2, 'core.routing.ref', { optional: true; } > | ExtensionDataRef | ExtensionDataRef< string, 'core.title', { optional: true; } > | ExtensionDataRef< IconElement, 'core.icon', { optional: true; } >; inputs: { pages: ExtensionInput< | ConfigurableExtensionDataRef | ConfigurableExtensionDataRef | ConfigurableExtensionDataRef< RouteRef_2, 'core.routing.ref', { optional: true; } > | ConfigurableExtensionDataRef< string, 'core.title', { optional: true; } > | ConfigurableExtensionDataRef< IconElement, 'core.icon', { optional: true; } >, { singleton: false; optional: false; internal: false; } >; addons: ExtensionInput< ConfigurableExtensionDataRef< TechDocsAddonOptions, 'techdocs.addon', {} >, { singleton: false; optional: false; internal: false; } >; }; kind: 'page'; name: 'reader'; params: { path: string; title?: string; icon?: IconElement; loader?: () => Promise; routeRef?: RouteRef_2; noHeader?: boolean; }; }>; 'plugin-header-action:techdocs': OverridableExtensionDefinition<{ kind: 'plugin-header-action'; name: undefined; config: {}; configInput: {}; output: ExtensionDataRef; inputs: {}; params: { loader: () => Promise; }; }>; 'search-result-list-item:techdocs': OverridableExtensionDefinition<{ config: { title: string | undefined; lineClamp: number; asLink: boolean; asListItem: boolean; noTrack: boolean; }; configInput: { title?: string | undefined; lineClamp?: number | undefined; asLink?: boolean | undefined; asListItem?: boolean | undefined; noTrack?: boolean | undefined; }; output: ExtensionDataRef< { predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; icon?: JSX_2.Element; }, 'search.search-result-list-item.item', {} >; inputs: {}; kind: 'search-result-list-item'; name: undefined; params: SearchResultListItemBlueprintParams; }>; } >; export default _default; // @alpha (undocumented) export const techDocsSearchResultListItemExtension: OverridableExtensionDefinition<{ config: { title: string | undefined; lineClamp: number; asLink: boolean; asListItem: boolean; noTrack: boolean; }; configInput: { title?: string | undefined; lineClamp?: number | undefined; asLink?: boolean | undefined; asListItem?: boolean | undefined; noTrack?: boolean | undefined; }; output: ExtensionDataRef< { predicate?: SearchResultItemExtensionPredicate; component: SearchResultItemExtensionComponent; icon?: JSX_2.Element; }, 'search.search-result-list-item.item', {} >; inputs: {}; kind: 'search-result-list-item'; name: undefined; params: SearchResultListItemBlueprintParams; }>; // (No @packageDocumentation comment for this package) ```