@netu-si/netu-react-dsf-components 0.0.14 → 1.0.0

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import React, { RefObject, FC, ChangeEvent, MouseEventHandler, ForwardRefExoticComponent, RefAttributes } from 'react';
-import { LinkProps } from 'react-router-dom';
+import React, { RefObject, FC, MouseEventHandler, ReactNode, ForwardRefExoticComponent, RefAttributes } from 'react';
 import { UseFormRegisterReturn } from 'react-hook-form';
 
 /**
@@ -8,9 +7,11 @@ import { UseFormRegisterReturn } from 'react-hook-form';
  * - https://github.com/netu-si/netu-react-dsf-components/tree/main/src/components/DSFBackLink
  */
 
-interface DSFBackLinkProps extends LinkProps {
+interface DSFBackLinkProps {
+    linkComponent: any;
     onBackClick?: () => void;
     label?: string;
+    href?: string;
 }
 /**
  * Use the back link component to help users go back to the previous page in a multi-page transaction.
@@ -19,10 +20,7 @@ interface DSFBackLinkProps extends LinkProps {
  * - https://gov-cy.github.io/govcy-design-system-docs/components/back_link
  */
 declare const DSFBackLink: {
-    ({ label, onBackClick, ...props }: DSFBackLinkProps): React.JSX.Element;
-    defaultProps: {
-        to: string;
-    };
+    ({ label, href, onBackClick, linkComponent: Link }: DSFBackLinkProps): React.JSX.Element;
     displayName: string;
 };
 
@@ -38,7 +36,6 @@ interface DSFButtonProps extends React.DetailedHTMLProps<React.ButtonHTMLAttribu
 }
 declare const DSFButton: {
     ({ children, id, type, className, ...props }: DSFButtonProps): React.JSX.Element;
-    defaultProps: {};
     displayName: string;
 };
 
@@ -72,9 +69,33 @@ interface DSFInputProps extends React.InputHTMLAttributes<HTMLInputElement> {
 declare const DSFInput: React.ForwardRefExoticComponent<DSFInputProps & React.RefAttributes<HTMLInputElement>>;
 
 interface InputRefObject {
-    day: RefObject<HTMLInputElement>;
-    month: RefObject<HTMLInputElement>;
-    year: RefObject<HTMLInputElement>;
+    day: RefObject<HTMLInputElement | HTMLSelectElement>;
+    month: RefObject<HTMLInputElement | HTMLSelectElement>;
+    year: RefObject<HTMLInputElement | HTMLSelectElement>;
+}
+interface DSFDateInputInputProps {
+    /**
+     * Called when the day, month or year changes
+     */
+    onChange?: (e: React.ChangeEvent<HTMLInputElement | HTMLSelectElement>, key: string) => void;
+    /**
+     * Called when the day, month or year fields are blurred
+     * (does not get called when moving between inputs in the same datefield)
+     */
+    onBlur?: (e: React.FocusEvent<HTMLInputElement | HTMLSelectElement>, key: string) => void;
+    /**
+     * Called when the day, month or year fields are focussed
+     * (does not get called when moving between inputs in the same datefield)
+     */
+    onFocus?: (e: React.FocusEvent<HTMLInputElement | HTMLSelectElement>, key: string) => void;
+    /**
+     * When the form field is controlled, this sets the value of the day, month and year inputs
+     */
+    value?: {
+        day?: string;
+        month?: string;
+        year?: string;
+    };
 }
 interface DSFDateInputProps {
     register: UseFormRegisterReturn;
@@ -125,56 +146,11 @@ interface DSFDateInputProps {
     /**
      * General input props including event handlers and value for all inputs
      */
-    inputProps?: {
-        /**
-         * Called when the day, month or year changes
-         */
-        onChange?: (e: React.ChangeEvent<HTMLInputElement>, key: string) => void;
-        /**
-         * Called when the day, month or year fields are blurred
-         * (does not get called when moving between inputs in the same datefield)
-         */
-        onBlur?: (e: React.FocusEvent<HTMLInputElement>, key: string) => void;
-        /**
-         * Called when the day, month or year fields are focussed
-         * (does not get called when moving between inputs in the same datefield)
-         */
-        onFocus?: (e: React.FocusEvent<HTMLInputElement>, key: string) => void;
-        /**
-         * When the form field is controlled, this sets the value of the day, month and year inputs
-         */
-        value?: {
-            day?: string;
-            month?: string;
-            year?: string;
-        };
-    };
+    inputProps?: DSFDateInputInputProps;
 }
 declare const DSFDateInput: {
     ({ register, id, label, hint, errorText, labels, refs, inputProps, inputs, defaultValues, }: DSFDateInputProps): React.JSX.Element;
     displayName: string;
-    defaultProps: {
-        inputProps: {};
-        hint: undefined;
-        errorText: undefined;
-        labels: {
-            day: string;
-            month: string;
-            year: string;
-        };
-        defaultValues: {
-            day: undefined;
-            month: undefined;
-            year: undefined;
-        };
-        inputs: {
-            day: undefined;
-            month: undefined;
-            year: undefined;
-        };
-        refs: undefined;
-        register: undefined;
-    };
 };
 
 interface DSFErrorSummaryProps {
@@ -184,32 +160,39 @@ interface DSFErrorSummaryProps {
     heading?: string;
     /** Array of errors with text and target element name to scroll into view when clicked */
     errors?: {
+        href?: string;
         targetName?: string;
         text?: string;
     }[];
     isInfo?: boolean;
 }
-declare const DSFErrorSummary: {
-    ({ onHandleErrorClick, heading, errors, isInfo, }: DSFErrorSummaryProps): React.JSX.Element;
-    defaultProps: {
-        errors: never[];
-        heading: string;
-        onHandleErrorClick: undefined;
-        isInfo: undefined;
-    };
-};
+declare const DSFErrorSummary: ({ onHandleErrorClick, heading, errors, isInfo, }: DSFErrorSummaryProps) => React.JSX.Element;
 
-declare const DSFInputField: {
-    ({ meta, label, id, children, hint, inputProps, visualSize, errorId, register, underRadio, ...props }: any): React.JSX.Element;
-    defaultProps: {
-        hint: undefined;
-        errorId: undefined;
-        visualSize: undefined;
-        inputProps: undefined;
-        register: undefined;
-        meta: {};
+interface DSFTextAreaProps extends React.TextareaHTMLAttributes<HTMLTextAreaElement> {
+    id?: string;
+    error?: boolean;
+    errorId?: string;
+    register?: UseFormRegisterReturn;
+}
+declare const DSFTextArea: React.ForwardRefExoticComponent<DSFTextAreaProps & React.RefAttributes<HTMLTextAreaElement>>;
+
+interface DSFInputFieldProps {
+    label: string;
+    hint?: React.ReactNode;
+    underRadio?: boolean;
+    id: string;
+    inputProps?: DSFInputProps | DSFTextAreaProps;
+    meta: {
+        error?: string | string[];
+        touched?: boolean;
     };
-};
+    type?: 'text' | 'textarea';
+    rows?: number | undefined;
+    visualSize?: number;
+    errorId?: string;
+    register?: UseFormRegisterReturn;
+}
+declare const DSFInputField: React.FC<DSFInputFieldProps>;
 
 interface DSFSelectProps {
     label: string;
@@ -225,14 +208,7 @@ interface DSFSelectProps {
     defaultLabel?: string;
     visualSize?: number;
 }
-declare const DSFSelect: {
-    ({ children, inputProps, label, hint, id, meta, defaultValue, defaultLabel, visualSize, }: DSFSelectProps): React.JSX.Element;
-    defaultProps: {
-        inputProps: {};
-        meta: {};
-        hint: undefined;
-    };
-};
+declare const DSFSelect: ({ children, inputProps, label, hint, id, meta, defaultValue, defaultLabel, visualSize, }: DSFSelectProps) => React.JSX.Element;
 
 declare enum PanelEnum {
     SUCCESS = "success",
@@ -248,11 +224,7 @@ interface DSFPanelProps {
     children?: React.ReactNode;
 }
 declare const DSFPanel: {
-    ({ title, type, children, ...props }: DSFPanelProps): React.JSX.Element;
-    defaultProps: {
-        children: undefined;
-        type: PanelEnum;
-    };
+    ({ title, type, children }: DSFPanelProps): React.JSX.Element;
     displayName: string;
 };
 
@@ -276,32 +248,50 @@ interface DSFHintTextProps {
 }
 declare const DSFHintText: FC<DSFHintTextProps>;
 
+interface DSFUserSignOutProps {
+    label?: string;
+    fullName: string;
+    onClick?: () => void;
+    href: string;
+}
+declare const DSFUserSignOut: ({ label, fullName, onClick, href }: DSFUserSignOutProps) => React.JSX.Element;
+
 type NavMenuItem = {
     label: string;
     href: string;
     onClick?: () => void;
+    subItems?: NavMenuItem[];
 };
 interface DSFHeaderProps {
+    linkComponent: any;
     headerTitle: string;
     showLang?: boolean;
     menu?: NavMenuItem[];
     logoUrl?: string;
-    languageHandler?: (event: ChangeEvent<HTMLSelectElement>) => void;
+    languageHandler?: (locale: string) => void;
     onLogoClickHandler?: MouseEventHandler<HTMLAnchorElement>;
+    langOptions?: LanguageItem[];
     defaultValue?: string | null;
+    currentLang?: string;
     showLogo?: boolean;
+    showSignin?: boolean;
+    showSignout?: boolean;
+    signoutParams?: DSFUserSignOutProps;
+    user?: any;
+    showSearch?: boolean;
+    showMenu?: boolean;
 }
+type LanguageItem = {
+    label: string;
+    value: string;
+};
 declare const DSFHeader: {
-    ({ headerTitle, menu, logoUrl, onLogoClickHandler, showLang, languageHandler, defaultValue, showLogo, }: DSFHeaderProps): React.JSX.Element;
-    defaultProps: {
-        showLang: boolean;
-        menu: undefined;
-        headerTitle: string;
-    };
+    ({ linkComponent: NavLink, headerTitle, menu, logoUrl, onLogoClickHandler, showLang, languageHandler, langOptions, defaultValue, currentLang, showLogo, showSignin, showSignout, signoutParams, showSearch, showMenu, }: DSFHeaderProps): React.JSX.Element;
     displayName: string;
 };
 
 interface DSFFooterProps {
+    linkComponent: any;
     privacyStatementUrl?: string;
     cookiePolicyUrl?: string;
     accessibilityStatementUrl?: string;
@@ -311,16 +301,10 @@ interface DSFFooterProps {
     cyprusRepublicText?: string;
     hasScroll?: boolean;
     newTab?: boolean;
+    version?: string;
 }
 declare const DSFFooter: {
-    ({ privacyStatementUrl, cookiePolicyUrl, accessibilityStatementUrl, privacyStatementText, cookiePolicyText, accessibilityStatementText, cyprusRepublicText, hasScroll, newTab, }: DSFFooterProps): React.JSX.Element;
-    defaultProps: {
-        privacyStatementUrl: undefined;
-        cookiePolicyUrl: undefined;
-        accessibilityStatementUrl: undefined;
-        hasScroll: boolean;
-        newTab: boolean;
-    };
+    ({ linkComponent: Link, privacyStatementUrl, cookiePolicyUrl, accessibilityStatementUrl, privacyStatementText, cookiePolicyText, accessibilityStatementText, cyprusRepublicText, version, hasScroll, newTab, }: DSFFooterProps): React.JSX.Element;
     displayName: string;
 };
 
@@ -330,32 +314,19 @@ interface DSFMainProps {
 }
 declare const DSFMain: {
     ({ id, children }: DSFMainProps): React.JSX.Element;
-    defaultProps: {
-        id: string;
-        children: undefined;
-    };
     displayName: string;
 };
 
-interface DSFBeforeMainContainerProps {
-    children: React.ReactNode;
+interface Props {
+    children: ReactNode;
 }
-declare const DSFBeforeMainContainer: {
-    ({ children }: DSFBeforeMainContainerProps): React.JSX.Element;
-    defaultProps: {
-        children: undefined;
-    };
-    displayName: string;
-};
+declare const DSFBeforeMainContainer: React.FC<Props>;
 
 interface DSFBodyStartContainerProps {
     children: React.ReactNode;
 }
 declare const DSFBodyStartContainer: {
     ({ children }: DSFBodyStartContainerProps): React.JSX.Element;
-    defaultProps: {
-        children: undefined;
-    };
     displayName: string;
 };
 
@@ -364,9 +335,6 @@ interface DSFBodyEndContainerProps {
 }
 declare const DSFBodyEndContainer: {
     ({ children }: DSFBodyEndContainerProps): React.JSX.Element;
-    defaultProps: {
-        children: undefined;
-    };
     displayName: string;
 };
 
@@ -376,10 +344,6 @@ interface DSFSkipLinkProps {
 }
 declare const DSFSkipLink: {
     ({ href, children }: DSFSkipLinkProps): React.JSX.Element;
-    defaultProps: {
-        children: string;
-        href: string;
-    };
     displayName: string;
 };
 
@@ -391,9 +355,6 @@ interface DSFLoadingBoxProps {
 }
 declare const DSFLoadingBox: {
     ({ loading, withinBox, loadingText, children }: DSFLoadingBoxProps): React.JSX.Element;
-    defaultProps: {
-        children: undefined;
-    };
     displayName: string;
 };
 
@@ -417,8 +378,10 @@ interface DSFRadioProps extends React.InputHTMLAttributes<HTMLInputElement> {
     hint?: React.ReactNode;
     children: React.ReactNode;
     collapsed?: {
+        hasError: boolean;
         node?: React.ReactNode;
         className: string;
+        visible?: boolean;
     };
     className?: string;
     inline?: boolean;
@@ -434,11 +397,6 @@ interface DSFTableProps {
 }
 declare const DSFTable: {
     ({ columns, rowData, hideNumberingColumn, id, inputProps }: DSFTableProps): React.JSX.Element;
-    defaultProps: {
-        columns: never[];
-        rowData: never[];
-        hideNumberingColumn: boolean;
-    };
     displayName: string;
 };
 interface DSFTableColumn {
@@ -446,19 +404,6 @@ interface DSFTableColumn {
     align?: 'left' | 'right';
 }
 
-interface DSFUserSignOutProps {
-    label?: string;
-    fullName: string;
-    onClick?: () => void;
-    href: string;
-}
-declare const DSFUserSignOut: {
-    ({ label, fullName, onClick, href }: DSFUserSignOutProps): React.JSX.Element;
-    defaultProps: {
-        href: string;
-    };
-};
-
 /**
  * ### References:
  *
@@ -469,7 +414,7 @@ interface DSFPageProps {
     /**
      * Page contents
      */
-    children?: React.ReactNode;
+    children: React.ReactNode;
     /**
      * ID for page content
      */
@@ -503,6 +448,7 @@ interface DSFPageProps {
      * Override the default page cookies component.
      */
     cookies?: React.ReactNode;
+    lang?: string;
 }
 /**
  * Use the back link component to help users go back to the previous page in a multi-page transaction.
@@ -511,17 +457,7 @@ interface DSFPageProps {
  * - https://design-system.service.gov.uk/components/back-link/
  */
 declare const DSFPage: {
-    ({ id, children, header, footer, bodyStartContainer: bodyStartContainerContent, bodyEndContainer: bodyEndContainerContent, beforeMainContainer: beforeChildren, sideBar: sideBar, cookies: cookies, }: DSFPageProps): React.JSX.Element;
-    defaultProps: {
-        children: undefined;
-        id: string;
-        header: React.JSX.Element;
-        footer: undefined;
-        cookies: undefined;
-        beforeMainContainer: undefined;
-        bodyStartContainer: undefined;
-        bodyEndContainer: undefined;
-    };
+    ({ id, children, header, footer, bodyStartContainer: bodyStartContainerContent, bodyEndContainer: bodyEndContainerContent, beforeMainContainer: beforeChildren, sideBar: sideBar, cookies: cookies, lang, }: DSFPageProps): React.JSX.Element;
     displayName: string;
 };
 
@@ -540,7 +476,8 @@ interface DSFFileUploadProps extends React.InputHTMLAttributes<HTMLInputElement>
 }
 declare const DSFFileUpload: ForwardRefExoticComponent<DSFFileUploadProps & RefAttributes<HTMLInputElement>>;
 
-interface DSFCookiesProps {
+interface DSFCookiesProps$1 {
+    linkComponent: React.ComponentType<any>;
     cookiesDescription: string;
     cookiesMoreUrl: string;
     cookiesMoreText: string;
@@ -549,17 +486,36 @@ interface DSFCookiesProps {
     hasScroll?: boolean;
     newTab?: boolean;
 }
+declare const DSFCookies$1: {
+    ({ linkComponent: Link, cookiesDescription, cookiesMoreUrl, cookiesMoreText, cookiesAcceptText, cookiesAcceptHandler, hasScroll, newTab, }: DSFCookiesProps$1): React.JSX.Element;
+    displayName: string;
+};
+
+interface DSFCookiesProps {
+    cookiesDescription: React.ReactNode;
+    cookiesTitle: string;
+    cookiesAcceptText: string;
+    cookiesRejectText: string;
+    cookiesAcceptRejectHandler: (accepted: boolean) => void;
+}
 declare const DSFCookies: {
-    ({ cookiesDescription, cookiesMoreUrl, cookiesMoreText, cookiesAcceptText, cookiesAcceptHandler, hasScroll, newTab, }: DSFCookiesProps): React.JSX.Element;
-    defaultProps: {
-        cookiesDescription: undefined;
-        cookiesMoreUrl: undefined;
-        cookiesMoreText: undefined;
-        cookiesAcceptText: undefined;
-        hasScroll: boolean;
-        newTab: boolean;
-    };
+    ({ cookiesDescription, cookiesTitle, cookiesAcceptText, cookiesRejectText, cookiesAcceptRejectHandler, }: DSFCookiesProps): React.JSX.Element;
     displayName: string;
 };
 
-export { DSFBackLink, DSFBeforeMainContainer, DSFBodyEndContainer, DSFBodyStartContainer, DSFButton, DSFCheckbox, DSFCookies, DSFDateInput, DSFDateInputProps, DSFErrorSummary, DSFErrorText, DSFFieldSet, DSFFileUpload, DSFFooter, DSFFormGroup, DSFHeader, DSFHintText, DSFInput, DSFInputField, DSFLabel, DSFLoadingBox, DSFMain, DSFPage, DSFPanel, DSFRadio, DSFSelect, DSFSkipLink, DSFTable, DSFTableColumn, DSFUserSignOut };
+interface DSFSummaryListItem {
+    key: String;
+    value: React.ReactNode;
+    actions?: React.ReactNode;
+}
+interface DSFSummaryListProps {
+    data: DSFSummaryListItem[];
+}
+declare const DSFSummaryList: FC<DSFSummaryListProps>;
+
+interface DSFWarningTextProps {
+    text: React.ReactNode;
+}
+declare const DSFWarningText: FC<DSFWarningTextProps>;
+
+export { DSFBackLink, DSFBeforeMainContainer, DSFBodyEndContainer, DSFBodyStartContainer, DSFButton, DSFCheckbox, DSFCookies$1 as DSFCookies, DSFCookies as DSFCookiesV3, DSFDateInput, DSFDateInputProps, DSFErrorSummary, DSFErrorSummaryProps, DSFErrorText, DSFFieldSet, DSFFileUpload, DSFFooter, DSFFormGroup, DSFHeader, DSFHintText, DSFInput, DSFInputField, DSFInputProps, DSFLabel, DSFLoadingBox, DSFMain, DSFPage, DSFPanel, PanelEnum as DSFPanelEnum, DSFRadio, DSFSelect, DSFSkipLink, DSFSummaryList, DSFSummaryListItem, DSFSummaryListProps, DSFTable, DSFTableColumn, DSFTextArea, DSFTextAreaProps, DSFUserSignOut, DSFWarningText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netu-si/netu-react-dsf-components",
-  "version": "0.0.14",
+  "version": "1.0.0",
   "description": "React Component Library Using the GOV-CY DSF Design System",
   "repository": "https://github.com/netu-si/netu-react-dsf-components.git",
   "homepage": "https://github.com/netu-si/netu-react-dsf-components#readme",
@@ -26,12 +26,12 @@
     "docs": "yarn docs:components && node scripts/concat-readme.js"
   },
   "dependencies": {
-    "help": "^3.0.2"
+    "@types/jquery": "^3.5.30",
+    "help": "^3.0.2",
+    "jquery": "^3.7.1"
   },
   "peerDependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router-dom": "^6.14.2"
+    "react": "^18.2.0"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.22.9",
@@ -40,6 +40,7 @@
     "@netu-si/api-docs": "file:local-packages/api-docs",
     "@rollup/plugin-commonjs": "^25.0.2",
     "@rollup/plugin-node-resolve": "^15.1.0",
+    "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.2",
     "@storybook/addon-essentials": "7.0.27",
     "@storybook/addon-interactions": "7.0.27",
@@ -48,8 +49,8 @@
     "@storybook/react": "7.0.27",
     "@storybook/react-webpack5": "7.0.27",
     "@storybook/testing-library": "0.2.0",
-    "@types/react": "^18.2.14",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@types/react": "18.2.20",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.0.0",
     "can-npm-publish": "^1.3.6",
     "concat": "^1.0.3",
@@ -57,7 +58,6 @@
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-config-react-app": "^7.0.1",
     "eslint-plugin-cypress": "^2.13.3",
     "eslint-plugin-flowtype": "^8.0.3",
     "eslint-plugin-import": "^2.27.5",
@@ -69,20 +69,19 @@
     "eslint-plugin-storybook": "^0.6.12",
     "gh-pages": "^5.0.0",
     "hex-rgb": "^5.0.0",
-    "postcss-import": "^15.1.0",
+    "next": "13.0.4",
+    "postcss-import": "^16.1.0",
     "prop-types": "15.8.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-hook-form": "^7.45.2",
-    "react-router-dom": "^6.14.2",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-hook-form": "^7.52.1",
     "react-transition-group": "^4.4.5",
     "remark-gfm": "^3.0.1",
     "rimraf": "^5.0.1",
-    "rollup": "^3.26.2",
+    "rollup": "^3.29.4",
     "rollup-plugin-dts": "^5.3.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-postcss": "^4.0.2",
-    "rollup-plugin-terser": "^7.0.2",
     "storybook": "7.0.27",
     "storybook-addon-react-router-v6": "^1.0.2",
     "styled-components": "^6.0.4",