@bf2/ui-shared - npm Package Compare versions

Comparing version 0.0.20 to 0.0.21

dist/cjs/contexts/alert/Alert.d.ts

@@ -12,2 +12,44 @@ import React from "react";
 }
+export declare type AlertProps = {
+    /**
+     * Unique key
+     */
+    id?: string;
+    /**
+    * Flag to automatically call `onDismiss` after `dismissDelay` runs out.
+    */
+    autoDismiss?: boolean;
+    /**
+     * Flag to show/hide notification close button.
+     */
+    dismissable?: boolean;
+    /**
+     * Alert variant
+     */
+    variant: AlertVariant;
+    /**
+     * Alert title
+     */
+    title: string;
+    /**
+     * Alert description
+     */
+    description?: string | React.ReactElement;
+    /**
+     * Time period after which `onDismiss` is called.
+     */
+    dismissDelay?: number;
+    /**
+     * Unique request ID.
+     */
+    requestId?: string;
+    /**
+     * Unique sentry error ID.
+     */
+    sentryId?: string;
+    /**
+     * data-testid attribute
+     */
+    dataTestId?: string;
+};
 /**
@@ -17,8 +59,3 @@ * The Alert interface allows alerts to be added to the notification system
 export declare type Alert = {
-    /**
-     * addAlert allows an alert an alert to be added
-     * @param message the title of the message
-     * @param variant the type of the alert
-     */
-    addAlert: (message: string, variant?: AlertVariant) => void;
+    addAlert: ({ id, title, variant, description, dataTestId, autoDismiss, dismissable, dismissDelay, requestId, sentryId }: AlertProps) => void;
 };
@@ -25,0 +62,0 @@ /**

dist/esm/contexts/alert/Alert.d.ts

@@ -12,2 +12,44 @@ import React from "react";
 }
+export declare type AlertProps = {
+    /**
+     * Unique key
+     */
+    id?: string;
+    /**
+    * Flag to automatically call `onDismiss` after `dismissDelay` runs out.
+    */
+    autoDismiss?: boolean;
+    /**
+     * Flag to show/hide notification close button.
+     */
+    dismissable?: boolean;
+    /**
+     * Alert variant
+     */
+    variant: AlertVariant;
+    /**
+     * Alert title
+     */
+    title: string;
+    /**
+     * Alert description
+     */
+    description?: string | React.ReactElement;
+    /**
+     * Time period after which `onDismiss` is called.
+     */
+    dismissDelay?: number;
+    /**
+     * Unique request ID.
+     */
+    requestId?: string;
+    /**
+     * Unique sentry error ID.
+     */
+    sentryId?: string;
+    /**
+     * data-testid attribute
+     */
+    dataTestId?: string;
+};
 /**
@@ -17,8 +59,3 @@ * The Alert interface allows alerts to be added to the notification system
 export declare type Alert = {
-    /**
-     * addAlert allows an alert an alert to be added
-     * @param message the title of the message
-     * @param variant the type of the alert
-     */
-    addAlert: (message: string, variant?: AlertVariant) => void;
+    addAlert: ({ id, title, variant, description, dataTestId, autoDismiss, dismissable, dismissDelay, requestId, sentryId }: AlertProps) => void;
 };
@@ -25,0 +62,0 @@ /**

package.json

 {
   "name": "@bf2/ui-shared",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "description": "UI Shared contains a number of type definitions for shared data structures for the UI.",
@@ -5,0 +5,0 @@ "main": "./dist/cjs/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38754

increased by6.93%

Lines of code

682

increased by12.17%

No dependency changes