From 90f5a457b52289da265552826b54a510631ca575 Mon Sep 17 00:00:00 2001 From: lukzerom Date: Fri, 17 Dec 2021 12:26:52 +0100 Subject: [PATCH] Docs update Signed-off-by: lukzerom --- packages/core-components/api-report.md | 23 +++++++++-------- .../HeaderIconLinkRow/HeaderIconLinkRow.tsx | 2 +- .../src/layout/Sidebar/Intro.tsx | 25 ++++++++++++------- 3 files changed, 29 insertions(+), 21 deletions(-) diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index f908d381e7..b3eb6a2fb0 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -309,7 +309,7 @@ export function EmailIcon(props: IconComponentProps): JSX.Element; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function EmptyState(props: Props_2): JSX.Element; // @public (undocumented) @@ -331,7 +331,7 @@ export type ErrorBoundaryProps = { // Warning: (ae-forgotten-export) The symbol "IErrorPageProps" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function ErrorPage(props: IErrorPageProps): JSX.Element; // @public (undocumented) @@ -364,7 +364,7 @@ export type FeatureCalloutCircleClassKey = // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function FeatureCalloutCircular( props: PropsWithChildren, ): JSX.Element; @@ -372,12 +372,12 @@ export function FeatureCalloutCircular( // @public (undocumented) export type FiltersContainerClassKey = 'root' | 'title'; -// @public (undocumented) +// @public export function Gauge(props: GaugeProps): JSX.Element; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function GaugeCard(props: Props_10): JSX.Element; // @public (undocumented) @@ -415,7 +415,7 @@ export function GroupIcon(props: IconComponentProps): JSX.Element; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function Header(props: PropsWithChildren): JSX.Element; // @public (undocumented) @@ -431,8 +431,9 @@ export type HeaderClassKey = | 'breadcrumbTitle'; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts +// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "IconLinkVertical" // -// @public (undocumented) +// @public export function HeaderIconLinkRow(props: Props_5): JSX.Element; // @public (undocumented) @@ -440,7 +441,7 @@ export type HeaderIconLinkRowClassKey = 'links'; // Warning: (ae-forgotten-export) The symbol "HeaderLabelProps" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function HeaderLabel(props: HeaderLabelProps): JSX.Element; // @public (undocumented) @@ -448,7 +449,7 @@ export type HeaderLabelClassKey = 'root' | 'label' | 'value'; // Warning: (ae-forgotten-export) The symbol "HeaderTabsProps" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function HeaderTabs(props: HeaderTabsProps): JSX.Element; // @public (undocumented) @@ -466,7 +467,7 @@ export function HomepageTimer(_props: {}): JSX.Element | null; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function HorizontalScrollGrid( props: PropsWithChildren, ): JSX.Element; @@ -506,7 +507,7 @@ export type IconLinkVerticalProps = { // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // -// @public (undocumented) +// @public export function InfoCard(props: Props_15): JSX.Element; // @public (undocumented) diff --git a/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx b/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx index caf023086b..beb44fc771 100644 --- a/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx +++ b/packages/core-components/src/components/HeaderIconLinkRow/HeaderIconLinkRow.tsx @@ -38,7 +38,7 @@ type Props = { }; /** - * List of links mapped to {@link IconLinkVertical | IconLinkVertical} + * HTML nav tag with links mapped inside * * @public * @remarks diff --git a/packages/core-components/src/layout/Sidebar/Intro.tsx b/packages/core-components/src/layout/Sidebar/Intro.tsx index 63b8db14ed..9dd41d6c3e 100644 --- a/packages/core-components/src/layout/Sidebar/Intro.tsx +++ b/packages/core-components/src/layout/Sidebar/Intro.tsx @@ -14,18 +14,18 @@ * limitations under the License. */ +import { BackstageTheme } from '@backstage/theme'; +import Collapse from '@material-ui/core/Collapse'; +import Link from '@material-ui/core/Link'; +import { makeStyles } from '@material-ui/core/styles'; +import Typography from '@material-ui/core/Typography'; +import CloseIcon from '@material-ui/icons/Close'; import React, { useContext, useState } from 'react'; import { useLocalStorage } from 'react-use'; -import { makeStyles } from '@material-ui/core/styles'; -import Link from '@material-ui/core/Link'; -import Typography from '@material-ui/core/Typography'; -import Collapse from '@material-ui/core/Collapse'; -import CloseIcon from '@material-ui/icons/Close'; -import { BackstageTheme } from '@backstage/theme'; import { - SIDEBAR_INTRO_LOCAL_STORAGE, - SidebarContext, sidebarConfig, + SidebarContext, + SIDEBAR_INTRO_LOCAL_STORAGE, } from './config'; import { SidebarDivider } from './Items'; @@ -88,7 +88,14 @@ type IntroCardProps = { onClose: () => void; }; -/** @public */ +/** + * Closable card with information from Navigation Sidebar + * + * @public + * @remarks + * + */ + export function IntroCard(props: IntroCardProps) { const classes = useStyles(); const { text, onClose } = props;