From 3b55150fa8aaf54e6768b9d36922125e1c1975dd Mon Sep 17 00:00:00 2001
From: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Date: Fri, 11 Nov 2022 14:34:38 -0600
Subject: [PATCH] Added TSDoc comments

Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
---
 .../src/components/AlertDisplay/AlertDisplay.tsx  | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx b/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx
index 75cb2c78de..e5b939fe27 100644
--- a/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx
+++ b/packages/core-components/src/components/AlertDisplay/AlertDisplay.tsx
@@ -29,6 +29,21 @@ import React, { useEffect, useState } from 'react';
  * @remarks
  *
  * Shown as SnackBar at the center top of the page by default. Configurable with props.
+ *
+ * @param anchorOrigin.vertical - Vertical orientation of where the AlertDisplay will be located
+ * @param anchorOrigin.horizontal - Horizontal orientation of where the AlertDisplay will be located
+ * @param transientTimeoutMs - Number of milliseconds a transient alert will stay open for. Default value is 5000
+ *
+ * @example
+ *
+ * // 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 />
+ *
+ * // With this example the SnackBar will show up in the bottom right hand corner and any transient messages will stay open for 2500ms
+ * <AlertDisplay transientTimeoutMs={2500} anchorOrigin={{vertical: 'bottom', horizontal: 'right'}}/>
+ *
+ * // 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.