dgz-ui-shared 1.1.27 → 1.1.28

package/dist/types/components/modal/MyModal.d.ts

@@ -2,28 +2,40 @@ import type { ReactNode } from 'react';
 import type { DialogProps } from '@radix-ui/react-dialog';
 /**
  * Props for the MyModal component.
+ * Extends Radix UI's DialogProps.
+ *
+ * @typedef {Object} MyModalProps
+ * @property {ReactNode} [header] - The content to be displayed in the modal header.
+ * @property {ReactNode} [trigger] - The element that triggers the modal when clicked.
+ * @property {ReactNode} [children] - The main content of the modal.
+ * @property {ReactNode} [footer] - The content to be displayed in the modal footer.
+ * @property {string} [className] - Additional CSS classes for the modal content.
+ * @property {'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl' | '7xl' | 'full'} [size='lg'] - The maximum width size of the modal.
  */
 export type MyModalProps = DialogProps & {
-    /** Header content. */
     header?: ReactNode;
-    /** Optional trigger element. */
     trigger?: ReactNode;
-    /** Modal content. */
     children?: ReactNode;
-    /** Footer content. */
     footer?: ReactNode;
-    /** Custom CSS class name. */
     className?: string;
-    /** Content max width size. */
     size?: 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl' | '7xl' | 'full';
 };
 /**
- * MyModal is a convenience wrapper around Dialog with a header, content and optional footer.
+ * A reusable modal component that wraps the Dialog component from dgz-ui.
+ * It provides a structured layout with a header, scrollable content area, and optional footer.
+ *
+ * @component
+ * @param {MyModalProps} props - The props for the MyModal component.
+ * @returns {JSX.Element} The rendered MyModal component.
  *
- * @param props.header - Header content.
- * @param props.trigger - Optional trigger element.
- * @param props.footer - Footer content.
- * @param props.size - Content max width size.
+ * @example
+ * <MyModal
+ *   header="User Settings"
+ *   trigger={<button>Open Settings</button>}
+ *   footer={<button onClick={save}>Save</button>}
+ * >
+ *   <p>Settings content goes here...</p>
+ * </MyModal>
  */
 export declare const MyModal: ({ header, footer, trigger, children, size, className, ...props }: MyModalProps) => import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=MyModal.d.ts.map

package/dist/types/components/modal/MyModal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MyModal.d.ts","sourceRoot":"","sources":["../../../../src/components/modal/MyModal.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAUvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAG1D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IACvC,sBAAsB;IACtB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,sBAAsB;IACtB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;CAC7E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,GAAI,kEAQrB,YAAY,4CA2Bd,CAAC"}
+{"version":3,"file":"MyModal.d.ts","sourceRoot":"","sources":["../../../../src/components/modal/MyModal.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAUvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAG1D;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IACvC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;CAC7E,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,OAAO,GAAI,kEAQrB,YAAY,4CA2Bd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dgz-ui-shared",
-  "version": "1.1.27",
+  "version": "1.1.28",
   "type": "module",
   "files": [
     "dist"