From ba71cc293574bb766534e05426f770f97ad25d61 Mon Sep 17 00:00:00 2001 From: Tomasz Szuba Date: Thu, 30 Sep 2021 10:55:14 +0200 Subject: [PATCH] Review remarks + rebase conflicts Signed-off-by: Tomasz Szuba --- packages/core-components/api-report.md | 60 ++++++++++++++++++- .../src/components/Avatar/Avatar.tsx | 2 +- .../CopyTextButton/CopyTextButton.tsx | 2 +- 3 files changed, 60 insertions(+), 4 deletions(-) diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index 63d1691d62..4a94135b4a 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -70,6 +70,59 @@ enum Alignment { // @public export function Avatar(props: AvatarProps): JSX.Element; +// Warning: (ae-missing-release-tag) "AvatarClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type AvatarClassKey = 'avatar'; + +// Warning: (ae-missing-release-tag) "AvatarProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export interface AvatarProps { + customStyles?: CSSProperties; + displayName?: string; + picture?: string; +} + +// Warning: (ae-missing-release-tag) "BackstageContentClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type BackstageContentClassKey = 'root' | 'stretch' | 'noPadding'; + +// Warning: (ae-forgotten-export) The symbol "BackstageComponentsNameToClassKey" needs to be exported by the entry point index.d.ts +// Warning: (ae-missing-release-tag) "BackstageOverrides" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type BackstageOverrides = Overrides & { + [Name in keyof BackstageComponentsNameToClassKey]?: Partial< + StyleRules_2 + >; +}; + +// Warning: (ae-missing-release-tag) "BoldHeaderClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type BoldHeaderClassKey = 'root' | 'title' | 'subheader'; + +// Warning: (ae-missing-release-tag) "BottomLink" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export function BottomLink(props: BottomLinkProps): JSX.Element; + +// Warning: (ae-missing-release-tag) "BottomLinkClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type BottomLinkClassKey = 'root' | 'boxTitle' | 'arrow'; + +// Warning: (ae-missing-release-tag) "BottomLinkProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type BottomLinkProps = { + link: string; + title: string; + onClick?: (event: React_2.MouseEvent) => void; +}; + // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "Breadcrumbs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // @@ -175,8 +228,6 @@ export type ContentHeaderClassKey = | 'description' | 'title'; -// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts -// Warning: (ae-missing-release-tag) "CopyTextButton" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // Warning: (ae-missing-release-tag) "CopyTextButton" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public @@ -203,6 +254,11 @@ export type CreateButtonProps = { title: string; } & Partial>; +// Warning: (ae-missing-release-tag) "CustomProviderClassKey" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type CustomProviderClassKey = 'form' | 'button'; + // Warning: (ae-missing-release-tag) "DashboardIcon" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) diff --git a/packages/core-components/src/components/Avatar/Avatar.tsx b/packages/core-components/src/components/Avatar/Avatar.tsx index c1762d8f1f..0156c58b92 100644 --- a/packages/core-components/src/components/Avatar/Avatar.tsx +++ b/packages/core-components/src/components/Avatar/Avatar.tsx @@ -44,7 +44,7 @@ const useStyles = makeStyles( */ export interface AvatarProps { /** - * Display Name + * A display name, which will be used to generate initials as a fallback in case a picture is not provided. */ displayName?: string; /** diff --git a/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx b/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx index 6973911983..2d2fb4006a 100644 --- a/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx +++ b/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx @@ -29,7 +29,7 @@ export interface CopyTextButtonProps { */ text: string; /** - * Number os ms to show the tooltip + * Number of milliseconds that the tooltip is shown * * @remarks *