Trying to fix up api-report
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
This commit is contained in:
@@ -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';
|
||||
|
||||
@@ -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
|
||||
* <AlertDisplay />
|
||||
*
|
||||
@@ -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:
|
||||
* <AlertDisplay transientTimeoutMs={10000} />
|
||||
* ```
|
||||
*/
|
||||
|
||||
// TODO: improve on this and promote to a shared component for use by all apps.
|
||||
|
||||
Reference in New Issue
Block a user