From d26904b8365a4e092e769406ed23b3d4d8d0279d Mon Sep 17 00:00:00 2001 From: lukzerom Date: Thu, 16 Dec 2021 22:04:02 +0100 Subject: [PATCH] BottomLink description Signed-off-by: lukzerom --- packages/core-components/api-report.md | 2 +- .../src/layout/BottomLink/BottomLink.tsx | 18 ++++++++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index f2b167691d..f047f38a06 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -89,7 +89,7 @@ export type BackstageOverrides = Overrides & { // @public (undocumented) export type BoldHeaderClassKey = 'root' | 'title' | 'subheader'; -// @public (undocumented) +// @public export function BottomLink(props: BottomLinkProps): JSX.Element; // @public (undocumented) diff --git a/packages/core-components/src/layout/BottomLink/BottomLink.tsx b/packages/core-components/src/layout/BottomLink/BottomLink.tsx index f7c644bedf..420752ffe4 100644 --- a/packages/core-components/src/layout/BottomLink/BottomLink.tsx +++ b/packages/core-components/src/layout/BottomLink/BottomLink.tsx @@ -14,13 +14,13 @@ * limitations under the License. */ -import React from 'react'; -import { makeStyles } from '@material-ui/core/styles'; -import Divider from '@material-ui/core/Divider'; -import Typography from '@material-ui/core/Typography'; -import ArrowIcon from '@material-ui/icons/ArrowForward'; import { BackstageTheme } from '@backstage/theme'; import Box from '@material-ui/core/Box'; +import Divider from '@material-ui/core/Divider'; +import { makeStyles } from '@material-ui/core/styles'; +import Typography from '@material-ui/core/Typography'; +import ArrowIcon from '@material-ui/icons/ArrowForward'; +import React from 'react'; import { Link } from '../../components/Link'; /** @public */ @@ -50,7 +50,13 @@ export type BottomLinkProps = { onClick?: (event: React.MouseEvent) => void; }; -/** @public */ +/** + * Footer with link used in {@link InfoCard | InfoCard } and {@link TabbedCard | TabbedCard} + * + * @public + * @remarks + * + */ export function BottomLink(props: BottomLinkProps) { const { link, title, onClick } = props; const classes = useStyles();