diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index 6b6a4c1b6d..63c10f3387 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -55,7 +55,10 @@ import { WithStyles } from '@material-ui/core/styles'; // @public export function AlertDisplay(props: AlertDisplayProps): JSX.Element | null; -// @public (undocumented) +// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters +// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters +// +// @public export type AlertDisplayProps = { anchorOrigin?: { vertical: 'top' | 'bottom'; diff --git a/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx b/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx index e5b939fe27..db90952104 100644 --- a/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx +++ b/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx @@ -35,7 +35,8 @@ import React, { useEffect, useState } from 'react'; * @param transientTimeoutMs - Number of milliseconds a transient alert will stay open for. Default value is 5000 * * @example - * + * Here's some examples: + * ``` * // This example shows the default usage, the SnackBar will show up at the top in the center and any transient messages will stay open for 5000ms * * @@ -44,6 +45,7 @@ import React, { useEffect, useState } from 'react'; * * // If you want to just set the time a transientTimeoutMs, you can do that like this: * + * ``` */ // TODO: improve on this and promote to a shared component for use by all apps.