@netu-si/netu-react-dsf-components 0.0.1 → 0.0.4

package/dist/index.d.ts

@@ -1,10 +1,22 @@
-import React, { FC, RefObject } from 'react';
+import React, { FC, RefObject, ChangeEvent, ForwardRefExoticComponent, RefAttributes } from 'react';
 import { LinkProps } from 'react-router-dom';
 import { UseFormRegisterReturn } from 'react-hook-form';
 
+/**
+ * ### References:
+ *
+ * - https://github.com/netu-si/netu-react-dsf-components/tree/main/src/components/DSFBackLink
+ */
+
 interface DSFBackLinkProps extends LinkProps {
     onBackClick?: () => void;
 }
+/**
+ * Use the back link component to help users go back to the previous page in a multi-page transaction.
+ *
+ * - https://animated-adventure-ey7gv1m.pages.github.io/?path=/docs/navigation-dsfbacklink--docs
+ * - https://gov-cy.github.io/govcy-design-system-docs/components/back_link
+ */
 declare const DSFBackLink: FC<DSFBackLinkProps>;
 
 interface DSFButtonProps extends React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement> {
@@ -126,7 +138,7 @@ interface DSFDateInputProps {
         };
     };
 }
-declare const DSFDateInput: React.FC<DSFDateInputProps>;
+declare const DSFDateInput: FC<DSFDateInputProps>;
 
 interface DSFErrorSummaryProps {
     /** onClick function to scroll the target element into view */
@@ -168,6 +180,7 @@ interface DSFSelectProps {
         touched?: boolean;
     };
     children: React.ReactNode;
+    defaultValue?: string | number;
 }
 declare const DSFSelect: FC<DSFSelectProps>;
 
@@ -207,9 +220,11 @@ interface DSFHeaderProps {
     headerTitle: string;
     showLang?: boolean;
     menu?: NavMenuItem[];
+    languageHandler?: (event: ChangeEvent<HTMLSelectElement>) => void;
+    defaultValue?: string | null;
 }
 declare const DSFHeader: {
-    ({ headerTitle, menu, showLang }: DSFHeaderProps): React.JSX.Element;
+    ({ headerTitle, menu, showLang, languageHandler, defaultValue }: DSFHeaderProps): React.JSX.Element;
     defaultProps: {
         showLang: boolean;
         menu: undefined;
@@ -222,23 +237,31 @@ interface DSFFooterProps {
     privacyStatementUrl?: string;
     cookiePolicyUrl?: string;
     accessibilityStatementUrl?: string;
+    privacyStatementText?: string;
+    cookiePolicyText?: string;
+    accessibilityStatementText?: string;
+    cyprusRepublicText?: string;
+    hasScroll?: boolean;
 }
 declare const DSFFooter: {
-    ({ privacyStatementUrl, cookiePolicyUrl, accessibilityStatementUrl }: DSFFooterProps): React.JSX.Element;
+    ({ privacyStatementUrl, cookiePolicyUrl, accessibilityStatementUrl, privacyStatementText, cookiePolicyText, accessibilityStatementText, cyprusRepublicText, hasScroll, }: DSFFooterProps): React.JSX.Element;
     defaultProps: {
         privacyStatementUrl: undefined;
         cookiePolicyUrl: undefined;
         accessibilityStatementUrl: undefined;
+        hasScroll: boolean;
     };
     displayName: string;
 };
 
 interface DSFMainProps {
+    id?: string;
     children: React.ReactNode;
 }
 declare const DSFMain: {
-    ({ children }: DSFMainProps): React.JSX.Element;
+    ({ id, children }: DSFMainProps): React.JSX.Element;
     defaultProps: {
+        id: string;
         children: undefined;
     };
     displayName: string;
@@ -292,16 +315,15 @@ declare const DSFSkipLink: {
 
 interface DSFLoadingBoxProps {
     loading: boolean;
-    spinnerColor?: string;
     children?: React.ReactNode;
 }
-declare const DSFLoadingBox: React.FC<DSFLoadingBoxProps>;
+declare const DSFLoadingBox: FC<DSFLoadingBoxProps>;
 
 interface DSFFieldSetProps {
     legend: React.ReactNode;
     children?: React.ReactNode;
 }
-declare const DSFFieldSet: React.FC<DSFFieldSetProps>;
+declare const DSFFieldSet: FC<DSFFieldSetProps>;
 
 interface DSFFormGroupProps {
     label?: string;
@@ -310,7 +332,7 @@ interface DSFFormGroupProps {
     hint?: string;
     children?: React.ReactNode;
 }
-declare const DSFFormGroup: React.FC<DSFFormGroupProps>;
+declare const DSFFormGroup: FC<DSFFormGroupProps>;
 
 interface DSFRadioProps extends React.InputHTMLAttributes<HTMLInputElement> {
     hint?: React.ReactNode;
@@ -324,15 +346,16 @@ interface DSFRadioProps extends React.InputHTMLAttributes<HTMLInputElement> {
 }
 declare const DSFRadio: React.ForwardRefExoticComponent<DSFRadioProps & React.RefAttributes<HTMLInputElement>>;
 
-interface TableColumn {
-    header: string;
-    type?: 'text' | 'number';
-}
 interface DSFTableProps {
     columns: TableColumn[];
-    rowData: (string | number)[][];
+    rowData: (string | number | React.ReactNode)[][];
+    hideNumberingColumn?: boolean;
+}
+declare const DSFTable: FC<DSFTableProps>;
+interface TableColumn {
+    header: string;
+    align?: 'left' | 'right';
 }
-declare const DSFTable: React.FC<DSFTableProps>;
 
 interface DSFUserSignOutProps {
     fullName: string;
@@ -341,4 +364,64 @@ interface DSFUserSignOutProps {
 }
 declare const DSFUserSignOut: FC<DSFUserSignOutProps>;
 
-export { DSFBackLink, DSFBeforeMainContainer, DSFBodyEndContainer, DSFBodyStartContainer, DSFButton, DSFCheckbox, DSFDateInput, DSFDateInputProps, DSFErrorSummary, DSFErrorText, DSFFieldSet, DSFFooter, DSFFormGroup, DSFHeader, DSFHintText, DSFInput, DSFInputField, DSFLabel, DSFLoadingBox, DSFMain, DSFPanel, DSFRadio, DSFSelect, DSFSkipLink, DSFTable, DSFUserSignOut };
+/**
+ * ### References:
+ *
+ * - https://github.com/alphagov/govuk-frontend/tree/main/src/govuk/components/back-link
+ */
+
+interface DSFPageProps {
+    /**
+     * Page contents
+     */
+    children?: React.ReactNode;
+    /**
+     * ID for page content
+     */
+    id?: string;
+    /**
+     * Override the default page header component.
+     */
+    header?: React.ReactNode;
+    /**
+     * Override the default page footer component.
+     */
+    footer?: React.ReactNode;
+    /**
+     * Content that needs to appear after body starts and before other components
+     */
+    bodyStartContainer?: React.ReactNode;
+    /**
+     * Content that needs to appear immediately before body ends
+     */
+    bodyEndContainer?: React.ReactNode;
+    /**
+     * Content that needs to appear outside the main page wrapper (see `main`).
+     * For example: A back link component, breadcrumbs, user login component
+     */
+    beforeMainContainer?: React.ReactNode;
+}
+/**
+ * Use the back link component to help users go back to the previous page in a multi-page transaction.
+ *
+ * - https://govuk-react.github.io/govuk-react/?path=/docs/back-link
+ * - https://design-system.service.gov.uk/components/back-link/
+ */
+declare const DSFPage: FC<DSFPageProps>;
+
+interface DSFFileUploadProps extends React.InputHTMLAttributes<HTMLInputElement> {
+    id: string;
+    meta: {
+        error?: string | string[];
+        touched?: boolean;
+    };
+    label: string;
+    hint?: string;
+    multiple?: boolean;
+    acceptedFormats?: string;
+    name?: string;
+    onChange?: React.ChangeEventHandler<HTMLInputElement>;
+}
+declare const DSFFileUpload: ForwardRefExoticComponent<DSFFileUploadProps & RefAttributes<HTMLInputElement>>;
+
+export { DSFBackLink, DSFBeforeMainContainer, DSFBodyEndContainer, DSFBodyStartContainer, DSFButton, DSFCheckbox, DSFDateInput, DSFDateInputProps, DSFErrorSummary, DSFErrorText, DSFFieldSet, DSFFileUpload, DSFFooter, DSFFormGroup, DSFHeader, DSFHintText, DSFInput, DSFInputField, DSFLabel, DSFLoadingBox, DSFMain, DSFPage, DSFPanel, DSFRadio, DSFSelect, DSFSkipLink, DSFTable, DSFUserSignOut };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netu-si/netu-react-dsf-components",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "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",
@@ -21,15 +21,12 @@
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
     "predeploy": "npm run build-storybook",
-    "deploy-storybook": "set CACHE_DIR=/tmp && gh-pages -d storybook-static",
-    "version-and-publish": "run() { yarn clean $1 && yarn build $1 && version=$(cd src/$1 && npm version --no-git-tag-version $2) && (cd src/$1 && npm publish --registry=https://npm.pkg.github.com/) && git add src/$1 && git commit -m \"$1 - $version\" && git push; }; run",
-    "patch": "run() { yarn version-and-publish $1 patch; }; run",
-    "minor": "run() { yarn version-and-publish $1 minor; }; run",
-    "major": "run() { yarn version-and-publish $1 major; }; run"
+    "deploy-storybook": "set CACHE_DIR=/tmp&& gh-pages -d storybook-static",
+    "docs:components": "./scripts/generate-component-readme.sh ",
+    "docs": "yarn docs:components && node scripts/concat-readme.js"
   },
   "dependencies": {
-    "help": "^3.0.2",
-    "multi-input-input": "^0.0.3"
+    "help": "^3.0.2"
   },
   "peerDependencies": {
     "react": "^18.2.0",
@@ -40,6 +37,7 @@
     "@babel/preset-env": "^7.22.9",
     "@babel/preset-react": "^7.22.5",
     "@babel/preset-typescript": "^7.22.5",
+    "@netu-si/api-docs": "file:local-packages/api-docs",
     "@rollup/plugin-commonjs": "^25.0.2",
     "@rollup/plugin-node-resolve": "^15.1.0",
     "@rollup/plugin-typescript": "^11.1.2",
@@ -54,6 +52,7 @@
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
     "can-npm-publish": "^1.3.6",
+    "concat": "^1.0.3",
     "eslint": "^8.45.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.1.0",