mui-dialog 1.0.12 → 1.0.14

package/README.md

@@ -1,7 +1,11 @@
-# mui-dialog
+# MUI Dialog
 
 A reusable dialog component for React applications built with Material-UI (MUI).
 
+## Documentation
+
+For detailed documentation and examples, visit our [Storybook](https://storybook.viplatform.net/mui-dialog/).
+
 ## Installation
 
 ```bash

package/dist/index.d.ts

@@ -1,126 +1,3 @@
-import { Breakpoint } from '@mui/material';
-import { JSX } from 'react/jsx-runtime';
-
-export declare interface BaseModalProps {
-    wrapperClassName?: string;
-    onClose: () => void;
-    open: boolean;
-    showCloseIcon?: boolean;
-    title?: string | React.ReactNode;
-    subTitle?: string | React.ReactNode;
-    description?: string | React.ReactNode;
-    children: React.ReactNode;
-    actions?: IActions;
-    showDivider?: boolean;
-    showActions?: boolean;
-}
-
-export declare const CONFIRMATION_SUBTYPES: {
-    readonly DEFAULT: "default";
-    readonly DESTRUCTIVE: "destructive";
-    readonly NESTED: "nested";
-};
-
-export declare interface ConfirmationModalProps extends BaseModalProps {
-    type: typeof MODAL_TYPES.CONFIRMATION;
-    subtype: (typeof CONFIRMATION_SUBTYPES)[keyof typeof CONFIRMATION_SUBTYPES];
-    size?: ModalSize;
-    tertiaryCtaType?: (typeof TERTIARY_CTA_TYPES)[keyof typeof TERTIARY_CTA_TYPES];
-}
-
-export declare type ConfirmationSubtype = (typeof CONFIRMATION_SUBTYPES)[keyof typeof CONFIRMATION_SUBTYPES];
-
-declare interface IActions {
-    primaryCtaTitle?: string;
-    secondaryCtaTitle?: string;
-    isPrimaryCtaLoading?: boolean;
-    isPrimaryCtaDisabled?: boolean;
-    isSecondaryCtaDisabled?: boolean;
-    isSecondaryCtaLoading?: boolean;
-    onPrimaryCtaClick?: () => void;
-    onSecondaryCtaClick?: () => void;
-    tertiaryCtaTitle?: string;
-    tertiaryCtaStartIcon?: React.ReactNode;
-    isTertiaryCtaLoading?: boolean;
-    isTertiaryCtaDisabled?: boolean;
-    onTertiaryCtaClick?: () => void;
-}
-
-export declare const INFORMATION_SUBTYPES: {
-    readonly ACKNOWLEDGEMENT: "acknowledgement";
-    readonly PROGRESS: "progress";
-    readonly PASSIVE: "passive";
-};
-
-export declare interface InformationModalProps extends BaseModalProps {
-    type: typeof MODAL_TYPES.INFORMATION;
-    subtype: (typeof INFORMATION_SUBTYPES)[keyof typeof INFORMATION_SUBTYPES];
-    size?: ModalSize;
-    tertiaryCtaType?: (typeof TERTIARY_CTA_TYPES)[keyof typeof TERTIARY_CTA_TYPES];
-}
-
-export declare type InformationSubtype = (typeof INFORMATION_SUBTYPES)[keyof typeof INFORMATION_SUBTYPES];
-
-export declare const INPUT_SUBTYPES: {
-    readonly DEFAULT: "default";
-    readonly DESTRUCTIVE: "destructive";
-};
-
-export declare interface InputModalProps extends BaseModalProps {
-    type: typeof MODAL_TYPES.INPUT;
-    subtype: (typeof INPUT_SUBTYPES)[keyof typeof INPUT_SUBTYPES];
-    size?: ModalSize;
-    tertiaryCtaType?: (typeof TERTIARY_CTA_TYPES)[keyof typeof TERTIARY_CTA_TYPES];
-}
-
-export declare type InputSubtype = (typeof INPUT_SUBTYPES)[keyof typeof INPUT_SUBTYPES];
-
-export declare const MODAL_CONFIGS: Record<ModalType, ModalTypeConfig>;
-
-export declare const MODAL_SIZE_VS_CLASS_NAMES: {
-    small: string;
-    medium: string;
-    large: string;
-    extraLarge: string;
-};
-
-export declare const MODAL_SIZES: {
-    readonly SMALL: "small";
-    readonly MEDIUM: "medium";
-    readonly LARGE: "large";
-    readonly EXTRA_LARGE: "extraLarge";
-};
-
-export declare const MODAL_TYPES: {
-    readonly INFORMATION: "information";
-    readonly CONFIRMATION: "confirmation";
-    readonly INPUT: "input";
-};
-
-declare type ModalConfig = {
-    DISMISSIBLE: 'full' | 'partial';
-    ALLOWED_SIZES: ModalSize[];
-};
-
-declare type ModalProps = InformationModalProps | ConfirmationModalProps | InputModalProps;
-
-export declare type ModalSize = (typeof MODAL_SIZES)[keyof typeof MODAL_SIZES];
-
-export declare type ModalType = (typeof MODAL_TYPES)[keyof typeof MODAL_TYPES];
-
-declare type ModalTypeConfig = {
-    [subtype: string]: ModalConfig;
-};
-
-export declare const MuiDialog: (props: ModalProps) => JSX.Element;
-
-export declare const SIZE_TO_MAX_WIDTH: Record<ModalSize, Breakpoint>;
-
-export declare type SubtypeForType<T extends ModalType> = T extends typeof MODAL_TYPES.INFORMATION ? InformationSubtype : T extends typeof MODAL_TYPES.CONFIRMATION ? ConfirmationSubtype : T extends typeof MODAL_TYPES.INPUT ? InputSubtype : never;
-
-export declare const TERTIARY_CTA_TYPES: {
-    DEFAULT: string;
-    DESTRUCTIVE: string;
-};
-
-export { }
+export { default as MuiDialog } from './muiDialog';
+export * from './muiDialog/constants/muiDialog.types';
+export * from './muiDialog/constants/muiDialog.interfaces';

package/dist/muiDialog/constants/muiDialog.interfaces.d.ts

@@ -0,0 +1,48 @@
+import { CONFIRMATION_SUBTYPES, INFORMATION_SUBTYPES, INPUT_SUBTYPES, MODAL_TYPES, ModalSize, TERTIARY_CTA_TYPES } from './muiDialog.types';
+interface IActions {
+    primaryCtaTitle?: string;
+    secondaryCtaTitle?: string;
+    isPrimaryCtaLoading?: boolean;
+    isPrimaryCtaDisabled?: boolean;
+    isSecondaryCtaDisabled?: boolean;
+    isSecondaryCtaLoading?: boolean;
+    onPrimaryCtaClick?: () => void;
+    onSecondaryCtaClick?: () => void;
+    tertiaryCtaTitle?: string;
+    tertiaryCtaStartIcon?: React.ReactNode;
+    isTertiaryCtaLoading?: boolean;
+    isTertiaryCtaDisabled?: boolean;
+    onTertiaryCtaClick?: () => void;
+}
+export interface BaseModalProps {
+    wrapperClassName?: string;
+    onClose: () => void;
+    open: boolean;
+    showCloseIcon?: boolean;
+    title?: string | React.ReactNode;
+    subTitle?: string | React.ReactNode;
+    description?: string | React.ReactNode;
+    children: React.ReactNode;
+    actions?: IActions;
+    showDivider?: boolean;
+    showActions?: boolean;
+}
+export interface InformationModalProps extends BaseModalProps {
+    type: typeof MODAL_TYPES.INFORMATION;
+    subtype: (typeof INFORMATION_SUBTYPES)[keyof typeof INFORMATION_SUBTYPES];
+    size?: ModalSize;
+    tertiaryCtaType?: (typeof TERTIARY_CTA_TYPES)[keyof typeof TERTIARY_CTA_TYPES];
+}
+export interface ConfirmationModalProps extends BaseModalProps {
+    type: typeof MODAL_TYPES.CONFIRMATION;
+    subtype: (typeof CONFIRMATION_SUBTYPES)[keyof typeof CONFIRMATION_SUBTYPES];
+    size?: ModalSize;
+    tertiaryCtaType?: (typeof TERTIARY_CTA_TYPES)[keyof typeof TERTIARY_CTA_TYPES];
+}
+export interface InputModalProps extends BaseModalProps {
+    type: typeof MODAL_TYPES.INPUT;
+    subtype: (typeof INPUT_SUBTYPES)[keyof typeof INPUT_SUBTYPES];
+    size?: ModalSize;
+    tertiaryCtaType?: (typeof TERTIARY_CTA_TYPES)[keyof typeof TERTIARY_CTA_TYPES];
+}
+export {};

package/dist/muiDialog/constants/muiDialog.types.d.ts

@@ -0,0 +1,52 @@
+import { Breakpoint } from '@mui/material';
+export declare const MODAL_TYPES: {
+    readonly INFORMATION: "information";
+    readonly CONFIRMATION: "confirmation";
+    readonly INPUT: "input";
+};
+export type ModalType = (typeof MODAL_TYPES)[keyof typeof MODAL_TYPES];
+export declare const INFORMATION_SUBTYPES: {
+    readonly ACKNOWLEDGEMENT: "acknowledgement";
+    readonly PROGRESS: "progress";
+    readonly PASSIVE: "passive";
+};
+export declare const CONFIRMATION_SUBTYPES: {
+    readonly DEFAULT: "default";
+    readonly DESTRUCTIVE: "destructive";
+    readonly NESTED: "nested";
+};
+export declare const INPUT_SUBTYPES: {
+    readonly DEFAULT: "default";
+    readonly DESTRUCTIVE: "destructive";
+};
+export type InformationSubtype = (typeof INFORMATION_SUBTYPES)[keyof typeof INFORMATION_SUBTYPES];
+export type ConfirmationSubtype = (typeof CONFIRMATION_SUBTYPES)[keyof typeof CONFIRMATION_SUBTYPES];
+export type InputSubtype = (typeof INPUT_SUBTYPES)[keyof typeof INPUT_SUBTYPES];
+export declare const MODAL_SIZES: {
+    readonly SMALL: "small";
+    readonly MEDIUM: "medium";
+    readonly LARGE: "large";
+    readonly EXTRA_LARGE: "extraLarge";
+};
+export declare const TERTIARY_CTA_TYPES: {
+    DEFAULT: string;
+    DESTRUCTIVE: string;
+};
+export type ModalSize = (typeof MODAL_SIZES)[keyof typeof MODAL_SIZES];
+type ModalConfig = {
+    DISMISSIBLE: 'full' | 'partial';
+    ALLOWED_SIZES: ModalSize[];
+};
+type ModalTypeConfig = {
+    [subtype: string]: ModalConfig;
+};
+export declare const MODAL_CONFIGS: Record<ModalType, ModalTypeConfig>;
+export declare const SIZE_TO_MAX_WIDTH: Record<ModalSize, Breakpoint>;
+export type SubtypeForType<T extends ModalType> = T extends typeof MODAL_TYPES.INFORMATION ? InformationSubtype : T extends typeof MODAL_TYPES.CONFIRMATION ? ConfirmationSubtype : T extends typeof MODAL_TYPES.INPUT ? InputSubtype : never;
+export declare const MODAL_SIZE_VS_CLASS_NAMES: {
+    small: string;
+    medium: string;
+    large: string;
+    extraLarge: string;
+};
+export {};

package/dist/muiDialog/helpers/muiDialog.general.d.ts

@@ -0,0 +1 @@
+export declare const checkIfTertiaryCtaIsAllowed: (type: string, subtype: string, size: string) => boolean;

package/dist/muiDialog/index.d.ts

@@ -0,0 +1,4 @@
+import { ConfirmationModalProps, InformationModalProps, InputModalProps } from './constants/muiDialog.interfaces';
+type ModalProps = InformationModalProps | ConfirmationModalProps | InputModalProps;
+declare const MuiDialog: (props: ModalProps) => import("react/jsx-runtime").JSX.Element;
+export default MuiDialog;

package/dist/muiTheme.d.ts

@@ -0,0 +1,239 @@
+import { Theme } from '@mui/material';
+export declare const dialogTypography: {
+    fontFamily: string;
+    displayL: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    displayM: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    headingL: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    headingM: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    headingS: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    semiBoldLabelL: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    semiBoldLabelM: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    semiBoldLabelS: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    semiBoldLabelXs: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    semiBoldLabelXxs: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    regularLabelL: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    regularLabelM: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    regularLabelS: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    regularLabelXs: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    regularLabelXxs: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+        letterSpacing: string;
+    };
+    textXl: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    textL: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    textM: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    subtextM: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    subtextS: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+    };
+    semiBoldLinkXL: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+        textDecoration: string;
+    };
+    semiBoldLinkL: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+        textDecoration: string;
+    };
+    semiBoldLinkM: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+        textDecoration: string;
+    };
+    semiBoldLinkS: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+        textDecoration: string;
+    };
+    semiBoldLinkXs: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+        textDecoration: string;
+    };
+    regularLinkXL: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+        textDecoration: string;
+    };
+    regularLinkL: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+        letterSpacing: string;
+        textDecoration: string;
+    };
+    h1: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+    };
+    h2: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+    };
+    h3: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+    };
+    h4: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+    };
+    h5: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+    };
+    headline: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+    };
+    body: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+    };
+    callout: {
+        fontSize: string;
+        fontWeight: number;
+        lineHeight: string;
+    };
+    subHeadline1: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+    };
+    subHeadline2: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+    };
+    footNote: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+    };
+    caption1: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+    };
+    caption2: {
+        fontSize: string;
+        lineHeight: string;
+        fontWeight: number;
+    };
+};
+export declare const muiTheme: Theme;

package/dist/theme.constant.d.ts

@@ -0,0 +1,9 @@
+export declare const textStyles: {
+    fontWeight: {
+        semibold: number;
+        regular: number;
+    };
+    letterSpacing: {
+        default: string;
+    };
+};

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/viplatform/mui-dialog/issues"
   },
   "homepage": "https://github.com/viplatform/mui-dialog#readme",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "files": [
     "dist"
   ],