From 85d54b888cefbab8e7d025d6ce558e3cc9106f73 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 6 Dec 2021 00:57:35 +0100 Subject: [PATCH] core-components: update API report for LogViewer + fixes Signed-off-by: Patrik Oldsberg --- packages/core-components/api-report.md | 42 +++++++++++++++++++ .../src/components/LogViewer/LogViewer.tsx | 4 ++ .../src/components/LogViewer/styles.ts | 1 + 3 files changed, 47 insertions(+) diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index cc7db32586..a8611ad299 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -605,6 +605,48 @@ export type LinkProps = LinkProps_2 & // @public (undocumented) export type LoginRequestListItemClassKey = 'root'; +// @public +export function LogViewer(props: LogViewerProps): JSX.Element; + +// @public +export type LogViewerClassKey = + | 'root' + | 'header' + | 'log' + | 'line' + | 'lineSelected' + | 'lineCopyButton' + | 'lineNumber' + | 'textHighlight' + | 'textSelectedHighlight' + | 'modifierBold' + | 'modifierItalic' + | 'modifierUnderline' + | 'modifierForegroundBlack' + | 'modifierForegroundRed' + | 'modifierForegroundGreen' + | 'modifierForegroundYellow' + | 'modifierForegroundBlue' + | 'modifierForegroundMagenta' + | 'modifierForegroundCyan' + | 'modifierForegroundWhite' + | 'modifierForegroundGrey' + | 'modifierBackgroundBlack' + | 'modifierBackgroundRed' + | 'modifierBackgroundGreen' + | 'modifierBackgroundYellow' + | 'modifierBackgroundBlue' + | 'modifierBackgroundMagenta' + | 'modifierBackgroundCyan' + | 'modifierBackgroundWhite' + | 'modifierBackgroundGrey'; + +// @public +export interface LogViewerProps { + className?: string; + text: string; +} + // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "MarkdownContent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/packages/core-components/src/components/LogViewer/LogViewer.tsx b/packages/core-components/src/components/LogViewer/LogViewer.tsx index a85603b465..643d2ba9f8 100644 --- a/packages/core-components/src/components/LogViewer/LogViewer.tsx +++ b/packages/core-components/src/components/LogViewer/LogViewer.tsx @@ -23,6 +23,8 @@ const RealLogViewer = lazy(() => /** * The properties for the LogViewer component. + * + * @public */ export interface LogViewerProps { /** @@ -47,6 +49,8 @@ export interface LogViewerProps { * log is sized automatically to fill the available vertical space. This means * it may often be needed to wrap the LogViewer in a container that provides it * with a fixed amount of space. + * + * @public */ export function LogViewer(props: LogViewerProps) { const { Progress } = useApp().getComponents(); diff --git a/packages/core-components/src/components/LogViewer/styles.ts b/packages/core-components/src/components/LogViewer/styles.ts index edb2086675..2028809543 100644 --- a/packages/core-components/src/components/LogViewer/styles.ts +++ b/packages/core-components/src/components/LogViewer/styles.ts @@ -19,6 +19,7 @@ import * as colors from '@material-ui/core/colors'; export const HEADER_SIZE = 40; +/** @public Class keys for overriding LogViewer styles */ export type LogViewerClassKey = | 'root' | 'header'