TechDocsReaderPageRenderFunction

Home > @backstage/plugin-techdocs > TechDocsReaderPageRenderFunction

Helper function that gives the children of TechDocsReaderPage() access to techdocs and entity metadata

Signature:

export type TechDocsReaderPageRenderFunction = (options: {
    techdocsMetadataValue?: TechDocsMetadata | undefined;
    entityMetadataValue?: TechDocsEntityMetadata | undefined;
    entityRef: CompoundEntityRef;
    onReady?: () => void;
}) => JSX.Element;

References: TechDocsMetadata, TechDocsEntityMetadata, CompoundEntityRef