@axinom/mosaic-ui 0.74.0-rc.9 → 0.74.1

package/dist/cjs/components/FormStation/FormStation.d.ts

@@ -38,6 +38,22 @@ export interface FormStationProps<TValues extends Data = FormikValues, TSubmitRe
     validationSchema?: OptionalObjectSchema<ObjectSchemaDefinition<TValues>>;
     /** URL to navigate to when the form is reset (usually on a create station) */
     cancelNavigationUrl?: string;
+    /**
+     * Called when the header's 'Cancel' action was selected and the form was
+     * reset. Takes precedence over `cancelNavigationUrl`.
+     */
+    onCancel?: () => void;
+    /**
+     * Called once the header's save action saved the form successfully. Setting
+     * it also makes that action submit the form directly, instead of saving on
+     * navigation.
+     */
+    onSaveCompleted?: () => void;
+    /**
+     * If set to true, a dirty form is saved when the user navigates away, and
+     * navigation is cancelled while the form is invalid. (default: true)
+     */
+    saveOnNavigate?: boolean;
     /** Component which contains additional information */
     infoPanel?: JSX.Element;
     /** Optional flag for removing the padding around child components. */
@@ -62,5 +78,5 @@ export interface FormStationProps<TValues extends Data = FormikValues, TSubmitRe
     /** CSS Class name for additional styles */
     className?: string;
 }
-export declare const FormStation: <TValues extends Data, TSubmitResponse = unknown>({ titleProperty, defaultTitle, subtitle, children, alwaysShowActionsPanel, actions, actionsWidth, cancelNavigationUrl, initialData, saveData, validationSchema, infoPanel, edgeToEdgeContent, alwaysSubmitBeforeAction, stationMessage, className, setTabTitle, showSaveHeaderAction, saveHeaderActionConfig, saveNotificationMessage, }: PropsWithChildren<FormStationProps<TValues, TSubmitResponse>>) => JSX.Element;
+export declare const FormStation: <TValues extends Data, TSubmitResponse = unknown>({ titleProperty, defaultTitle, subtitle, children, alwaysShowActionsPanel, actions, actionsWidth, cancelNavigationUrl, onCancel, onSaveCompleted, saveOnNavigate, initialData, saveData, validationSchema, infoPanel, edgeToEdgeContent, alwaysSubmitBeforeAction, stationMessage, className, setTabTitle, showSaveHeaderAction, saveHeaderActionConfig, saveNotificationMessage, }: PropsWithChildren<FormStationProps<TValues, TSubmitResponse>>) => JSX.Element;
 //# sourceMappingURL=FormStation.d.ts.map

package/dist/cjs/components/FormStation/FormStation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormStation.d.ts","sourceRoot":"","sources":["../../../../src/components/FormStation/FormStation.tsx"],"names":[],"mappings":"AACA,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AACnD,OAAc,EACZ,KAAK,iBAAiB,EAMvB,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAI7C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAW9B,MAAM,WAAW,gBAAgB,CAC/B,OAAO,SAAS,IAAI,GAAG,YAAY,EACnC,eAAe,GAAG,OAAO;IAEzB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC;IAC9B,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,oEAAoE;IACpE,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,EAAE,CAAC;IACrD,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC;IACzE;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,WAAW,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IACtC,mFAAmF;IACnF,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,sDAAsD;IACtD,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IACxB,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,8FAA8F;IAC9F,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACrD,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,eAAO,MAAM,WAAW,GAAI,OAAO,SAAS,IAAI,EAAE,eAAe,GAAG,OAAO,EAAE,0UAqB1E,iBAAiB,CAClB,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,CAC3C,KAAG,GAAG,CAAC,OAgIP,CAAC"}
+{"version":3,"file":"FormStation.d.ts","sourceRoot":"","sources":["../../../../src/components/FormStation/FormStation.tsx"],"names":[],"mappings":"AACA,OAAO,EAAU,KAAK,YAAY,EAAE,MAAM,QAAQ,CAAC;AACnD,OAAc,EACZ,KAAK,iBAAiB,EAMvB,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAI7C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAW9B,MAAM,WAAW,gBAAgB,CAC/B,OAAO,SAAS,IAAI,GAAG,YAAY,EACnC,eAAe,GAAG,OAAO;IAEzB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC;IAC9B,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,oEAAoE;IACpE,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,EAAE,CAAC;IACrD,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC;IACzE;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,WAAW,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IACtC,mFAAmF;IACnF,gBAAgB,CAAC,EAAE,oBAAoB,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,sDAAsD;IACtD,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IACxB,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,8FAA8F;IAC9F,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACrD,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,eAAO,MAAM,WAAW,GAAI,OAAO,SAAS,IAAI,EAAE,eAAe,GAAG,OAAO,EAAE,qXAwB1E,iBAAiB,CAClB,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,CAC3C,KAAG,GAAG,CAAC,OAkIP,CAAC"}

package/dist/cjs/components/FormStation/FormStationHeader/FormStationHeader.d.ts

@@ -8,6 +8,8 @@ export declare const FormStationHeader: React.FC<Omit<PageHeaderProps, 'title'>
     titleProperty?: string;
     defaultTitle?: string;
     cancelNavigationUrl?: string;
+    onCancel?: () => void;
+    onSaveCompleted?: () => void;
     setTabTitle?: boolean;
     showSaveHeaderAction?: boolean;
     saveHeaderActionConfig?: Pick<PageHeaderJsActionProps, 'label' | 'icon'>;

package/dist/cjs/components/FormStation/FormStationHeader/FormStationHeader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormStationHeader.d.ts","sourceRoot":"","sources":["../../../../../src/components/FormStation/FormStationHeader/FormStationHeader.tsx"],"names":[],"mappings":"AACA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAKnD,OAAO,EAIL,KAAK,eAAe,EACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAGjF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,EAAE,CACtC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,sBAAsB,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC;IACzE,kBAAkB,EAAE,MAAM,IAAI,CAAC;CAChC,CA4HF,CAAC"}
+{"version":3,"file":"FormStationHeader.d.ts","sourceRoot":"","sources":["../../../../../src/components/FormStation/FormStationHeader/FormStationHeader.tsx"],"names":[],"mappings":"AACA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAKnD,OAAO,EAIL,KAAK,eAAe,EACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAGjF;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,EAAE,CACtC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,sBAAsB,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC;IACzE,kBAAkB,EAAE,MAAM,IAAI,CAAC;CAChC,CA0JF,CAAC"}

package/dist/cjs/components/FormStation/ModalForm/ModalForm.d.ts

@@ -0,0 +1,41 @@
+import { type PropsWithChildren } from 'react';
+import type { Data } from '../../../types/data';
+import { type FormStationProps } from '../FormStation';
+export type ModalFormProps<TValues extends Data, TSubmitResponse = unknown> = Omit<FormStationProps<TValues, TSubmitResponse>, 'cancelNavigationUrl' | 'onCancel' | 'onSaveCompleted' | 'saveOnNavigate' | 'defaultTitle' | 'titleProperty' | 'setTabTitle'> & {
+    /** The title of the form, shown in the modal's header */
+    title: string;
+    /**
+     * Closes the modal hosting the form. Pass the `closeModal` callback the
+     * `useModal` hook provides to the modal component.
+     */
+    closeModal: () => void;
+    /**
+     * The width of the form inside the modal (as CSS width).
+     * Defaults to the full width the modal leaves over.
+     */
+    width?: string;
+};
+/**
+ * This component is the basic building block for forms shown inside a modal.
+ *
+ * Its header actions are bound to the hosting modal instead of the router:
+ * 'Cancel' discards the changes and closes the modal, 'Save' calls `saveData`
+ * and closes the modal once the data was saved. A failed save keeps the modal
+ * open and shows the error.
+ *
+ * Use it with the `useModal` hook, or with `useModalForm`, which combines both.
+ *
+ * @example
+ * const { ModalWrapper, openModal } = useModal(({ closeModal }) => (
+ *   <ModalForm<Genre>
+ *     title="Edit Genre"
+ *     closeModal={closeModal}
+ *     initialData={{ loading, data }}
+ *     saveData={saveData}
+ *   >
+ *     <Field name="title" label="Title" as={SingleLineTextField} />
+ *   </ModalForm>
+ * ));
+ */
+export declare const ModalForm: <TValues extends Data, TSubmitResponse = unknown>({ title, closeModal, width, className, ...props }: PropsWithChildren<ModalFormProps<TValues, TSubmitResponse>>) => JSX.Element;
+//# sourceMappingURL=ModalForm.d.ts.map

package/dist/cjs/components/FormStation/ModalForm/ModalForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalForm.d.ts","sourceRoot":"","sources":["../../../../../src/components/FormStation/ModalForm/ModalForm.tsx"],"names":[],"mappings":"AACA,OAAc,EAAE,KAAK,iBAAiB,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAGpE,MAAM,MAAM,cAAc,CACxB,OAAO,SAAS,IAAI,EACpB,eAAe,GAAG,OAAO,IACvB,IAAI,CACN,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,EACxC,qBAAqB,GACrB,UAAU,GACV,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,aAAa,CAChB,GAAG;IACF,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,SAAS,IAAI,EAAE,eAAe,GAAG,OAAO,EAAE,mDAMxE,iBAAiB,CAClB,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,CACzC,KAAG,GAAG,CAAC,OAcP,CAAC"}

package/dist/cjs/components/FormStation/ModalForm/useModalForm.d.ts

@@ -0,0 +1,19 @@
+import { type PropsWithChildren } from 'react';
+import type { Data } from '../../../types/data';
+import { type UseModalResult } from '../../Modal';
+import { type ModalFormProps } from './ModalForm';
+export type UseModalFormOptions<TValues extends Data, TSubmitResponse = unknown> = PropsWithChildren<Omit<ModalFormProps<TValues, TSubmitResponse>, 'closeModal'>>;
+/**
+ * The `useModal` hook with a `ModalForm` already wired up: shows the form in a
+ * modal and returns the methods to control it.
+ *
+ * @example
+ * const { ModalWrapper, openModal } = useModalForm<Genre>({
+ *   title: 'Edit Genre',
+ *   initialData: { loading, data },
+ *   saveData,
+ *   children: <Field name="title" label="Title" as={SingleLineTextField} />,
+ * });
+ */
+export declare const useModalForm: <TValues extends Data, TSubmitResponse = unknown>(options: UseModalFormOptions<TValues, TSubmitResponse>) => UseModalResult;
+//# sourceMappingURL=useModalForm.d.ts.map

package/dist/cjs/components/FormStation/ModalForm/useModalForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useModalForm.d.ts","sourceRoot":"","sources":["../../../../../src/components/FormStation/ModalForm/useModalForm.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,iBAAiB,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,KAAK,cAAc,EAAY,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAa,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7D,MAAM,MAAM,mBAAmB,CAC7B,OAAO,SAAS,IAAI,EACpB,eAAe,GAAG,OAAO,IACvB,iBAAiB,CACnB,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,EAAE,YAAY,CAAC,CAC7D,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,SAAS,IAAI,EAAE,eAAe,GAAG,OAAO,EAC1E,SAAS,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,KACrD,cAGC,CAAC"}

package/dist/cjs/components/FormStation/index.d.ts

@@ -3,4 +3,6 @@ export { Details, type DetailsProps } from './Details/Details';
 export { FormGrid } from './FormGrid';
 export { FormStation, type FormStationProps } from './FormStation';
 export * from './FormStation.models';
+export { ModalForm, type ModalFormProps } from './ModalForm/ModalForm';
+export { useModalForm, type UseModalFormOptions, } from './ModalForm/useModalForm';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/components/FormStation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/FormStation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACnE,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/FormStation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACnE,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EACL,YAAY,EACZ,KAAK,mBAAmB,GACzB,MAAM,0BAA0B,CAAC"}