@scottish-government/designsystem-react 0.5.1 → 0.7.0

package/src/components/FileDownload/FileDownload.test.tsx

@@ -0,0 +1,167 @@
+import { test, expect } from 'vitest';
+import { screen, render } from '@testing-library/react';
+import FileDownload from './FileDownload';
+
+const FILE_TITLE = 'Scotland\'s Artificial Intelligence Strategy - Trustworthy, Ethical and Inclusive';
+const FILE_URL = 'my-file.file';
+
+test('inset text renders correctly', () => {
+    render(
+        <FileDownload fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" />
+    );
+
+    const fileDownload = screen.getByTestId('file-download');
+
+    const thumbnailImage = screen.getByRole('img', {hidden: true});
+    const thumbnailLink = thumbnailImage.parentElement;
+    const thumbnailContainer = thumbnailLink?.parentElement;
+
+    const fileLink = screen.getByRole('link');
+    const contentContainer = fileLink.parentElement;
+
+    expect(thumbnailImage).toHaveClass('ds_file-download__thumbnail-image');
+    expect(thumbnailImage).toHaveAttribute('aria-label', '');
+    expect(thumbnailImage.tagName).toEqual('svg');
+
+    expect(thumbnailLink).toHaveClass('ds_file-download__thumbnail-link');
+    expect(thumbnailLink).toHaveAttribute('aria-hidden', 'true');
+    expect(thumbnailLink).toHaveAttribute('tabindex', '-1');
+    expect(thumbnailLink).toHaveAttribute('href', FILE_URL);
+    expect(thumbnailLink?.tagName).toEqual('A');
+
+    expect(thumbnailContainer).toHaveClass('ds_file-download__thumbnail');
+    expect(thumbnailContainer?.tagName).toEqual('DIV');
+    expect(thumbnailContainer?.parentElement).toEqual(fileDownload);
+
+    expect(contentContainer).toHaveClass('ds_file-download__content');
+    expect(contentContainer?.tagName).toEqual('DIV');
+    expect(contentContainer?.parentElement).toEqual(fileDownload);
+
+    expect(fileLink).toHaveClass('ds_file-download__title');
+    expect(fileLink).toHaveAttribute('href', FILE_URL);
+    expect(fileLink?.tagName).toEqual('A');
+    expect(fileLink?.textContent).toEqual(FILE_TITLE);
+});
+
+test('highlighted file download', () => {
+    render(
+        <FileDownload highlighted fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" />
+    );
+
+    const fileDownload = screen.getByTestId('file-download');
+
+    expect(fileDownload).toHaveClass('ds_file-download--highlighted');
+});
+
+// test('file download with specific icon', () => {
+
+// });
+
+test('file download with cover image', () => {
+    const COVER_URL = 'my-image.png';
+
+    render(
+        <FileDownload cover={COVER_URL} fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" />
+    );
+
+    const thumbnailImage = screen.getByRole('presentation', {hidden: true});
+
+    expect(thumbnailImage).toHaveClass('ds_file-download__thumbnail-image');
+    expect(thumbnailImage).toHaveAttribute('alt', '');
+    expect(thumbnailImage).toHaveAttribute('src', COVER_URL);
+    expect(thumbnailImage.tagName).toEqual('IMG');
+});
+
+test('file download with file size', () => {
+    const FILE_SIZE = '1.2 MB';
+
+    render(
+        <FileDownload fileSize={FILE_SIZE} fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" />
+    );
+
+    const metadataKey = screen.getByRole('term');
+    const metadataValue = screen.getByRole('definition');
+    const metadataItem = metadataKey.parentElement;
+    const metadataList = metadataItem?.parentElement;
+    const downloadDetails = metadataList?.parentElement;
+
+    expect(downloadDetails).toHaveClass('ds_file-download__details');
+    expect(downloadDetails?.tagName).toEqual('DIV');
+
+    expect(metadataList).toHaveClass('ds_metadata', 'ds_metadata--inline');
+    expect(metadataList?.tagName).toEqual('DL');
+
+    expect(metadataItem).toHaveClass('ds_metadata__item');
+    expect(metadataItem?.tagName).toEqual('DIV');
+
+    expect(metadataKey).toHaveClass('ds_metadata__key', 'visually-hidden');
+    expect(metadataKey.textContent).toEqual('File size');
+
+    expect(metadataValue).toHaveClass('ds_metadata__value');
+    expect(metadataValue.textContent).toEqual(FILE_SIZE);
+    expect(metadataValue.previousElementSibling).toEqual(metadataKey);
+});
+
+test('file download with file type', () => {
+    const FILE_TYPE = '5 page PDF';
+
+    render(
+        <FileDownload fileType={FILE_TYPE} fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" />
+    );
+
+    const metadataKey = screen.getByRole('term');
+    const metadataValue = screen.getByRole('definition');
+    const metadataItem = metadataKey.parentElement;
+    const metadataList = metadataItem?.parentElement;
+    const downloadDetails = metadataList?.parentElement;
+
+    expect(downloadDetails).toHaveClass('ds_file-download__details');
+    expect(downloadDetails?.tagName).toEqual('DIV');
+
+    expect(metadataList).toHaveClass('ds_metadata', 'ds_metadata--inline');
+    expect(metadataList?.tagName).toEqual('DL');
+
+    expect(metadataItem).toHaveClass('ds_metadata__item');
+    expect(metadataItem?.tagName).toEqual('DIV');
+
+    expect(metadataKey).toHaveClass('ds_metadata__key', 'visually-hidden');
+    expect(metadataKey.textContent).toEqual('File type');
+
+    expect(metadataValue).toHaveClass('ds_metadata__value');
+    expect(metadataValue.textContent).toEqual(FILE_TYPE + ',');
+    expect(metadataValue.previousElementSibling).toEqual(metadataKey);
+});
+
+test('association of metadata with file link', () => {
+    const FILE_SIZE = '1.2 MB';
+
+    render(
+        <FileDownload fileSize={FILE_SIZE} fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" />
+    );
+
+    const fileLink = screen.getByRole('link');
+    const metadataKey = screen.getByRole('term');
+    const metadataItem = metadataKey.parentElement;
+    const metadataList = metadataItem?.parentElement;
+    const downloadDetails = metadataList?.parentElement;
+
+    expect(fileLink).toHaveAttribute('aria-describedby', downloadDetails?.id);
+});
+
+test('passing additional props', () => {
+    render(
+        <FileDownload fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" data-test="foo" />
+    );
+
+    const fileDownload = screen.getByTestId('file-download');
+    expect(fileDownload?.dataset.test).toEqual('foo');
+});
+
+test('passing additional CSS classes', () => {
+    render(
+        <FileDownload fileUrl={FILE_URL} title={FILE_TITLE} data-testid="file-download" className="foo" />
+    );
+
+    const fileDownload = screen.getByTestId('file-download');
+    expect(fileDownload).toHaveClass('foo');
+});

package/src/components/FileDownload/FileDownload.tsx

@@ -0,0 +1,67 @@
+import { useId } from 'react';
+import FileIcon from '../../common/FileIcon';
+
+const FileDownload: React.FC<SGDS.Component.FileDownload> = ({
+    className,
+    cover,
+    highlighted,
+    icon = 'Generic',
+    fileSize,
+    fileType,
+    fileUrl,
+    title,
+    ...props
+}) => {
+    const hasMetadata = !!fileType || !!fileSize;
+    const metaContainerId = `file-download-${useId()}`;
+
+    return (
+        <div className={[
+            'ds_file-download',
+            highlighted && 'ds_file-download--highlighted',
+            className
+        ].join(' ')}
+            {...props}
+        >
+            <div className="ds_file-download__thumbnail">
+                <a className="ds_file-download__thumbnail-link" aria-hidden="true" tabIndex={-1} href={fileUrl}>
+                    {cover ?
+                        <img alt="" className="ds_file-download__thumbnail-image" src={cover}/>
+                    :
+                        <FileIcon ariaLabel="" className="ds_file-download__thumbnail-image" icon={icon} />
+                    }
+                </a>
+            </div>
+
+            <div className="ds_file-download__content">
+                <a href={fileUrl} className="ds_file-download__title" aria-describedby={hasMetadata ? metaContainerId : undefined}>
+                    {title}
+                </a>
+
+                {hasMetadata &&
+                    <div id={metaContainerId} className="ds_file-download__details">
+                        <dl className="ds_metadata  ds_metadata--inline">
+                            {fileType &&
+                                <div className="ds_metadata__item">
+                                    <dt className="ds_metadata__key  visually-hidden">File type</dt>
+                                    <dd className="ds_metadata__value">{fileType}<span className="visually-hidden">,</span></dd>
+                                </div>
+                            }
+
+                            {fileSize &&
+                                <div className="ds_metadata__item">
+                                    <dt className="ds_metadata__key  visually-hidden">File size</dt>
+                                    <dd className="ds_metadata__value">{fileSize}</dd>
+                                </div>
+                            }
+                        </dl>
+                    </div>
+                }
+            </div>
+        </div>
+    );
+};
+
+FileDownload.displayName = 'FileDownload';
+
+export default FileDownload;

package/src/components/{hide-this-page/hide-this-page.test.tsx → HideThisPage/HideThisPage.test.tsx}

@@ -1,6 +1,6 @@
 import { test, expect } from 'vitest';
 import { render, screen, within } from '@testing-library/react';
-import HideThisPage from './hide-this-page';
+import HideThisPage from './HideThisPage';
 
 test('hide this page renders correctly', () => {
     render(
@@ -39,16 +39,16 @@ test('hide this page renders correctly', () => {
 });
 
 test('custom escape URL', () => {
-    const escapeUrl = 'https://www.mygov.scot';
+    const ESCAPE_URL = 'https://www.mygov.scot';
 
     render(
-        <HideThisPage data-testid="htp" escapeUrl={escapeUrl} />
+        <HideThisPage data-testid="htp" escapeUrl={ESCAPE_URL} />
     );
 
     const hideThisPageElement = screen.getByTestId('htp');
     const link = within(hideThisPageElement).getByRole('link');
 
-    expect(link).toHaveAttribute('href', escapeUrl);
+    expect(link).toHaveAttribute('href', ESCAPE_URL);
 })
 
 test('passing additional props', () => {

package/src/components/{hide-this-page/hide-this-page.tsx → HideThisPage/HideThisPage.tsx}

@@ -13,10 +13,10 @@ const HideThisPage: React.FC<SGDS.Component.HideThisPage> = ({
         if (ref.current) {
             new DSHideThisPage().init();
 
-            const htpDivId = 'hide-this-page-instruction';
-            if (!document.getElementById(htpDivId)) {
+            const HIDE_THIS_PAGE_DIV_ID = 'hide-this-page-instruction';
+            if (!document.getElementById(HIDE_THIS_PAGE_DIV_ID)) {
                 const htpDiv = document.createElement('div');
-                htpDiv.id = htpDivId;
+                htpDiv.id = HIDE_THIS_PAGE_DIV_ID;
                 htpDiv.classList.add('visually-hidden');
                 htpDiv.classList.add('ds_hide-page');
                 htpDiv.innerHTML = '<p>To leave the page quickly, press the escape key.</p>';

package/src/components/{inset-text/inset-text.test.tsx → InsetText/InsetText.test.tsx}

@@ -1,6 +1,6 @@
 import { test, expect } from 'vitest';
 import { render } from '@testing-library/react';
-import InsetText from './inset-text';
+import InsetText from './InsetText';
 
 const text = `You may be able to apply for free school meals at the same
     time as you apply for the clothing grant.`;

package/src/components/{notification-banner/notification-banner.test.tsx → NotificationBanner/NotificationBanner.test.tsx}

@@ -5,9 +5,9 @@
 
 import { test, expect } from 'vitest';
 import { render, screen, within } from '@testing-library/react';
-import NotificationBanner from './notification-banner';
+import NotificationBanner from './NotificationBanner';
 
-const text = 'We need to tell you about something';
+const BANNER_TEXT = 'We need to tell you about something';
 
 /**
  * NotificationBanner has the ds_reversed class
@@ -15,7 +15,7 @@ const text = 'We need to tell you about something';
 test('notification banner renders correctly', () => {
     render(
         <NotificationBanner>
-            {text}
+            {BANNER_TEXT}
         </NotificationBanner>
     );
 
@@ -30,7 +30,7 @@ test('notification banner renders correctly', () => {
 test('notification banner with icon', () => {
     render(
         <NotificationBanner icon>
-            {text}
+            {BANNER_TEXT}
         </NotificationBanner>
     );
 

package/src/components/{notification-banner/notification-banner.tsx → NotificationBanner/NotificationBanner.tsx}

@@ -1,5 +1,5 @@
 import { useEffect, useRef } from 'react';
-import AbstractNotificationBanner from '../../common/abstract-notification-banner';
+import AbstractNotificationBanner from '../../common/AbstractNotificationBanner';
 // @ts-ignore
 import DSNotificationBanner from '@scottish-government/design-system/src/components/notification-banner/notification-banner';
 

package/src/components/{notification-panel/notification-panel.test.tsx → NotificationPanel/NotificationPanel.test.tsx}

@@ -1,14 +1,14 @@
 import { test, expect } from 'vitest';
 import { render, screen } from '@testing-library/react';
-import NotificationPanel from './notification-panel';
+import NotificationPanel from './NotificationPanel';
 
-const headingText = 'Thank you';
-const text = 'Your Saltire Scholarship Application form has been successfully submitted.';
+const HEADING_TEXT = 'Thank you';
+const TEXT = 'Your Saltire Scholarship Application form has been successfully submitted.';
 
 test('notification banner renders correctly', () => {
     render(
-        <NotificationPanel title={headingText}>
-            {text}
+        <NotificationPanel title={HEADING_TEXT}>
+            {TEXT}
         </NotificationPanel>
     );
 
@@ -18,56 +18,57 @@ test('notification banner renders correctly', () => {
 
     expect(notificationPanel).toHaveClass('ds_notification-panel');
     expect(notificationPanelHeading).toHaveClass('ds_notification-panel__title');
-    expect(notificationPanelHeading.textContent).toEqual(headingText);
+    expect(notificationPanelHeading.textContent).toEqual(HEADING_TEXT);
     expect(notificationPanelHeading.tagName).toEqual('H1');
     expect(notificationPanelContent).toHaveClass('ds_notification-panel__content');
-    expect(notificationPanelContent?.textContent).toEqual(text);
+    expect(notificationPanelContent?.textContent).toEqual(TEXT);
 });
 
 test('notification banner with custom heading level', () => {
-    const headerLevel = 'h2';
+    const HEADING_LEVEL = 'h2';
 
     render(
-        <NotificationPanel headerLevel={headerLevel} title={headingText}>
-            {text}
+        <NotificationPanel headingLevel={HEADING_LEVEL} title={HEADING_TEXT}>
+            {TEXT}
         </NotificationPanel>
     );
 
     const notificationPanelHeading = screen.getByRole('heading');
-    expect(notificationPanelHeading.tagName).toEqual(headerLevel.toUpperCase());
+    expect(notificationPanelHeading.tagName).toEqual(HEADING_LEVEL.toUpperCase());
 });
 
 test('notification banner with aria-live', () => {
-    const ariaLive = 'polite';
+    const ARIA_LIVE = 'polite';
 
     render(
-        <NotificationPanel ariaLive={ariaLive} title={headingText}>
-            {text}
+        <NotificationPanel ariaLive={ARIA_LIVE} title={HEADING_TEXT}>
+            {TEXT}
         </NotificationPanel>
     );
 
     const notificationPanelHeading = screen.getByRole('heading');
     const notificationPanel = notificationPanelHeading.parentElement;
 
-    expect(notificationPanel).toHaveAttribute('aria-live', ariaLive);
+    expect(notificationPanel).toHaveAttribute('aria-live', ARIA_LIVE);
 });
 
 test('notification banner with nonsense heading level reverts to H1', () => {
-    const headerLevel = 'h2';
+    const HEADING_LEVEL = 'h2';
+
     render(
-        <NotificationPanel headerLevel={headerLevel} title={headingText}>
-            {text}
+        <NotificationPanel headingLevel={HEADING_LEVEL} title={HEADING_TEXT}>
+            {TEXT}
         </NotificationPanel>
     );
 
     const notificationPanelHeading = screen.getByRole('heading');
-    expect(notificationPanelHeading.tagName).toEqual(headerLevel.toUpperCase());
+    expect(notificationPanelHeading.tagName).toEqual(HEADING_LEVEL.toUpperCase());
 });
 
 test('passing additional props', () => {
     render(
-        <NotificationPanel title={headingText} data-test="foo">
-            {text}
+        <NotificationPanel title={HEADING_TEXT} data-test="foo">
+            {TEXT}
         </NotificationPanel>
     )
 
@@ -78,8 +79,8 @@ test('passing additional props', () => {
 
 test('passing additional CSS classes', () => {
     render(
-        <NotificationPanel title={headingText} className="foo">
-            {text}
+        <NotificationPanel title={HEADING_TEXT} className="foo">
+            {TEXT}
         </NotificationPanel>
     )
 

package/src/components/{notification-panel/notification-panel.tsx → NotificationPanel/NotificationPanel.tsx}

@@ -1,10 +1,10 @@
-import WrapperTag from '../../common/wrapper-tag';
+import WrapperTag from '../../common/WrapperTag';
 
 const NotificationPanel: React.FC<SGDS.Component.NotificationPanel> = function ({
     ariaLive,
     children,
     className,
-    headerLevel = 'h1',
+    headingLevel = 'h1',
     title,
     ...props
 }) {
@@ -19,7 +19,7 @@ const NotificationPanel: React.FC<SGDS.Component.NotificationPanel> = function (
         >
             <WrapperTag
                 className="ds_notification-panel__title"
-                tagName={headerLevel}
+                tagName={headingLevel}
             >
                 {title}
             </WrapperTag>

package/src/components/{page-header/page-header.test.tsx → PageHeader/PageHeader.test.tsx}

@@ -1,13 +1,13 @@
 import { test, expect } from 'vitest';
 import { render, screen, within } from '@testing-library/react';
-import PageHeader from './page-header';
+import PageHeader from './PageHeader';
 
-const labelText = 'Guide';
-const titleText = 'Apply for or renew a disabled parking permit';
+const LABEL_TEXT = 'Guide';
+const TITLE_TEXT = 'Apply for or renew a disabled parking permit';
 
 test('notification banner renders correctly', () => {
     render(
-        <PageHeader label={labelText} title={titleText}/>
+        <PageHeader label={LABEL_TEXT} title={TITLE_TEXT}/>
     );
 
     const header = screen.getByRole('banner');
@@ -18,17 +18,17 @@ test('notification banner renders correctly', () => {
     expect(header.tagName).toEqual('HEADER');
 
     expect(label).toHaveClass('ds_page-header__label', 'ds_content-label');
-    expect(label?.textContent).toEqual(labelText);
+    expect(label?.textContent).toEqual(LABEL_TEXT);
     expect(label?.tagName).toEqual('SPAN');
 
     expect(title).toHaveClass('ds_page-header__title');
-    expect(title.textContent).toEqual(titleText);
+    expect(title.textContent).toEqual(TITLE_TEXT);
     expect(title.tagName).toEqual('H1');
 });
 
 test('header with no label', () => {
     render(
-        <PageHeader title={titleText}/>
+        <PageHeader title={TITLE_TEXT}/>
     );
 
     const header = screen.getByRole('banner');
@@ -40,7 +40,7 @@ test('header with no label', () => {
 
 test('passing additional props', () => {
     render(
-       <PageHeader data-test="foo" label={labelText} title={titleText}/>
+       <PageHeader data-test="foo" label={LABEL_TEXT} title={TITLE_TEXT}/>
     )
 
     const header = screen.getByRole('banner');
@@ -49,7 +49,7 @@ test('passing additional props', () => {
 
 test('passing additional CSS classes', () => {
     render(
-       <PageHeader className="foo" label={labelText} title={titleText}/>
+       <PageHeader className="foo" label={LABEL_TEXT} title={TITLE_TEXT}/>
     )
 
     const header = screen.getByRole('banner');

package/src/components/{page-metadata/page-metadata.test.tsx → PageMetadata/PageMetadata.test.tsx}

@@ -1,15 +1,15 @@
 import { test, expect } from 'vitest';
 import { render, screen } from '@testing-library/react';
-import Metadata from './page-metadata';
+import Metadata from './PageMetadata';
 
-const name = 'Directorate';
-const value = 'Equality, Inclusion and Human Rights Directorate';
+const NAME = 'Directorate';
+const VALUE = 'Equality, Inclusion and Human Rights Directorate';
 
 test('metadata renders correctly', () => {
     render(
         <Metadata>
-            <Metadata.Item name={name}>
-                {value}
+            <Metadata.Item name={NAME}>
+                {VALUE}
             </Metadata.Item>
         </Metadata>
     );
@@ -22,16 +22,16 @@ test('metadata renders correctly', () => {
     expect(metadata).toBeInTheDocument();
     expect(metadataItem).toBeInTheDocument();
     expect(metadataItemKey).toHaveClass('ds_metadata__key');
-    expect(metadataItemKey.textContent).toEqual(name);
+    expect(metadataItemKey.textContent).toEqual(NAME);
     expect(metadataItemValue).toHaveClass('ds_metadata__value');
-    expect(metadataItemValue.textContent).toEqual(value);
+    expect(metadataItemValue.textContent).toEqual(VALUE);
 });
 
 test('inline metadata', () => {
     render(
         <Metadata inline>
-            <Metadata.Item name={name}>
-                {value}
+            <Metadata.Item name={NAME}>
+                {VALUE}
             </Metadata.Item>
         </Metadata>
     );