@bonprix-ds/react-alert 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { FC } from 'react';
+
+declare const Alert: FC<AlertProps>;
+export default Alert;
+
+export declare interface AlertProps {
+    /**  Toggles the visibility of the component. Must be used in conjunction with `onClose`. */
+    isOpen: boolean;
+    /** The status of the alert. The colors and the icon of the component will adjust appropriately to signal the status level.*/
+    status: StatusLevel;
+    /** The message of the alert. */
+    children: string;
+    /** Callback, which is triggered when the visibility of the component (opened/closed) changes. Should be used to control the component from the outside, if the user clicks on the close icon. */
+    onClose?: () => void;
+    /**  Variant of the alert. Depends on the prominence level you require. */
+    variant?: VariantValue;
+    /** An optional title of the alert. The titel sums up the message briefly. */
+    title?: string;
+    /** Controls, if the close icon should be shown. When the alert shoulnd't be closed actively, this property can be set to `false`. */
+    showCloseIcon?: boolean;
+    /** Removes role="alert" from component if set to `true`. The alert content is not read by assistive technologies right away then. */
+    nonCritical?: boolean;
+    /** If `title` is used, you can define the used header element. */
+    titleTag?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+}
+
+export declare const levels: readonly ["success", "info", "warning", "error"];
+
+declare type StatusLevel = (typeof levels)[number];
+
+export declare const values: readonly ["primary", "secondary"];
+
+declare type VariantValue = (typeof values)[number];
+
+export { }