@uob-web-and-digital/component-library 1.1.0 → 2.0.0

package/README.md

@@ -16,7 +16,7 @@ This is the frontend component library for the University of Birmingham website
 ### Compatibility
 
 - **Node:** ^18.18.0
-- **React:** ^17.0.2
+- **React:** ^18.3.1
 
 ### Setting up the project locally
 

package/dist/components/atoms/DateInput/DateInput.stories.d.ts

@@ -1,19 +1,6 @@
-import React from 'react';
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import DateInput from './DateInput';
-declare const meta: {
-    title: string;
-    component: typeof DateInput;
-    tags: string[];
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        name: string;
-        id: string;
-        label: string;
-        defaultValue?: string | undefined;
-        onChange?: ((e: React.ChangeEvent<Element>) => void) | undefined;
-    }>) => JSX.Element)[];
-};
+declare const meta: Meta<typeof DateInput>;
 export default meta;
 type Story = StoryObj<typeof DateInput>;
 export declare const Default: Story;

package/dist/components/atoms/VideoPlaceholder/VideoPlaceholder.stories.d.ts

@@ -1,25 +1,6 @@
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import VideoPlaceholder from './VideoPlaceholder';
-declare const meta: {
-    title: string;
-    component: typeof VideoPlaceholder;
-    tags: string[];
-    parameters: {
-        backgrounds: {
-            default: string;
-        };
-    };
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        imageSrc: {
-            small?: string | undefined;
-            medium?: string | undefined;
-            default: string;
-        };
-        onClick: () => void;
-    }>) => JSX.Element)[];
-};
+declare const meta: Meta<typeof VideoPlaceholder>;
 export default meta;
 type Story = StoryObj<typeof VideoPlaceholder>;
 export declare const Default: Story;

package/dist/components/molecules/ListTable/ListTable.d.ts

@@ -0,0 +1,8 @@
+import { ReactElement } from 'react';
+import { ThemeProps } from '../../../themeProps';
+import './listTable.scss';
+export interface ListTableProps {
+    theme?: ThemeProps;
+    listItems?: string[];
+}
+export default function ListTable({ theme, listItems }: ListTableProps): ReactElement;

package/dist/components/molecules/ListTable/ListTable.stories.d.ts

@@ -0,0 +1,10 @@
+import type { StoryObj } from '@storybook/react';
+import ListTable from './ListTable';
+declare const meta: {
+    title: string;
+    component: typeof ListTable;
+    tags: string[];
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;

package/dist/components/molecules/VideoWithPlaceholder/VideoWithPlaceholder.stories.d.ts

@@ -1,26 +1,6 @@
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import VideoWithPlaceholder from './VideoWithPlaceholder';
-declare const meta: {
-    title: string;
-    component: typeof VideoWithPlaceholder;
-    tags: string[];
-    parameters: {
-        backgrounds: {
-            default: string;
-        };
-    };
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        videoId?: string | undefined;
-        videoUrl?: string | undefined;
-        imageSrc: {
-            small?: string | undefined;
-            medium?: string | undefined;
-            default: string;
-        };
-    }>) => JSX.Element)[];
-};
+declare const meta: Meta<typeof VideoWithPlaceholder>;
 export default meta;
 type Story = StoryObj<typeof VideoWithPlaceholder>;
 export declare const Default: Story;

package/dist/components/organisms/FeaturedVideo/FeaturedVideo.stories.d.ts

@@ -1,21 +1,6 @@
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import FeaturedVideo from './FeaturedVideo';
-declare const meta: {
-    title: string;
-    component: typeof FeaturedVideo;
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        inverse?: boolean | undefined;
-        image: import("../../atoms/Image/Image").ImageProps;
-        title: string;
-        youtubeId: string;
-        audioYoutubeId?: string | undefined;
-        youtubeButtonLabel?: string | undefined;
-        audioYoutubeButtonLabel?: string | undefined;
-    }>) => JSX.Element)[];
-    tags: string[];
-};
+declare const meta: Meta<typeof FeaturedVideo>;
 export default meta;
 type Story = StoryObj<typeof FeaturedVideo>;
 export declare const Dark: Story;

package/dist/components/organisms/GeneralSearchFilter/GeneralSearchFilter.stories.d.ts

@@ -1,20 +1,6 @@
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import GeneralSearchFilter from './GeneralSearchFilter';
-declare const meta: {
-    title: string;
-    component: typeof GeneralSearchFilter;
-    tags: string[];
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        heading: string;
-        typeName: string;
-        defaultCheckedType?: string | undefined;
-        typeGroups: import("./GeneralSearchFilter").TypeGroup[];
-        onViewResults?: (() => void) | undefined;
-        onClearFilters: () => void;
-    }>) => JSX.Element)[];
-};
+declare const meta: Meta<typeof GeneralSearchFilter>;
 export default meta;
 type Story = StoryObj<typeof GeneralSearchFilter>;
 export declare const Default: Story;

package/dist/components/organisms/ListingFilterWrapper/ListingFilterWrapper.stories.d.ts

@@ -1,17 +1,6 @@
-import React from 'react';
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import ListingFilterWrapper from './ListingFilterWrapper';
-declare const meta: {
-    title: string;
-    component: typeof ListingFilterWrapper;
-    tags: string[];
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        showFilterButtonLabel: string;
-        numSelected?: number | undefined;
-        filterElement: React.ReactElement<any, string | React.JSXElementConstructor<any>>;
-    }>) => JSX.Element)[];
-};
+declare const meta: Meta<typeof ListingFilterWrapper>;
 export default meta;
 type Story = StoryObj<typeof ListingFilterWrapper>;
 export declare const GeneralSearch: Story;

package/dist/components/organisms/RelatedCourses/RelatedCourses.d.ts

@@ -1,13 +1,18 @@
 import { ReactElement } from 'react';
 import { ThemeProps } from '../../../themeProps';
 import { CardRelatedProps } from '../../molecules/CardRelatedCourse/CardRelatedCourse';
+import { LinkWithArrowProps } from '../../atoms/LinkWithArrow/LinkWithArrow';
 import './relatedCourses.scss';
+type LinkProps = Omit<LinkWithArrowProps, 'theme' | 'inverse'>;
 export interface RelatedCoursesProps {
     theme: ThemeProps;
     inverse?: boolean;
     heading: string;
+    description?: string;
+    linkProps?: LinkProps;
     fullWidth?: boolean;
     headingStyle?: 'news' | null;
     cards: CardRelatedProps[];
 }
-export default function RelatedCourses({ theme, inverse, heading, headingStyle, fullWidth, cards }: RelatedCoursesProps): ReactElement;
+export default function RelatedCourses({ theme, inverse, heading, description, linkProps, headingStyle, fullWidth, cards }: RelatedCoursesProps): ReactElement;
+export {};

package/dist/components/organisms/RelatedCourses/RelatedCourses.stories.d.ts

@@ -8,6 +8,8 @@ declare const meta: {
 export default meta;
 type Story = StoryObj<typeof meta>;
 export declare const ExampleFourOrMoreCourses: Story;
+export declare const ExampleWihDescription: Story;
+export declare const ExampleWihLink: Story;
 export declare const ExampleWithNewsStyleHeading: Story;
 export declare const ExampleOneCourse: Story;
 export declare const ExampleTwoCourses: Story;

package/dist/components/organisms/StandardListingFilter/StandardListingFilter.stories.d.ts

@@ -1,18 +1,6 @@
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import StandardListingFilter from './StandardListingFilter';
-declare const meta: {
-    title: string;
-    component: typeof StandardListingFilter;
-    tags: string[];
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        heading: string;
-        listingGroups: (import("./StandardListingFilter").DateProps | import("./StandardListingFilter").RadioProps | import("./StandardListingFilter").CheckboxProps | import("./StandardListingFilter").SelectProps)[];
-        onClearFilters: () => void;
-        onViewResults?: (() => void) | undefined;
-    }>) => JSX.Element)[];
-};
+declare const meta: Meta<typeof StandardListingFilter>;
 export default meta;
 type Story = StoryObj<typeof StandardListingFilter>;
 export declare const CoursesFilter: Story;

package/dist/components/organisms/VideoCardComponent/VideoCardComponent.stories.d.ts

@@ -1,20 +1,6 @@
-/// <reference types="react" />
-import type { StoryObj } from '@storybook/react';
+import type { Meta, StoryObj } from '@storybook/react';
 import VideoCardComponent from './VideoCardComponent';
-declare const meta: {
-    title: string;
-    component: typeof VideoCardComponent;
-    decorators: ((Story: import("@storybook/types").PartialStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
-        theme: import("../../../themeProps").ThemeProps;
-        title: string;
-        linkUrl?: string | undefined;
-        linkText?: string | undefined;
-        externalLink?: boolean | undefined;
-        tag?: string | undefined;
-        cards: [import("../../molecules/CardVideo/CardVideo").CardVideoProps, import("../../molecules/CardVideo/CardVideo").CardVideoProps, import("../../molecules/CardVideo/CardVideo").CardVideoProps];
-    }>) => JSX.Element)[];
-    tags: string[];
-};
+declare const meta: Meta<typeof VideoCardComponent>;
 export default meta;
 type Story = StoryObj<typeof VideoCardComponent>;
 export declare const Default: Story;