@backstage/plugin-techdocs-react
Home > @backstage/plugin-techdocs-react
Package encapsulating utilities to be shared by frontend TechDocs plugins.
Functions
Function |
Description |
---|---|
Create a TechDocs addon overload signature without props. | |
Create a TechDocs addon overload signature with props. | |
Renders a tree of elements in a Shadow DOM. | |
Lower-case entity triplets by default, but allow override. | |
Returns the style's loading state. | |
Hook for use within TechDocs addons that provides access to the underlying shadow root of the current page, allowing the DOM within to be mutated. | |
Convenience hook for use within TechDocs addons that provides access to elements that match a given selector within the shadow root. | |
Hook for retrieving a selection within the ShadowRoot. | |
hook to use addons in components | |
Hook used to get access to shared state between reader page components. |
Interfaces
Interface |
Description |
---|---|
API to talk to techdocs-backend. | |
API which talks to TechDocs storage to fetch files to render. |
Variables
Variable |
Description |
---|---|
Name for the event dispatched when ShadowRoot styles are loaded. | |
Key for each addon. | |
Marks the | |
Locations for which TechDocs addons may be declared and rendered. | |
TechDocs Addon registry. | |
Utility API reference for the TechDocsApi. | |
A context to store the reader page state | |
Utility API reference for the TechDocsStorageApi. |
Type Aliases
Type Alias |
Description |
---|---|
The outcome of a docs sync operation. | |
Options for creating a TechDocs addon. | |
Metadata for TechDocs Entity | |
Metadata for TechDocs page | |
Props for TechDocsReaderPageProvider | |
render function for TechDocsReaderPageProvider | |
type for the value of the TechDocsReaderPageContext | |
Props for TechDocsShadowDom(). |