@skodaflow/web-library 3.3.0-alpha.0 → 3.3.0

package/build/layout/Error/ErrorContent.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+export type ErrorContentProps = {
+    /** Error Status, eg. 404 or 500 */
+    status: React.ReactNode;
+    /** Short message describing the error */
+    message?: React.ReactNode;
+    /** Longer description of the error */
+    description?: React.ReactNode;
+    /** Actions that user can interact with */
+    actions?: React.ReactNode;
+    /** Stacktrace of an error */
+    stacktrace?: string;
+};
+/**
+ * Component that simplifies rendering of the error
+ * @param props ErrorContentProps
+ */
+export declare const ErrorContent: React.FC<ErrorContentProps>;

package/build/layout/Error/ErrorLayout.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { ErrorContentProps } from './ErrorContent';
+import { PageLayoutProps } from '../PageLayout';
+export type ErrorLayoutProps = Omit<PageLayoutProps, 'children'> & {
+    /** Properties that are forwarded to `ErrorContent` component */
+    errorContentProps: ErrorContentProps;
+};
+/**
+ * Layout component that simplifies rendering of an error
+ * @param props ErrorLayoutProps
+ */
+export declare const ErrorLayout: React.FC<ErrorLayoutProps>;

package/build/layout/Error/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ErrorLayout';
+export * from './ErrorContent';

package/build/layout/Footer/Footer.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+export type FooterProps = {
+    /** Array of primary navigation items */
+    primaryItems?: Array<React.ReactNode>;
+    /** Array of secondary navigation items */
+    secondaryItems?: Array<React.ReactNode>;
+    /** React node that renders social buttons */
+    socialButtons?: React.ReactNode;
+    /** React node that renders copyright claim */
+    copyRight?: React.ReactNode;
+    /** Rect node that renders location selection */
+    location?: React.ReactNode;
+    /** Specifies direction of the component */
+    direction?: 'ltr' | 'rtl';
+};
+export declare const Footer: React.FC<FooterProps>;

package/build/layout/Footer/FooterIconButton.d.ts

@@ -0,0 +1,10 @@
+import { IconButtonProps } from '@mui/material';
+import React from 'react';
+export type FooterIconButtonProps<C extends React.ElementType> = {
+    /** FWL string identifier of an icon */
+    icon: string;
+} & IconButtonProps<C, {
+    component?: C;
+}>;
+/** Renders icon button intended for `Footer` component */
+export declare function FooterIconButton<C extends React.ElementType = 'button'>(props: FooterIconButtonProps<C>): React.JSX.Element;

package/build/layout/Footer/FooterNavItem.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { OverrideProps } from '@mui/material/OverridableComponent';
+export interface FooterNavItemTypeMap<P = {}, C extends React.ElementType = 'a'> {
+    props: P & {
+        /** Label of navigation item */
+        label: string;
+    };
+    defaultComponent: C;
+}
+export type FooterNavItemProps<C extends React.ElementType, P = {}> = OverrideProps<FooterNavItemTypeMap<P, C>, C> & {
+    component?: C;
+};
+/** Renders navigation item for `Footer` component */
+export declare function FooterNavItem<C extends React.ElementType = 'a'>(props: FooterNavItemProps<C>): React.JSX.Element;

package/build/layout/Footer/PredefinedFooterIconButtons.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { IconButtonProps } from '@mui/material';
+export type PredefinedFooterIconButtonProps<C extends React.ElementType> = IconButtonProps<C, {
+    component?: C;
+}>;
+export declare function FacebookFooterIconButton<C extends React.ElementType>(props: PredefinedFooterIconButtonProps<C>): import("react").JSX.Element;
+export declare function InstagramFooterIconButton<C extends React.ElementType>(props: PredefinedFooterIconButtonProps<C>): import("react").JSX.Element;
+export declare function TwitterFooterIconButton<C extends React.ElementType>(props: PredefinedFooterIconButtonProps<C>): import("react").JSX.Element;
+export declare function YoutubeFooterIconButton<C extends React.ElementType>(props: PredefinedFooterIconButtonProps<C>): import("react").JSX.Element;

package/build/layout/Footer/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Footer';
+export * from './FooterNavItem';
+export * from './FooterIconButton';
+export * from './PredefinedFooterIconButtons';

package/build/layout/Header/Header.d.ts

@@ -1,8 +1,12 @@
 import React from 'react';
 export type HeaderProps = {
-    logo?: any;
+    /** React node that renders header logo */
+    logo?: React.ReactNode;
+    /** React node that renders all navigation items */
     navigationItems?: React.ReactNode;
-    overheadItems?: any;
-    buttons?: any;
+    /** React node that renders all overhead navigation items */
+    overheadItems?: React.ReactNode;
+    /** React node that renders all header buttons */
+    buttons?: React.ReactNode;
 };
 export declare const Header: React.FC<HeaderProps>;

package/build/layout/Header/HeaderSkodaLogo.d.ts

@@ -1,4 +1,6 @@
 import React from 'react';
-import { HeaderLogoProps } from './HeaderLogo';
-export type HeaderSkodaLogoProps<C extends React.ElementType> = Omit<HeaderLogoProps<C>, 'src' | 'alt'>;
+import { LinkProps } from '@mui/material';
+export type HeaderSkodaLogoProps<C extends React.ElementType> = LinkProps<C, {
+    component?: C;
+}>;
 export declare function HeaderSkodaLogo<C extends React.ElementType = 'a'>(props: HeaderSkodaLogoProps<C>): React.JSX.Element;

package/build/layout/Header/PredefinedHeaderButtons.d.ts

@@ -1,6 +1,10 @@
 import React from 'react';
-import { HeaderButtonProps } from './HeaderButton';
-export type PredefinedHeaderButtonProps<C extends React.ElementType> = Omit<HeaderButtonProps<C>, 'icon'>;
+import { IconButtonProps } from '@mui/material';
+export type PredefinedHeaderButtonProps<C extends React.ElementType> = {
+    label?: string;
+} & IconButtonProps<C, {
+    component?: C;
+}>;
 export declare function HeaderSearchButton<C extends React.ElementType>(props: PredefinedHeaderButtonProps<C>): React.JSX.Element;
 export declare function HeaderProfileButton<C extends React.ElementType>(props: PredefinedHeaderButtonProps<C>): React.JSX.Element;
 export declare function HeaderHeartButton<C extends React.ElementType>(props: PredefinedHeaderButtonProps<C>): React.JSX.Element;

package/build/layout/PageLayout/PageLayout.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+export type PageLayoutProps = {
+    /** Content of an page */
+    children: React.ReactNode;
+    /** React node that renders layout header */
+    header?: React.ReactNode;
+    /** React node that renders layout footer */
+    footer?: React.ReactNode;
+    /** Specifies position of header */
+    headerPosition?: 'static' | 'fixed' | 'slide';
+    /** Specifies threshold that is used to hide header */
+    headerSlideThreshold?: number;
+    /** Specifies if content should be automatically wrapped into contaienr component */
+    wrapContent?: boolean;
+};
+export declare const PageLayout: React.FC<PageLayoutProps>;

package/build/layout/PageLayout/index.d.ts

@@ -0,0 +1 @@
+export * from './PageLayout';

package/build/layout/SideMenu/SideMenu.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+export type SideMenuProps = {
+    /** Specifies if menu is open */
+    open: boolean;
+    /** Callback that causes menu to close */
+    handleClose: () => void;
+    /** Direction of the component */
+    direction?: 'rtl' | 'ltr';
+    /** React node that renders all navigation items */
+    items: React.ReactNode;
+    /** React node that renders all sub navigation items */
+    subItems?: React.ReactNode;
+};
+export declare const SideMenu: React.FC<SideMenuProps>;

package/build/layout/SideMenu/SideMenuItem.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { OverrideProps } from '@mui/material/OverridableComponent';
+export interface SideMenuItemTypeMap<P = {}, C extends React.ElementType = 'a'> {
+    props: P & {
+        /** label of an item */
+        label: string;
+    };
+    defaultComponent: C;
+}
+export type SideMenuItemProps<C extends React.ElementType, P = {}> = OverrideProps<SideMenuItemTypeMap<P, C>, C> & {
+    component?: C;
+};
+export declare function SideMenuItem<C extends React.ElementType = 'a'>(props: SideMenuItemProps<C>): React.JSX.Element;

package/build/layout/SideMenu/index.d.ts

@@ -0,0 +1,2 @@
+export * from './SideMenu';
+export * from './SideMenuItem';

package/build/layout/index.d.ts

@@ -1 +1,5 @@
 export * from './Header';
+export * from './SideMenu';
+export * from './Footer';
+export * from './Error';
+export * from './PageLayout';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skodaflow/web-library",
-  "version": "3.3.0-alpha.0",
+  "version": "3.3.0",
   "description": "Implementation of Skoda Flow Design System with Material UI as core library.",
   "author": "Skoda Auto",
   "license": "SEE LICENSE IN eula.txt",
@@ -38,7 +38,6 @@
   "dependencies": {
     "@googlemaps/markerclusterer": "^1.0.22",
     "@googlemaps/react-wrapper": "^1.1.22",
-    "@mui/base": "^5.0.0-alpha.125",
     "@skodaflow/web-tokens": "^2.4.0",
     "ag-grid-community": "^29.1.0",
     "ag-grid-react": "^29.1.0",
@@ -47,7 +46,8 @@
     "embla-carousel-autoplay": "^7.1.0",
     "embla-carousel-class-names": "^7.1.0",
     "embla-carousel-react": "^7.1.0",
-    "embla-carousel-wheel-gestures": "^3.0.0"
+    "embla-carousel-wheel-gestures": "^3.0.0",
+    "react-use": "^17.4.0"
   },
   "devDependencies": {
     "@cypress/react": "5.12.5",