import { CompoundEntityRef } from '@backstage/catalog-model'; /** * Props for {@link TechDocsReaderPageContent} * @public */ export type TechDocsReaderPageContentProps = { /** * @deprecated No need to pass down entityRef as property anymore. Consumes the entityName from `TechDocsReaderPageContext`. Use the {@link @backstage/plugin-techdocs-react#useTechDocsReaderPage} hook for custom reader page content. */ entityRef?: CompoundEntityRef; /** * Path in the docs to render by default. This should be used when rendering docs for an entity that specifies the * "backstage.io/techdocs-entity-path" annotation for deep linking into another entities docs. */ defaultPath?: string; /** * Show or hide the search bar, defaults to true. */ withSearch?: boolean; /** * If {@link TechDocsReaderPageContentProps.withSearch | withSearch} is true, * this will redirect the search result urls, e.g. turn search results into * links within the "Docs" tab of the entity page, instead of the global docs * page. */ searchResultUrlMapper?: (url: string) => string; /** * Callback called when the content is rendered. */ onReady?: () => void; }; /** * Renders the reader page content * @public */ export declare const TechDocsReaderPageContent: (props: TechDocsReaderPageContentProps) => import("react/jsx-runtime").JSX.Element; /** * Props for {@link Reader} * * @public * @deprecated use `TechDocsReaderPageContentProps` instead. */ export type ReaderProps = TechDocsReaderPageContentProps; /** * Component responsible for rendering TechDocs documentation * @public * @deprecated use `TechDocsReaderPageContent` component instead. */ export declare const Reader: (props: TechDocsReaderPageContentProps) => import("react/jsx-runtime").JSX.Element;