@protonradio/proton-ui 0.7.5-beta1 → 0.7.5-beta11

package/dist/index.d.ts

@@ -52,6 +52,27 @@ declare interface ActionMenuProps {
     "data-testid"?: string;
 }
 
+/**
+ * Base Overlay component for creating modal-like backgrounds.
+ * @interface BackdropProps
+ */
+export declare function Backdrop({ fadeIn, onBackgroundEvent, children, }: BackdropProps): JSX_2.Element;
+
+declare interface BackdropProps {
+    /**
+     * Whether to fade in the overlay.
+     */
+    fadeIn?: boolean;
+    /**
+     * Callback function to handle the background event (click or ESC key).
+     */
+    onBackgroundEvent?: () => void;
+    /**
+     * Children to render inside the overlay.
+     */
+    children?: React.ReactNode;
+}
+
 export declare const Badge: ({ variant, children, ...props }: BadgeProps) => JSX_2.Element;
 
 export declare interface BadgeProps extends React.HTMLAttributes<HTMLDivElement> {
@@ -350,27 +371,24 @@ declare interface IconProps {
 }
 
 /**
- * A controlled and customizable input component with support for labels, prefixes, suffixes, and error states.
+ * ImageOverlay component for displaying an image with a blur effect.
+ * @interface ImageBackdropProps
  */
-export declare const Input: default_2.ForwardRefExoticComponent<BaseInputProps & default_2.RefAttributes<HTMLInputElement>>;
+export declare function ImageBackdrop({ image, imageUrl, onLoad, onBackgroundEvent, }: ImageBackdropProps): JSX_2.Element;
 
-/**
- * Overlay component for displaying an image with a blur effect.
- * @interface OverlayProps
- */
-export declare function Overlay({ imageUrl, fadeIn, onLoad, onBackgroundEvent, }: OverlayProps): JSX_2.Element;
-
-declare interface OverlayProps {
+declare interface ImageBackdropProps {
     /**
-     * The URL of the image to display in the overlay. If not provided, the overlay will be solid black.
+     * The image to display in the overlay. Supports server side rendering.
      */
-    imageUrl?: string;
+    image?: React.ReactNode;
     /**
-     * Whether to fade in the overlay.
+     * The URL of the image to display in the overlay.
+     * @important Supported in client components only.
      */
-    fadeIn?: boolean;
+    imageUrl?: string;
     /**
      * Callback function to handle the image load event.
+     * @important Supported in client components only.
      */
     onLoad?: (image: HTMLImageElement) => void;
     /**
@@ -379,7 +397,13 @@ declare interface OverlayProps {
     onBackgroundEvent?: () => void;
 }
 
+/**
+ * A controlled and customizable input component with support for labels, prefixes, suffixes, and error states.
+ */
+export declare const Input: default_2.ForwardRefExoticComponent<BaseInputProps & default_2.RefAttributes<HTMLInputElement>>;
+
 declare type Palette = {
+    BASE_COLOR: string;
     BRAND: {
         PRIMARY: string;
         PRIMARY_LIGHT: string;