@cloudoperators/juno-ui-components 5.3.0 → 5.4.0

package/build/components/Button/Button.component.d.ts

@@ -3,7 +3,7 @@ import { KnownIcons } from '../Icon/Icon.component';
 /**
  * The basic button component. Use this for `onClick` interactions.
  */
-export declare const Button: React.ForwardRefExoticComponent<Omit<ButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;
+export declare const Button: React.ForwardRefExoticComponent<Omit<ButtonProps, "ref"> & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
 type ButtonVariant = "primary" | "primary-danger" | "default" | "subdued";
 type ButtonSize = "small" | "default";
 export interface ButtonProps extends Omit<React.HTMLProps<HTMLAnchorElement> | React.HTMLProps<HTMLButtonElement>, "size"> {

package/build/components/Icon/Icon.component.d.ts

@@ -53,7 +53,7 @@ export declare enum KnownIconsEnum {
     widgets = "widgets"
 }
 export type KnownIcons = keyof typeof KnownIconsEnum;
-export declare const Icon: React.ForwardRefExoticComponent<Omit<IconProps, "ref"> & React.RefAttributes<HTMLButtonElement | HTMLAnchorElement>>;
+export declare const Icon: React.ForwardRefExoticComponent<Omit<IconProps, "ref"> & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
 export interface IconProps extends Omit<React.HTMLProps<HTMLAnchorElement> | React.HTMLProps<HTMLButtonElement>, "size"> {
     icon?: KnownIcons;
     color?: string;

package/build/components/PageHeader/PageHeader.component.d.ts

@@ -1,19 +1,39 @@
 import { default as React, ReactElement, ReactNode } from 'react';
 /**
- * The PageHeader component renders a header to the application.
- * In order to customize the header Logo, PageHeader accepts a `logo` prop that expects a custom component: `logo={<CustomLogo />}` Ideally, the custom logo component should return an `<img />` or an inline `<svg>` element. When using `svg`, make sure the file does not contain any unnecessary cruft. `Svgo` is a great tool to optimize `svg` files. Make sure the `viewBox` element is not removed when optimizing a file for usage a a header logo.
- * Pass as prop to AppShell so it gets slotted into the correct place in the layout. If building your layout manually without AppShell place as first child of AppBody.
+ * The `PageHeader` component renders a header for an application with customisable `logo`, `title` and other options.
+ * Ideally, the custom logo component should return an `<img />` or an inline `<svg>` element.
+ * When using SVG, ensure the file is optimized to eliminate any superfluous elements or data that can contribute to increased file size and reduced performance. `Svgo` is a great tool to optimize `svg` files. Make sure the `viewBox` element is not removed when optimizing a file for usage a a header logo.
+ * Pass as prop to `AppShell` so it gets slotted into the correct place in the layout. If building your layout manually without `AppShell` place as first child of AppBody.
  */
 export declare const PageHeader: React.FC<PageHeaderProps>;
 export interface PageHeaderProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Heading (typically the name of the application) */
+    /**
+     * Name of the application.
+     */
+    applicationName?: string;
+    /**
+     * DEPRECATED PROP - Replaced by `applicationName`. If `applicationName` is provided, it will take precedence.
+     */
     heading?: string | ReactElement;
-    /** Add custom class name */
+    /**
+     * Link to open when applicationName or logo is clicked. If `onClick` is provided, it will take precedence.
+     */
+    href?: string;
+    /**
+     * Custom class names.
+     */
     className?: string;
+    /**
+     * Application logo.
+     */
     logo?: boolean | ReactElement;
-    /** Optional: onClick handler for brand logo/page title. To be used to navigate to the home page.  */
+    /**
+     * Handler executed when `applicationName` or `logo` are clicked.
+     */
     onClick?: React.MouseEventHandler<HTMLDivElement>;
-    /** Children to render in the header such as user name, avatar, log-in/out button, etc. */
+    /**
+     * Children to render in the header such as user name, avatar, log-in/out button, etc.
+     */
     children?: ReactNode;
 }
 //# sourceMappingURL=PageHeader.component.d.ts.map

package/build/components/PageHeader/PageHeader.component.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PageHeader.component.d.ts","sourceRoot":"","sources":["../../../src/components/PageHeader/PageHeader.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AA+CtD;;;;GAIG;AAEH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CA8BhD,CAAA;AAED,MAAM,WAAW,eAAgB,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IAC3E,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,CAAA;IAC/B,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,GAAG,YAAY,CAAA;IAC7B,qGAAqG;IACrG,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAA;IACjD,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB"}
+{"version":3,"file":"PageHeader.component.d.ts","sourceRoot":"","sources":["../../../src/components/PageHeader/PageHeader.component.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AA0DtD;;;;;GAKG;AAEH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CA4ChD,CAAA;AAED,MAAM,WAAW,eAAgB,SAAQ,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;IAC3E;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,CAAA;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,YAAY,CAAA;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAA;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB"}

package/build/components/PageHeader/PageHeader.stories.d.ts

@@ -4,9 +4,9 @@ type Story = StoryObj<typeof meta>;
 declare const meta: Meta<typeof PageHeader>;
 export default meta;
 export declare const Default: Story;
-export declare const WithHeading: Story;
-export declare const WithHeadingAndChildren: Story;
-export declare const NoHeadingWithChildren: Story;
+export declare const WithapplicationName: Story;
+export declare const WithapplicationNameAndChildren: Story;
+export declare const NoapplicationNameWithChildren: Story;
 export declare const NoLogo: Story;
 export declare const WithCustomLogoSquareInline: Story;
 export declare const WithCustomLogoLandscapeInline: Story;

package/build/components/PageHeader/PageHeader.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PageHeader.stories.d.ts","sourceRoot":"","sources":["../../../src/components/PageHeader/PageHeader.stories.tsx"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAO3D,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAgBpC,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAA;AAElC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,UAAU,CAuBjC,CAAA;AACD,eAAe,IAAI,CAAA;AAEnB,eAAO,MAAM,OAAO,EAAE,KAKrB,CAAA;AAED,eAAO,MAAM,WAAW,EAAE,KASzB,CAAA;AAED,eAAO,MAAM,sBAAsB,EAAE,KAKpC,CAAA;AAED,eAAO,MAAM,qBAAqB,EAAE,KAInC,CAAA;AAED,eAAO,MAAM,MAAM,EAAE,KAMpB,CAAA;AAED,eAAO,MAAM,0BAA0B,EAAE,KAMxC,CAAA;AAED,eAAO,MAAM,6BAA6B,EAAE,KAM3C,CAAA;AAED,eAAO,MAAM,4BAA4B,EAAE,KAK1C,CAAA;AAED,eAAO,MAAM,uBAAuB,EAAE,KAMrC,CAAA;AAED,eAAO,MAAM,0BAA0B,EAAE,KAMxC,CAAA;AAED,eAAO,MAAM,yBAAyB,EAAE,KAMvC,CAAA"}
+{"version":3,"file":"PageHeader.stories.d.ts","sourceRoot":"","sources":["../../../src/components/PageHeader/PageHeader.stories.tsx"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAO3D,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAGpC,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAA;AAElC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,OAAO,UAAU,CAuBjC,CAAA;AACD,eAAe,IAAI,CAAA;AAEnB,eAAO,MAAM,OAAO,EAAE,KAKrB,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,KAIjC,CAAA;AAED,eAAO,MAAM,8BAA8B,EAAE,KAU5C,CAAA;AAED,eAAO,MAAM,6BAA6B,EAAE,KAS3C,CAAA;AAED,eAAO,MAAM,MAAM,EAAE,KAWpB,CAAA;AAED,eAAO,MAAM,0BAA0B,EAAE,KAWxC,CAAA;AAED,eAAO,MAAM,6BAA6B,EAAE,KAW3C,CAAA;AAED,eAAO,MAAM,4BAA4B,EAAE,KAK1C,CAAA;AAED,eAAO,MAAM,uBAAuB,EAAE,KAWrC,CAAA;AAED,eAAO,MAAM,0BAA0B,EAAE,KAWxC,CAAA;AAED,eAAO,MAAM,yBAAyB,EAAE,KAWvC,CAAA"}