Skip to main content

TechDocsReaderPageValue

Home > @backstage/plugin-techdocs-react > TechDocsReaderPageValue

type for the value of the TechDocsReaderPageContext

Signature:

export type TechDocsReaderPageValue = {
metadata: AsyncState<TechDocsMetadata>;
entityRef: CompoundEntityRef;
entityMetadata: AsyncState<TechDocsEntityMetadata>;
shadowRoot?: ShadowRoot;
setShadowRoot: Dispatch<SetStateAction<ShadowRoot | undefined>>;
title: string;
setTitle: Dispatch<SetStateAction<string>>;
subtitle: string;
setSubtitle: Dispatch<SetStateAction<string>>;
onReady?: () => void;
};

References: TechDocsMetadata, CompoundEntityRef, TechDocsEntityMetadata