techdocs: hide Router emptyState prop in non-alpha public api
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
This commit is contained in:
@@ -56,11 +56,6 @@ export const Router = () => {
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Responsible for registering route to view docs on Entity page
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export const EmbeddedDocsRouter = (
|
||||
props: PropsWithChildren<{ emptyState?: React.ReactElement }>,
|
||||
) => {
|
||||
@@ -95,3 +90,14 @@ export const EmbeddedDocsRouter = (
|
||||
|
||||
return element;
|
||||
};
|
||||
|
||||
/**
|
||||
* Responsible for registering route to view docs on Entity page
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export const LegacyEmbeddedDocsRouter = (props: PropsWithChildren<{}>) => {
|
||||
// Wrap the Router to avoid exposing the emptyState prop in the non-alpha
|
||||
// public API and make it easier for us to change later.
|
||||
return <EmbeddedDocsRouter children={props.children} />;
|
||||
};
|
||||
|
||||
@@ -41,7 +41,11 @@ export {
|
||||
techdocsPlugin as plugin,
|
||||
techdocsPlugin,
|
||||
} from './plugin';
|
||||
export * from './Router';
|
||||
export {
|
||||
isTechDocsAvailable,
|
||||
LegacyEmbeddedDocsRouter as EmbeddedDocsRouter,
|
||||
Router,
|
||||
} from './Router';
|
||||
|
||||
export type { TechDocsSearchResultListItemProps } from './search/components/TechDocsSearchResultListItem';
|
||||
|
||||
|
||||
@@ -103,7 +103,7 @@ export const TechdocsPage = techdocsPlugin.provide(
|
||||
export const EntityTechdocsContent = techdocsPlugin.provide(
|
||||
createRoutableExtension({
|
||||
name: 'EntityTechdocsContent',
|
||||
component: () => import('./Router').then(m => m.EmbeddedDocsRouter),
|
||||
component: () => import('./Router').then(m => m.LegacyEmbeddedDocsRouter),
|
||||
mountPoint: rootCatalogDocsRouteRef,
|
||||
}),
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user