@uob-web-and-digital/component-library 2.7.2 → 2.7.5

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

@@ -0,0 +1,23 @@
+import { ReactElement } from 'react';
+import { ThemeProps } from '../../../themeProps';
+import './textWithBackground.scss';
+export interface TextWithBackgroundProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    /**
+     * Whether to inverse the colours
+     */
+    inverse?: boolean;
+    headingLevel: 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+    headingText: string;
+    text: string;
+    url?: string;
+    linkTitle?: string;
+    externalLink?: boolean;
+    linkStyle?: 'primary' | 'secondary' | 'paragraph-link';
+    fullWidth?: boolean;
+    removeBottomPadding?: boolean;
+}
+export default function TextWithBackground({ text, theme, inverse, headingLevel, headingText, url, linkTitle, externalLink, linkStyle, fullWidth, removeBottomPadding }: TextWithBackgroundProps): ReactElement;

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

@@ -0,0 +1,22 @@
+import type { StoryObj } from '@storybook/react';
+import TextWithBackground from './TextWithBackground';
+declare const meta: {
+    title: string;
+    component: typeof TextWithBackground;
+    tags: string[];
+    parameters: {
+        backgrounds: {
+            default: string;
+        };
+    };
+};
+export default meta;
+type Story = StoryObj<typeof TextWithBackground>;
+export declare const DarkWithPrimaryButton: Story;
+export declare const DarkWithSecondaryButton: Story;
+export declare const DarkWithParagraphLink: Story;
+export declare const DarkNoLink: Story;
+export declare const LightWithPrimaryButton: Story;
+export declare const LightWithSecondaryButton: Story;
+export declare const LightWithParagraphLink: Story;
+export declare const LightNoLink: Story;

package/dist/components/organisms/TextWithBackground/defaultProps.d.ts

@@ -0,0 +1,4 @@
+import { TextWithBackgroundProps } from './TextWithBackground';
+export declare const accommodationGuarantee: TextWithBackgroundProps;
+export declare const contactUsProps: TextWithBackgroundProps;
+export declare const textWithBackgroundApplicationProcessProps: TextWithBackgroundProps;

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

@@ -0,0 +1,17 @@
+import { ReactElement } from 'react';
+import { ThemeProps } from '../../../themeProps';
+import './topicSelector.scss';
+import { PillProps } from '../../atoms/Pill/Pill';
+export interface TopicSelectorProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    /**
+     * The pills to display the list
+     */
+    topics: Omit<PillProps, 'theme'>[];
+    titleTag: 'h2' | 'h3';
+    heading: string;
+}
+export default function TopicSelector({ topics, theme, titleTag, heading }: TopicSelectorProps): ReactElement | null;

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

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

package/dist/components/organisms/TopicSelector/defaultProps.d.ts

@@ -0,0 +1,2 @@
+import { TopicSelectorProps } from './TopicSelector';
+export declare const topicSelectorProps: TopicSelectorProps;

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

@@ -0,0 +1,12 @@
+import { ReactElement, ReactNode } from 'react';
+import { ThemeProps } from '../../../themeProps';
+import './twoColumnWrapper.scss';
+export interface TwoColumnWrapperProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    firstColumn: ReactNode;
+    secondColumn?: ReactNode;
+}
+export default function TwoColumnWrapper({ theme, firstColumn, secondColumn }: TwoColumnWrapperProps): ReactElement;

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

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

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

@@ -0,0 +1,17 @@
+import { ReactElement } from 'react';
+import { ThemeProps } from '../../../themeProps';
+import { CardVideoProps } from '../../molecules/CardVideo/CardVideo';
+import './videoCardComponent.scss';
+export interface VideoCardComponentProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    title: string;
+    linkUrl?: string;
+    linkText?: string;
+    externalLink?: boolean;
+    tag?: string;
+    cards: [CardVideoProps, CardVideoProps, CardVideoProps];
+}
+export default function VideoCardComponent({ theme, tag, title, linkUrl, linkText, externalLink, cards }: VideoCardComponentProps): ReactElement | null;

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

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import VideoCardComponent from './VideoCardComponent';
+declare const meta: Meta<typeof VideoCardComponent>;
+export default meta;
+type Story = StoryObj<typeof VideoCardComponent>;
+export declare const Default: Story;

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

@@ -0,0 +1,2 @@
+import { VideoCardComponentProps } from './VideoCardComponent';
+export declare const videoCardComponentProps: VideoCardComponentProps;

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

@@ -0,0 +1,23 @@
+import { ReactElement } from 'react';
+import { ThemeProps } from '../../../themeProps';
+import { HeadingProps } from '../../molecules/Heading/Heading';
+import './videoEmbed.scss';
+export interface VideoEmbedProps {
+    theme: ThemeProps;
+    inverse?: boolean;
+    videoId?: string;
+    videoUrl?: string;
+    audioDescribedVideoId?: string;
+    audioDescribedVideoUrl?: string;
+    imageSrc: {
+        small?: string;
+        medium?: string;
+        default: string;
+    };
+    heading?: Omit<HeadingProps, 'theme' | 'inverse'>;
+    transcript?: string;
+    fullWidth?: boolean;
+    videoCaption?: string;
+    videoCredit?: string;
+}
+export default function VideoEmbed({ theme, inverse, imageSrc, videoUrl, videoId, heading, audioDescribedVideoId, audioDescribedVideoUrl, transcript, fullWidth, videoCaption, videoCredit }: VideoEmbedProps): ReactElement;

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

@@ -0,0 +1,17 @@
+import type { StoryObj } from '@storybook/react';
+import VideoEmbed from './VideoEmbed';
+declare const meta: {
+    title: string;
+    component: typeof VideoEmbed;
+    tags: string[];
+    parameters: {
+        backgrounds: {
+            default: string;
+        };
+    };
+};
+export default meta;
+type Story = StoryObj<typeof VideoEmbed>;
+export declare const Dark: Story;
+export declare const Light: Story;
+export declare const FullWidth: Story;

package/dist/components/organisms/VideoEmbed/defaultProps.d.ts

@@ -0,0 +1,2 @@
+import { VideoEmbedProps } from './VideoEmbed';
+export declare const videoEmbedProps: VideoEmbedProps;

package/dist/hooks/mediaHook.d.ts

@@ -0,0 +1 @@
+export declare function useBreakpoint(breakpointWidth?: string, boolean?: boolean): boolean;

package/dist/hooks/useFocusTrap.d.ts

@@ -0,0 +1,5 @@
+import { ReactNode, ReactElement } from 'react';
+export interface FocusTrapProps {
+    children: ReactNode;
+}
+export default function FocusTrap(props: FocusTrapProps): ReactElement;

package/dist/hooks/useOnClickOutside.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export default function useOnClickOutside(ref: React.RefObject<HTMLElement>, handler: () => void): void;

package/dist/hooks/useScrollDirection.d.ts

@@ -0,0 +1,3 @@
+type ScrollDirection = 'down' | 'up';
+export default function useScrollDirection(): ScrollDirection | null;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+import './base.scss';
+import Accordion, { AccordionProps } from './components/organisms/Accordion/Accordion';
+import AcreditationPromotion, { AccreditationPromotionProps } from './components/organisms/AccreditationPromotion/AccreditationPromotion';
+import AlertBanner, { AlertBannerProps } from './components/organisms/AlertBanner/AlertBanner';
+import AnchorTarget, { AnchorTargetProps } from './components/organisms/AnchorTarget/AnchorTarget';
+import Breadcrumbs, { BreadcrumbsProps } from './components/organisms/Breadcrumbs/Breadcrumbs';
+import Carousel, { CarouselProps } from './components/organisms/Carousel/Carousel';
+import CardProfile, { CardProfileProps } from './components/molecules/CardProfile/CardProfile';
+import CentreWrapper, { CenterWrapperProps } from './components/organisms/CentreWrapper/CentreWrapper';
+import ClearingBanner, { ClearingBannerProps } from './components/organisms/ClearingBanner/ClearingBanner';
+import CourseDeliveryPills, { CourseDeliveryPillsProps } from './components/organisms/CourseDeliveryPills/CourseDeliveryPills';
+import CTAComponent, { CTAComponentProps } from './components/organisms/CTAComponent/CTAComponent';
+import EmbedWrapper, { EmbedWrapperProps } from './components/organisms/EmbedWrapper/EmbedWrapper';
+import FactBoxes, { FactBoxesProps } from './components/organisms/FactBoxes/FactBoxes';
+import FeaturedContent, { FeaturedContentProps } from './components/organisms/FeaturedContent/FeaturedContent';
+import FeaturedSignpost, { FeaturedSignpostProps } from './components/organisms/FeaturedSignpost/FeaturedSignpost';
+import FeaturedVideo, { FeaturedVideoProps } from './components/organisms/FeaturedVideo/FeaturedVideo';
+import FiveArticlesGrid, { FiveArticlesGridProps } from './components/organisms/FiveArticlesGrid/FiveArticlesGrid';
+import Footer, { FooterProps } from './components/organisms/Footer/Footer';
+import GenericDetailSection, { GenericDetailSectionProps } from './components/organisms/GenericDetailSection/GenericDetailSection';
+import GeneralSearchFilter, { GeneralSearchFilterProps } from './components/organisms/GeneralSearchFilter/GeneralSearchFilter';
+import { Header, HeaderProps } from './components/organisms/Header/Header';
+import Heading, { HeadingProps } from './components/molecules/Heading/Heading';
+import Hero, { HeroProps } from './components/organisms/Hero/Hero';
+import HeroArticle, { HeroArticleProps } from './components/organisms/HeroArticle/HeroArticle';
+import HeroCourses, { HeroCoursesProps } from './components/organisms/HeroCourses/HeroCourses';
+import HeroCarousel, { HeroCarouselProps } from './components/organisms/HeroCarousel/HeroCarousel';
+import ImageBlock, { ImageBlockProps } from './components/organisms/ImageBlock/ImageBlock';
+import ImageCarousel, { ImageCarouselProps } from './components/organisms/ImageCarousel/ImageCarousel';
+import InPageNavigation, { InPageNavigationProps } from './components/organisms/InPageNavigation/InPageNavigation';
+import IntroText, { IntroTextProps } from './components/organisms/IntroText/IntroText';
+import LeadNewsArticles, { LeadNewsArticlesProps } from './components/organisms/LeadNewsArticles/LeadNewsArticles';
+import ListingFilterWrapper, { ListingFilterWrapperProps } from './components/organisms/ListingFilterWrapper/ListingFilterWrapper';
+import ListingResults, { ListingResultsProps } from './components/organisms/ListingResults/ListingResults';
+import ListingResultsCount, { ListingResultsCountProps } from './components/organisms/ListingResultsCount/ListingResultsCount';
+import ListTable, { ListTableProps } from './components/molecules/ListTable/ListTable';
+import MainWrapper, { MainWrapperProps } from './components/atoms/MainWrapper/MainWrapper';
+import NewsArticlesPromoBlock, { NewsArticlesPromoBlockProps } from './components/organisms/NewsArticlesPromoBlock/NewsArticlesPromoBlock';
+import Pagination, { PaginationProps } from './components/organisms/Pagination/Pagination';
+import PromoBlock, { PromoBlockProps } from './components/organisms/PromoBlock/PromoBlock';
+import PromoBlockGrid from './components/organisms/PromoBlockGrid/PromoBlockGrid';
+import QuoteBlock, { QuoteBlockProps } from './components/organisms/QuoteBlock/QuoteBlock';
+import RelatedCourses, { RelatedCoursesProps } from './components/organisms/RelatedCourses/RelatedCourses';
+import RichText, { RichTextProps } from './components/organisms/RichText/RichText';
+import ScholarshipCarousel, { ScholarshipCarouselProps } from './components/organisms/ScholarshipCarousel/ScholarshipCarousel';
+import SearchCourses, { SearchCoursesProps } from './components/organisms/SearchCourses/SearchCourses';
+import StaffListingCarousel, { StaffListingCarouselProps } from './components/organisms/StaffListingCarousel/StaffListingCarousel';
+import SidebarWrapper, { SidebarWrapperProps } from './components/organisms/SidebarWrapper/SidebarWrapper';
+import SignPost, { SignPostProps } from './components/organisms/SignPost/SignPost';
+import SingleButton, { SingleButtonProps } from './components/organisms/SingleButton/SingleButton';
+import SkipToContent, { SkipToContentProps } from './components/organisms/SkipToContent/SkipToContent';
+import TabsBlock, { TabsBlockProps } from './components/organisms/TabsBlock/TabsBlock';
+import TextWithBackground, { TextWithBackgroundProps } from './components/organisms/TextWithBackground/TextWithBackground';
+import TopicSelector, { TopicSelectorProps } from './components/organisms/TopicSelector/TopicSelector';
+import StandardListingFilter, { StandardListingFilterProps } from './components/organisms/StandardListingFilter/StandardListingFilter';
+import VideoCardComponent, { VideoCardComponentProps } from './components/organisms/VideoCardComponent/VideoCardComponent';
+import VideoEmbed, { VideoEmbedProps } from './components/organisms/VideoEmbed/VideoEmbed';
+import LocationSelector, { LocationSelectorProps } from './components/molecules/LocationSelector/LocationSelector';
+import ResearchStoryCarousel, { ResearchStoryCarouselProps } from './components/organisms/ResearchStoryCarousel/ResearchStoryCarousel';
+import ScrollableTable, { ScrollableTableProps, ScrollableTableCategory } from './components/organisms/ScrollableTable/ScrollableTable';
+import ModalCTA, { ModalCTAProps } from './components/organisms/ModalCTA/ModalCTA';
+import ModuleCardGroup, { ModuleCardGroupProps } from './components/organisms/ModuleCardGroup/ModuleCardGroup';
+import LocationSection, { LocationSectionProps } from './components/organisms/LocationSection/LocationSection';
+import HeroProfile, { HeroProfileProps } from './components/organisms/HeroProfile/HeroProfile';
+import TwoColumnWrapper, { TwoColumnWrapperProps } from './components/organisms/TwoColumnWrapper/TwoColumnWrapper';
+import { FormSelectProps, SelectOptionsProps } from './components/atoms/FormSelect/FormSelect';
+import CardPromoProfile, { CardPromoProfileProps } from './components/molecules/CardPromoProfile/CardPromoProfile';
+import CardStaff, { CardStaffProps } from './components/molecules/CardStaff/CardStaff';
+export type { AccordionProps, AccreditationPromotionProps, AlertBannerProps, AnchorTargetProps, BreadcrumbsProps, CarouselProps, CardProfileProps, CardStaffProps, CenterWrapperProps, ClearingBannerProps, CourseDeliveryPillsProps, CTAComponentProps, EmbedWrapperProps, FactBoxesProps, FeaturedContentProps, FeaturedSignpostProps, FeaturedVideoProps, FiveArticlesGridProps, FooterProps, FormSelectProps, GenericDetailSectionProps, GeneralSearchFilterProps, HeaderProps, HeadingProps, HeroProps, HeroArticleProps, HeroCarouselProps, HeroCoursesProps, HeroProfileProps, ImageBlockProps, ImageCarouselProps, InPageNavigationProps, IntroTextProps, LeadNewsArticlesProps, ListingFilterWrapperProps, ListingResultsProps, ListingResultsCountProps, ListTableProps, LocationSelectorProps, MainWrapperProps, ModuleCardGroupProps, NewsArticlesPromoBlockProps, PaginationProps, PromoBlockProps, QuoteBlockProps, RelatedCoursesProps, ResearchStoryCarouselProps, RichTextProps, ScholarshipCarouselProps, SearchCoursesProps, SelectOptionsProps, StaffListingCarouselProps, SidebarWrapperProps, SignPostProps, SingleButtonProps, SkipToContentProps, TabsBlockProps, TextWithBackgroundProps, TwoColumnWrapperProps, TopicSelectorProps, StandardListingFilterProps, VideoCardComponentProps, VideoEmbedProps, ScrollableTableProps, ScrollableTableCategory, ModalCTAProps, LocationSectionProps, CardPromoProfileProps };
+export { Accordion, AcreditationPromotion, AlertBanner, AnchorTarget, Breadcrumbs, Carousel, CardProfile, CardStaff, CentreWrapper, ClearingBanner, CourseDeliveryPills, CTAComponent, EmbedWrapper, FactBoxes, FeaturedContent, FeaturedSignpost, FeaturedVideo, FiveArticlesGrid, Footer, GeneralSearchFilter, GenericDetailSection, Header, Heading, Hero, HeroArticle, HeroCarousel, HeroCourses, HeroProfile, ImageBlock, ImageCarousel, InPageNavigation, IntroText, LeadNewsArticles, ListingFilterWrapper, ListingResults, ListingResultsCount, ListTable, LocationSelector, MainWrapper, ModuleCardGroup, NewsArticlesPromoBlock, Pagination, PromoBlock, PromoBlockGrid, QuoteBlock, RelatedCourses, ResearchStoryCarousel, RichText, ScholarshipCarousel, SearchCourses, SidebarWrapper, SignPost, SingleButton, SkipToContent, StaffListingCarousel, StandardListingFilter, TabsBlock, TextWithBackground, TopicSelector, TwoColumnWrapper, VideoCardComponent, VideoEmbed, ScrollableTable, ModalCTA, LocationSection, CardPromoProfile };