analytica-frontend-lib 1.0.44 → 1.0.45

package/dist/index.d.mts

@@ -19,9 +19,73 @@ export { default as Chips } from './Chips/index.mjs';
 export { default as ProgressBar } from './ProgressBar/index.mjs';
 export { default as ProgressCircle } from './ProgressCircle/index.mjs';
 export { default as Calendar } from './Calendar/index.mjs';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
 export { default as DropdownMenu, DropdownMenuItem, DropdownMenuSeparator, DropdownMenuTrigger, MenuContent, MenuLabel, ProfileMenuFooter, ProfileMenuHeader, ProfileMenuSection, ProfileMenuTrigger } from './DropdownMenu/index.mjs';
 export { default as Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from './Select/index.mjs';
 export { default as Menu, MenuItem, MenuSeparator } from './Menu/index.mjs';
-import 'react/jsx-runtime';
-import 'react';
 import 'zustand';
+
+/**
+ * Modal component props interface
+ */
+type ModalProps = {
+    /** Whether the modal is open */
+    isOpen: boolean;
+    /** Function to close the modal */
+    onClose: () => void;
+    /** Modal title */
+    title: string;
+    /** Modal description/content */
+    children: ReactNode;
+    /** Size of the modal */
+    size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    /** Additional CSS classes for the modal content */
+    className?: string;
+    /** Whether clicking the backdrop should close the modal */
+    closeOnBackdropClick?: boolean;
+    /** Whether pressing Escape should close the modal */
+    closeOnEscape?: boolean;
+    /** Footer content (typically buttons) */
+    footer?: ReactNode;
+    /** Hide the close button */
+    hideCloseButton?: boolean;
+};
+/**
+ * Modal component for Analytica Ensino platforms
+ *
+ * A flexible modal component with multiple size variants and customizable behavior.
+ *
+ * @param isOpen - Whether the modal is currently open
+ * @param onClose - Callback function called when the modal should be closed
+ * @param title - The title displayed at the top of the modal
+ * @param children - The main content of the modal
+ * @param size - The size variant (xs, sm, md, lg, xl)
+ * @param className - Additional CSS classes for the modal content
+ * @param closeOnBackdropClick - Whether clicking the backdrop closes the modal (default: true)
+ * @param closeOnEscape - Whether pressing Escape closes the modal (default: true)
+ * @param footer - Footer content, typically action buttons
+ * @param hideCloseButton - Whether to hide the X close button (default: false)
+ * @returns A modal overlay with content
+ *
+ * @example
+ * ```tsx
+ * <Modal
+ *   isOpen={isModalOpen}
+ *   onClose={() => setIsModalOpen(false)}
+ *   title="Invite your team"
+ *   size="md"
+ *   footer={
+ *     <div className="flex gap-3">
+ *       <Button variant="outline" onClick={() => setIsModalOpen(false)}>Cancel</Button>
+ *       <Button variant="solid" onClick={handleExplore}>Explore</Button>
+ *     </div>
+ *   }
+ * >
+ *   Elevate user interactions with our versatile modals.
+ * </Modal>
+ * ```
+ */
+declare const Modal: ({ isOpen, onClose, title, children, size, className, closeOnBackdropClick, closeOnEscape, footer, hideCloseButton, }: ModalProps) => react_jsx_runtime.JSX.Element | null;
+
+export { Modal };

package/dist/index.d.ts

@@ -19,9 +19,73 @@ export { default as Chips } from './Chips/index.js';
 export { default as ProgressBar } from './ProgressBar/index.js';
 export { default as ProgressCircle } from './ProgressCircle/index.js';
 export { default as Calendar } from './Calendar/index.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
 export { default as DropdownMenu, DropdownMenuItem, DropdownMenuSeparator, DropdownMenuTrigger, MenuContent, MenuLabel, ProfileMenuFooter, ProfileMenuHeader, ProfileMenuSection, ProfileMenuTrigger } from './DropdownMenu/index.js';
 export { default as Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from './Select/index.js';
 export { default as Menu, MenuItem, MenuSeparator } from './Menu/index.js';
-import 'react/jsx-runtime';
-import 'react';
 import 'zustand';
+
+/**
+ * Modal component props interface
+ */
+type ModalProps = {
+    /** Whether the modal is open */
+    isOpen: boolean;
+    /** Function to close the modal */
+    onClose: () => void;
+    /** Modal title */
+    title: string;
+    /** Modal description/content */
+    children: ReactNode;
+    /** Size of the modal */
+    size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    /** Additional CSS classes for the modal content */
+    className?: string;
+    /** Whether clicking the backdrop should close the modal */
+    closeOnBackdropClick?: boolean;
+    /** Whether pressing Escape should close the modal */
+    closeOnEscape?: boolean;
+    /** Footer content (typically buttons) */
+    footer?: ReactNode;
+    /** Hide the close button */
+    hideCloseButton?: boolean;
+};
+/**
+ * Modal component for Analytica Ensino platforms
+ *
+ * A flexible modal component with multiple size variants and customizable behavior.
+ *
+ * @param isOpen - Whether the modal is currently open
+ * @param onClose - Callback function called when the modal should be closed
+ * @param title - The title displayed at the top of the modal
+ * @param children - The main content of the modal
+ * @param size - The size variant (xs, sm, md, lg, xl)
+ * @param className - Additional CSS classes for the modal content
+ * @param closeOnBackdropClick - Whether clicking the backdrop closes the modal (default: true)
+ * @param closeOnEscape - Whether pressing Escape closes the modal (default: true)
+ * @param footer - Footer content, typically action buttons
+ * @param hideCloseButton - Whether to hide the X close button (default: false)
+ * @returns A modal overlay with content
+ *
+ * @example
+ * ```tsx
+ * <Modal
+ *   isOpen={isModalOpen}
+ *   onClose={() => setIsModalOpen(false)}
+ *   title="Invite your team"
+ *   size="md"
+ *   footer={
+ *     <div className="flex gap-3">
+ *       <Button variant="outline" onClick={() => setIsModalOpen(false)}>Cancel</Button>
+ *       <Button variant="solid" onClick={handleExplore}>Explore</Button>
+ *     </div>
+ *   }
+ * >
+ *   Elevate user interactions with our versatile modals.
+ * </Modal>
+ * ```
+ */
+declare const Modal: ({ isOpen, onClose, title, children, size, className, closeOnBackdropClick, closeOnEscape, footer, hideCloseButton, }: ModalProps) => react_jsx_runtime.JSX.Element | null;
+
+export { Modal };