@saas-ui/modals 1.5.5 → 2.0.0-next.1

package/CHANGELOG.md

@@ -1,11 +1,31 @@
 # @saas-ui/modals
 
-## 1.5.5
+## 2.0.0-next.1
 
 ### Patch Changes
 
-- Updated dependencies [382e095]
-  - @saas-ui/forms@1.5.3
+- 166978bd: Fix esm bundle filename.
+- Updated dependencies [166978bd]
+  - @saas-ui/forms@2.0.0-next.1
+  - @saas-ui/hooks@2.0.0-next.1
+  - @saas-ui/react-utils@2.0.0-next.1
+
+## 2.0.0-next.0
+
+### Major Changes
+
+- f1e99198: Restructured packages.
+
+### Patch Changes
+
+- f1e99198: Migrated from microbundle to tsup for builds
+- Updated dependencies [d7c87a31]
+- Updated dependencies [f1e99198]
+- Updated dependencies [8b82d945]
+- Updated dependencies [f1e99198]
+  - @saas-ui/forms@2.0.0-next.0
+  - @saas-ui/hooks@2.0.0-next.0
+  - @saas-ui/react-utils@2.0.0-next.0
 
 ## 1.5.4
 

package/dist/index.d.ts

@@ -1,7 +1,218 @@
-export * from './dialog';
-export * from './drawer';
-export * from './modal';
-export * from './menu';
-export * from './form';
-export * from './provider';
-//# sourceMappingURL=index.d.ts.map
+import * as React from 'react';
+import { AlertDialogProps, ButtonProps, ButtonGroupProps, DrawerProps as DrawerProps$1, ModalProps, MenuListProps } from '@chakra-ui/react';
+import * as _chakra_ui_system_dist_system_types from '@chakra-ui/system/dist/system.types';
+import { FieldValues, FormProps, FieldResolver } from '@saas-ui/forms';
+
+interface ConfirmDialogProps extends Omit<AlertDialogProps, 'leastDestructiveRef'> {
+    /**
+     * The dialog title
+     */
+    title?: React.ReactNode;
+    /**
+     * The cancel button label
+     */
+    cancelLabel?: React.ReactNode;
+    /**
+     * The confirm button label
+     */
+    confirmLabel?: React.ReactNode;
+    /**
+     * The cancel button props
+     */
+    cancelProps?: ButtonProps;
+    /**
+     * The confirm button props
+     */
+    confirmProps?: ButtonProps;
+    /**
+     * The button group props
+     */
+    buttonGroupProps?: ButtonGroupProps;
+    /**
+     * Close the dialog on cancel
+     * @default true
+     */
+    closeOnCancel?: boolean;
+    /**
+     * Close the dialog on confirm
+     * @default true
+     */
+    closeOnConfirm?: boolean;
+    /**
+     * Defines which button gets initial focus
+     * https://www.w3.org/TR/wai-aria-practices/#alertdialog
+     */
+    leastDestructiveFocus?: 'cancel' | 'confirm';
+    /**
+     * Function that's called when cancel is clicked
+     */
+    onCancel?: () => void;
+    /**
+     * Function that's called when confirm is clicked
+     */
+    onConfirm?: () => void;
+}
+declare const ConfirmDialog: React.FC<ConfirmDialogProps>;
+
+interface BaseDrawerProps extends Omit<DrawerProps$1, 'children'> {
+    /**
+     * The drawer title
+     */
+    title: React.ReactNode;
+    /**
+     * Hide the close button
+     */
+    hideCloseButton?: boolean;
+    /**
+     * Hide the overflow
+     */
+    hideOverlay?: boolean;
+    children?: React.ReactNode;
+}
+declare const BaseDrawer: React.FC<BaseDrawerProps>;
+interface DrawerProps extends BaseDrawerProps {
+    /**
+     * Drawer footer content, wrapped with `DrawerFooter`
+     */
+    footer?: React.ReactNode;
+}
+declare const Drawer: React.FC<DrawerProps>;
+
+interface BaseModalProps extends ModalProps {
+    /**
+     * The modal title
+     */
+    title?: React.ReactNode;
+    /**
+     * The modal footer
+     */
+    footer?: React.ReactNode;
+    /**
+     * Hide the close button
+     */
+    hideCloseButton?: boolean;
+    /**
+     * Hide the overlay
+     */
+    hideOverlay?: boolean;
+}
+declare const BaseModal: React.FC<BaseModalProps>;
+declare const Modal: React.FC<BaseModalProps>;
+
+interface MenuDialogProps extends BaseModalProps {
+    /**
+     * The modal footer, wrapped with `ModalFooter`
+     */
+    footer?: React.ReactNode;
+}
+declare const MenuDialog: React.FC<MenuDialogProps>;
+interface MenuDialogListProps extends Omit<BaseModalProps, 'isOpen' | 'onClose' | 'children' | 'scrollBehavior'>, Omit<MenuListProps, 'title'> {
+}
+declare const MenuDialogList: _chakra_ui_system_dist_system_types.ComponentWithAs<"div", MenuDialogListProps>;
+
+interface FormDialogProps<TFieldValues extends FieldValues = FieldValues, TContext extends object = object> extends Omit<BaseModalProps, 'children'>, Pick<FormProps<TFieldValues, TContext>, 'schema' | 'defaultValues' | 'values' | 'context' | 'onChange' | 'onSubmit' | 'onError' | 'resolver' | 'mode' | 'reValidateMode' | 'shouldFocusError' | 'shouldUnregister' | 'shouldUseNativeValidation' | 'criteriaMode' | 'delayError'> {
+    /**
+     * The modal footer, will be wrapped with `ModalFooter`.
+     * Defaults to a cancel and submit button.
+     */
+    footer?: React.ReactNode;
+    /**
+     * The cancel button label
+     * @default "Cancel"
+     */
+    cancelLabel?: React.ReactNode;
+    /**
+     * The submit button label
+     * @default "Submit"
+     */
+    submitLabel?: React.ReactNode;
+    /**
+     * If no children are passed, this will auto render fields based on the supplied schema.
+     */
+    children?: React.ReactNode;
+    /**
+     * A schema field resolver used to auto generate form fields.
+     */
+    fieldResolver?: FieldResolver;
+}
+declare const FormDialog: <TFieldValues extends FieldValues>(props: FormDialogProps<TFieldValues, object> & {
+    ref?: React.ForwardedRef<HTMLFormElement> | undefined;
+}) => React.ReactElement;
+
+interface ModalsContextValue {
+    open: (options: OpenOptions) => ModalId;
+    drawer: (options: DrawerOptions) => ModalId;
+    alert: (options: ConfirmDialogOptions) => ModalId;
+    confirm: (options: ConfirmDialogOptions) => ModalId;
+    menu: (options: MenuDialogOptions) => ModalId;
+    form: (options: FormDialogOptions) => ModalId;
+    close: (id: ModalId) => void;
+    closeAll: () => void;
+}
+declare const ModalsContext: React.Context<ModalsContextValue | null>;
+interface ModalsProviderProps {
+    children: React.ReactNode;
+    modals?: Record<string, React.FC<any>>;
+}
+type ModalId = string | number;
+interface ModalOptions extends Omit<BaseModalProps, 'onClose' | 'isOpen' | 'children'> {
+    onClose?: (args: {
+        force?: boolean;
+    }) => Promise<boolean | undefined> | void;
+    body?: React.ReactNode;
+    children?: React.ReactNode;
+    [key: string]: any;
+}
+interface DrawerOptions extends ModalOptions, Omit<DrawerProps, 'onClose' | 'isOpen' | 'children' | 'title' | 'size'> {
+}
+interface ConfirmDialogOptions extends ModalOptions, Omit<ConfirmDialogProps, 'onClose' | 'isOpen' | 'children'> {
+}
+interface MenuDialogOptions extends ModalOptions, Omit<MenuDialogProps, 'onClose' | 'isOpen' | 'children'> {
+}
+interface FormDialogOptions extends ModalOptions, Omit<FormDialogProps, 'onClose' | 'isOpen' | 'children'> {
+}
+interface OpenOptions extends ModalOptions {
+    type?: ModalTypes;
+    scope?: ModalScopes;
+}
+type ModalScopes = 'modal' | 'alert';
+type ModalTypes = 'modal' | 'drawer' | 'alert' | 'confirm' | 'menu' | string;
+interface ModalConfig<TModalOptions extends ModalOptions = ModalOptions> {
+    /**
+     * The modal id, autogenerated when not set.
+     * Can be used to close modals.
+     */
+    id?: ModalId | null;
+    /**
+     * The modal props
+     */
+    props?: TModalOptions | null;
+    /**
+     * The modal scope
+     * Modals can only have one level per scope.
+     * The default scopes are 'modal' and 'alert', alerts can be openend above modals.
+     */
+    scope?: ModalScopes | string;
+    /**
+     * The modal type to open.
+     * Build in types are 'modal', 'drawer', 'alert', 'confirm'
+     *
+     * Custom types can be configured using the `modals` prop of `ModalProvider`
+     */
+    type?: ModalTypes;
+    /**
+     * Render a custom modal component.
+     * This will ignore the `type` param.
+     */
+    component?: React.FC<BaseModalProps>;
+    /**
+     * Whether the modal is open or not.
+     * This is used internally to keep track of the modal state.
+     */
+    isOpen?: boolean;
+}
+declare function ModalsProvider({ children, modals }: ModalsProviderProps): JSX.Element;
+declare const useModalsContext: () => ModalsContextValue;
+declare const useModals: () => ModalsContextValue;
+
+export { BaseDrawer, BaseDrawerProps, BaseModal, BaseModalProps, ConfirmDialog, ConfirmDialogOptions, ConfirmDialogProps, Drawer, DrawerOptions, DrawerProps, FormDialog, FormDialogOptions, FormDialogProps, MenuDialog, MenuDialogList, MenuDialogListProps, MenuDialogOptions, MenuDialogProps, Modal, ModalConfig, ModalId, ModalScopes, ModalTypes, ModalsContext, ModalsContextValue, ModalsProvider, OpenOptions, useModals, useModalsContext };