@axinom/mosaic-ui 0.32.0-rc.1 → 0.32.0-rc.11

package/dist/components/PageHeader/PageHeaderAction/PageHeaderAction.d.ts

@@ -1,41 +1,28 @@
 import React from 'react';
-import { ConfirmationConfig, ConfirmationMode } from '../../ConfirmDialog';
-import { IconName } from '../../Icons';
-import { ErrorType } from '../../models';
-export declare enum PageHeaderActionType {
-    Active = 0,
-    Context = 1,
-    Navigation = 2
-}
-export interface PageHeaderActionProps {
-    /** The label of the action. */
-    label: string;
-    /**
-     * Whether the action is an 'Active', 'Context', or 'Navigation' type.
-     * Changes the background color to the corresponding action type. (default: 'Navigation')
-     */
-    actionType?: PageHeaderActionType;
-    /** Optional built in icon. This prop also accepts an img src. */
-    icon?: IconName | string;
-    /** Optional image alt attribute. */
-    imgAlt?: string;
-    /** Whether the action is disabled. If set to true, disallows interactions. (default: undefined) */
-    disabled?: boolean;
-    /** Optional class */
-    className?: string;
-    /** If set to 'Simple', the action will require confirmation. If set to 'Advanced', action will require confirmation via a confirmation pop up. (default: 'None') */
-    confirmationMode?: ConfirmationMode;
-    /** Optional text overrides for the confirmation pop up. */
-    confirmationConfig?: ConfirmationConfig;
-    /**
-     * Callback to emit when a user clicks on the component
-     */
-    onClick: () => Promise<ErrorType | void> | ErrorType | void;
-}
+import { PageHeaderActionProps, PageHeaderJsActionProps, PageHeaderNavigationActionProps } from './PageHeaderAction.model';
 /**
  * Used to create actions for the PageHeader component.
+ * To generate anchor tag provide `path` property
+ * To generate HTML element with event handler provide `onClick` property
+ * (and optionally `confirmationMode`, `confirmationConfig`)
  * @example
+ * // Action with JS clickHandler
  * <PageHeaderAction label={'Action Label'} onClick={clickHandler} />
+ *
+ * // Action with anchor tag
+ * <PageHeaderAction label={'Action Label'} path={'/action-path'} />
  */
 export declare const PageHeaderAction: React.FC<PageHeaderActionProps>;
+/**
+ * Determines whether an action data object is a PageHeaderNavigationActionProps object.
+ * @param {PageHeaderActionProps} action - The action data object to check.
+ * @returns {boolean} - Whether the action data object is a PageHeaderNavigationActionProps object.
+ */
+export declare function isPageHeaderNavigationAction(action: PageHeaderActionProps): action is PageHeaderNavigationActionProps;
+/**
+ * Determines whether an action data object is a PageHeaderJsActionProps object.
+ * @param {PageHeaderActionProps} action - The action data object to check.
+ * @returns {boolean} - Whether the action data object is a PageHeaderJsActionProps object.
+ */
+export declare function isPageHeaderJsAction(action: PageHeaderActionProps): action is PageHeaderJsActionProps;
 //# sourceMappingURL=PageHeaderAction.d.ts.map

package/dist/components/PageHeader/PageHeaderAction/PageHeaderAction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PageHeaderAction.d.ts","sourceRoot":"","sources":["../../../../src/components/PageHeader/PageHeaderAction/PageHeaderAction.tsx"],"names":[],"mappings":"AACA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAEnD,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAGjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAS,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,oBAAY,oBAAoB;IAC9B,MAAM,IAAA;IACN,OAAO,IAAA;IACP,UAAU,IAAA;CACX;AAED,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,iEAAiE;IACjE,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACzB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mGAAmG;IACnG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oKAAoK;IACpK,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;CAC7D;AAsBD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CAyH5D,CAAC"}
+{"version":3,"file":"PageHeaderAction.d.ts","sourceRoot":"","sources":["../../../../src/components/PageHeader/PageHeaderAction/PageHeaderAction.tsx"],"names":[],"mappings":"AACA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAUnD,OAAO,EACL,qBAAqB,EAErB,uBAAuB,EACvB,+BAA+B,EAChC,MAAM,0BAA0B,CAAC;AAuBlC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CAK1D,CAAC;AAqKJ;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,qBAAqB,GAC5B,MAAM,IAAI,+BAA+B,CAE3C;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,qBAAqB,GAC5B,MAAM,IAAI,uBAAuB,CAEnC"}

package/dist/components/PageHeader/PageHeaderAction/PageHeaderAction.model.d.ts

@@ -0,0 +1,47 @@
+import { Not } from '../../../types';
+import { IconName } from '../../Icons';
+import { ConfirmAction, DefaultHandler, LinkAction } from '../../models';
+export declare enum PageHeaderActionType {
+    Active = 0,
+    Context = 1,
+    /**
+     * @deprecated This value is no longer necessary for navigation type actions in the
+     * `PageHeaderAction` component, and will be removed in the future.
+     * To create a navigation link, use the `path` property instead of the `onClick` handler,
+     * which will automatically generate an anchor element.
+     * @note This deprecation only affects the `Navigation` enum value in the PageHeaderActionType
+     */
+    Navigation = 2
+}
+export type PageHeaderActionProps = PageHeaderJsActionProps | PageHeaderNavigationActionProps;
+export interface PageHeaderJsActionProps extends BaseActionOptions, HandledAction, ConfirmAction, Not<LinkAction> {
+    /**
+     * Whether the action is an 'Active' or 'Context' type.
+     * Changes the background color to the corresponding action type. (default: 'Context')
+     * Type `Navigation` is deprecated and will be removed in the future
+     * define instead of `onClick` handler `path` property to render element with anchor tag
+     */
+    actionType?: PageHeaderActionType;
+}
+export interface PageHeaderNavigationActionProps extends BaseActionOptions, LinkAction, Not<ConfirmAction>, Not<HandledAction> {
+}
+interface HandledAction {
+    /**
+     * Callback to emit when a user clicks on the component
+     */
+    onClick: DefaultHandler;
+}
+interface BaseActionOptions {
+    /** The label of the action. */
+    label: string;
+    /** Optional built in icon. This prop also accepts an img src. */
+    icon?: IconName | string;
+    /** Optional image alt attribute. */
+    imgAlt?: string;
+    /** Whether the action is disabled. If set to true, disallows interactions. (default: undefined) */
+    disabled?: boolean;
+    /** Optional class */
+    className?: string;
+}
+export {};
+//# sourceMappingURL=PageHeaderAction.model.d.ts.map

package/dist/components/PageHeader/PageHeaderAction/PageHeaderAction.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageHeaderAction.model.d.ts","sourceRoot":"","sources":["../../../../src/components/PageHeader/PageHeaderAction/PageHeaderAction.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEzE,oBAAY,oBAAoB;IAC9B,MAAM,IAAA;IACN,OAAO,IAAA;IACP;;;;;;OAMG;IACH,UAAU,IAAA;CACX;AAED,MAAM,MAAM,qBAAqB,GAC7B,uBAAuB,GACvB,+BAA+B,CAAC;AAEpC,MAAM,WAAW,uBACf,SAAQ,iBAAiB,EACvB,aAAa,EACb,aAAa,EACb,GAAG,CAAC,UAAU,CAAC;IACjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC;AAED,MAAM,WAAW,+BACf,SAAQ,iBAAiB,EACvB,UAAU,EACV,GAAG,CAAC,aAAa,CAAC,EAClB,GAAG,CAAC,aAAa,CAAC;CAAG;AAEzB,UAAU,aAAa;IACrB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,UAAU,iBAAiB;IACzB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACzB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mGAAmG;IACnG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/components/PageHeader/PageHeaderAction/index.d.ts

@@ -0,0 +1,3 @@
+export * from './PageHeaderAction';
+export * from './PageHeaderAction.model';
+//# sourceMappingURL=index.d.ts.map

package/dist/components/PageHeader/PageHeaderAction/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/PageHeader/PageHeaderAction/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC"}

package/dist/components/PageHeader/PageHeaderBulkActions/PageHeaderBulkActions.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { PageHeaderProps } from '../PageHeader';
-import { PageHeaderActionProps } from '../PageHeaderAction/PageHeaderAction';
+import { PageHeaderProps } from '../PageHeader.model';
+import { PageHeaderActionProps } from '../PageHeaderAction/PageHeaderAction.model';
 export interface PageHeaderBulkActionsProps extends Pick<PageHeaderProps, 'openBulkActionsOnStart' | 'onBulkActionsToggled'> {
     /** Array of Actions to be rendered (default: []) */
     actions?: PageHeaderActionProps[];

package/dist/components/PageHeader/PageHeaderBulkActions/PageHeaderBulkActions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PageHeaderBulkActions.d.ts","sourceRoot":"","sources":["../../../../src/components/PageHeader/PageHeaderBulkActions/PageHeaderBulkActions.tsx"],"names":[],"mappings":"AACA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAKnD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAEL,qBAAqB,EAEtB,MAAM,sCAAsC,CAAC;AAG9C,MAAM,WAAW,0BACf,SAAQ,IAAI,CACV,eAAe,EACf,wBAAwB,GAAG,sBAAsB,CAClD;IACD,oDAAoD;IACpD,OAAO,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAClC,kEAAkE;IAClE,oBAAoB,EAAE,MAAM,CAAC;IAC7B,+DAA+D;IAC/D,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,KAAK,CAAC,EAAE,CAAC,0BAA0B,CA0ItE,CAAC"}
+{"version":3,"file":"PageHeaderBulkActions.d.ts","sourceRoot":"","sources":["../../../../src/components/PageHeader/PageHeaderBulkActions/PageHeaderBulkActions.tsx"],"names":[],"mappings":"AACA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAKnD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAKtD,OAAO,EACL,qBAAqB,EAEtB,MAAM,4CAA4C,CAAC;AAGpD,MAAM,WAAW,0BACf,SAAQ,IAAI,CACV,eAAe,EACf,wBAAwB,GAAG,sBAAsB,CAClD;IACD,oDAAoD;IACpD,OAAO,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAClC,kEAAkE;IAClE,oBAAoB,EAAE,MAAM,CAAC;IAC7B,+DAA+D;IAC/D,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,KAAK,CAAC,EAAE,CAAC,0BAA0B,CAoJtE,CAAC"}

package/dist/components/PageHeader/index.d.ts

@@ -1,3 +1,4 @@
-export { PageHeader, PageHeaderProps } from './PageHeader';
-export { PageHeaderAction, PageHeaderActionProps, PageHeaderActionType, } from './PageHeaderAction/PageHeaderAction';
+export { PageHeader } from './PageHeader';
+export { PageHeaderProps } from './PageHeader.model';
+export { PageHeaderAction, PageHeaderActionProps, PageHeaderActionType, } from './PageHeaderAction';
 //# sourceMappingURL=index.d.ts.map

package/dist/components/PageHeader/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/PageHeader/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,qCAAqC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/PageHeader/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC"}

package/dist/components/models.d.ts

@@ -1,4 +1,6 @@
+import { LocationDescriptor } from 'history';
 import React from 'react';
+import { ConfirmationConfig, ConfirmationMode } from './ConfirmDialog';
 import { MessageBarProps } from './MessageBar';
 export type StationError = Pick<MessageBarProps, 'title'> & {
     /**
@@ -18,4 +20,24 @@ export type StationMessage = MessageBarProps & {
  * Possible error options the engine will handle
  */
 export type ErrorType = StationError | string | Object | Error;
+/** Properties to generate a link */
+export interface LinkAction {
+    /** Where to navigate to when the action is clicked. */
+    path: LocationDescriptor<unknown>;
+    /** If set to true, the link will open in a new tab. */
+    openInNewTab?: boolean;
+}
+/**
+ * Properties for Action click confirmation
+ */
+export interface ConfirmAction {
+    /** If set to 'Simple', the action will require confirmation. If set to 'Advanced', action will require confirmation via a confirmation pop up. (default: 'None') */
+    confirmationMode?: ConfirmationMode;
+    /** Optional text overrides for the confirmation pop up. */
+    confirmationConfig?: ConfirmationConfig;
+}
+/**
+ * Default Action click event handler
+ */
+export type DefaultHandler = () => Promise<ErrorType | undefined | void> | ErrorType | undefined | void;
 //# sourceMappingURL=models.d.ts.map

package/dist/components/models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/components/models.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAC1D;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG;IAC7C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;CACjC,CAAC;AACF;;GAEG;AAEH,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC"}
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/components/models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAC1D;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG;IAC7C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;CACjC,CAAC;AAEF;;GAEG;AAEH,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAE/D,oCAAoC;AACpC,MAAM,WAAW,UAAU;IACzB,uDAAuD;IACvD,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAClC,uDAAuD;IACvD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,oKAAoK;IACpK,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MACzB,OAAO,CAAC,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC,GACrC,SAAS,GACT,SAAS,GACT,IAAI,CAAC"}