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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,8 @@
1
+ import { ReactElement } from 'react';
2
+ import { ThemeProps } from '../../../themeProps';
3
+ import './listTable.scss';
4
+ export interface ListTableProps {
5
+ theme?: ThemeProps;
6
+ listItems?: string[];
7
+ }
8
+ export default function ListTable({ theme, listItems }: ListTableProps): ReactElement;
@@ -0,0 +1,10 @@
1
+ import type { StoryObj } from '@storybook/react';
2
+ import ListTable from './ListTable';
3
+ declare const meta: {
4
+ title: string;
5
+ component: typeof ListTable;
6
+ tags: string[];
7
+ };
8
+ export default meta;
9
+ type Story = StoryObj<typeof meta>;
10
+ export declare const Default: Story;
@@ -1,13 +1,18 @@
1
1
  import { ReactElement } from 'react';
2
2
  import { ThemeProps } from '../../../themeProps';
3
3
  import { CardRelatedProps } from '../../molecules/CardRelatedCourse/CardRelatedCourse';
4
+ import { LinkWithArrowProps } from '../../atoms/LinkWithArrow/LinkWithArrow';
4
5
  import './relatedCourses.scss';
6
+ type LinkProps = Omit<LinkWithArrowProps, 'theme' | 'inverse'>;
5
7
  export interface RelatedCoursesProps {
6
8
  theme: ThemeProps;
7
9
  inverse?: boolean;
8
10
  heading: string;
11
+ description?: string;
12
+ linkProps?: LinkProps;
9
13
  fullWidth?: boolean;
10
14
  headingStyle?: 'news' | null;
11
15
  cards: CardRelatedProps[];
12
16
  }
13
- export default function RelatedCourses({ theme, inverse, heading, headingStyle, fullWidth, cards }: RelatedCoursesProps): ReactElement;
17
+ export default function RelatedCourses({ theme, inverse, heading, description, linkProps, headingStyle, fullWidth, cards }: RelatedCoursesProps): ReactElement;
18
+ export {};
@@ -8,6 +8,8 @@ declare const meta: {
8
8
  export default meta;
9
9
  type Story = StoryObj<typeof meta>;
10
10
  export declare const ExampleFourOrMoreCourses: Story;
11
+ export declare const ExampleWihDescription: Story;
12
+ export declare const ExampleWihLink: Story;
11
13
  export declare const ExampleWithNewsStyleHeading: Story;
12
14
  export declare const ExampleOneCourse: Story;
13
15
  export declare const ExampleTwoCourses: Story;
package/dist/index.d.ts CHANGED
@@ -54,7 +54,7 @@ interface HeadingProps$1 {
54
54
  children?: ReactNode;
55
55
  }
56
56
 
57
- type LinkProps$1 = Omit<LinkWithArrowProps, 'theme' | 'inverse'>;
57
+ type LinkProps$2 = Omit<LinkWithArrowProps, 'theme' | 'inverse'>;
58
58
  interface HeadingProps {
59
59
  /**
60
60
  * The theme to use
@@ -67,7 +67,7 @@ interface HeadingProps {
67
67
  htmlTag?: HeadingProps$1['htmlTag'];
68
68
  title?: string;
69
69
  description?: string | ReactElement;
70
- linkProps?: LinkProps$1;
70
+ linkProps?: LinkProps$2;
71
71
  fullWidth?: boolean;
72
72
  }
73
73
  declare function Heading({ title, description, linkProps, theme, inverse, fullWidth, htmlTag }: HeadingProps): ReactElement | null;
@@ -1195,6 +1195,12 @@ interface ListingResultsCountProps {
1195
1195
  }
1196
1196
  declare function ListingResultsCount({ count, theme }: ListingResultsCountProps): ReactElement;
1197
1197
 
1198
+ interface ListTableProps {
1199
+ theme?: ThemeProps;
1200
+ listItems?: string[];
1201
+ }
1202
+ declare function ListTable({ theme, listItems }: ListTableProps): ReactElement;
1203
+
1198
1204
  interface MainWrapperProps {
1199
1205
  }
1200
1206
  declare function MainWrapper({ children }: PropsWithChildren<MainWrapperProps>): ReactElement;
@@ -1317,7 +1323,7 @@ interface PromoBlockProps {
1317
1323
  }
1318
1324
  declare function PromoBlockGrid({ theme, inverse, type, title, description, link, cards, imageOrientation, fullWidth }: PromoBlockProps): ReactElement | null;
1319
1325
 
1320
- type LinkProps = Omit<LinkWithArrowProps, 'theme' | 'inverse'>;
1326
+ type LinkProps$1 = Omit<LinkWithArrowProps, 'theme' | 'inverse'>;
1321
1327
  interface QuoteBlockProps extends HeadingProps {
1322
1328
  theme: ThemeProps;
1323
1329
  inverse?: boolean;
@@ -1327,20 +1333,23 @@ interface QuoteBlockProps extends HeadingProps {
1327
1333
  quote: string;
1328
1334
  quoteeProfileImage?: string;
1329
1335
  quoteeProfileImageAltText?: string;
1330
- cta?: LinkProps;
1336
+ cta?: LinkProps$1;
1331
1337
  fullWidth?: boolean;
1332
1338
  }
1333
1339
  declare function QuoteBlock({ theme, inverse, title, description, cite, role, quote, quoteeProfileImage, quoteeProfileImageAltText, cta, fullWidth, htmlTag }: QuoteBlockProps): ReactElement;
1334
1340
 
1341
+ type LinkProps = Omit<LinkWithArrowProps, 'theme' | 'inverse'>;
1335
1342
  interface RelatedCoursesProps {
1336
1343
  theme: ThemeProps;
1337
1344
  inverse?: boolean;
1338
1345
  heading: string;
1346
+ description?: string;
1347
+ linkProps?: LinkProps;
1339
1348
  fullWidth?: boolean;
1340
1349
  headingStyle?: 'news' | null;
1341
1350
  cards: CardRelatedProps[];
1342
1351
  }
1343
- declare function RelatedCourses({ theme, inverse, heading, headingStyle, fullWidth, cards }: RelatedCoursesProps): ReactElement;
1352
+ declare function RelatedCourses({ theme, inverse, heading, description, linkProps, headingStyle, fullWidth, cards }: RelatedCoursesProps): ReactElement;
1344
1353
 
1345
1354
  interface ScholarshipCarouselProps {
1346
1355
  theme: ThemeProps;
@@ -1759,4 +1768,4 @@ interface TwoColumnWrapperProps {
1759
1768
  }
1760
1769
  declare function TwoColumnWrapper({ theme, firstColumn, secondColumn }: TwoColumnWrapperProps): ReactElement;
1761
1770
 
1762
- export { Accordion, type AccordionProps, type AccreditationPromotionProps, AcreditationPromotion, AlertBanner, type AlertBannerProps, AnchorTarget, type AnchorTargetProps, Breadcrumbs, type BreadcrumbsProps, CTAComponent, type CTAComponentProps, CardProfile, type CardProfileProps, CardPromoProfile, type CardPromoProfileProps, CardStaff, type CardStaffProps, Carousel, type CarouselProps, type CenterWrapperProps, CenterWrapper as CentreWrapper, ClearingBanner, type ClearingBannerProps, CourseDeliveryPills, type CourseDeliveryPillsProps, EmbedWrapper, type EmbedWrapperProps, FactBoxes, type FactBoxesProps, FeaturedContent, type FeaturedContentProps, FeaturedSignpost, type FeaturedSignpostProps, FeaturedVideo, type FeaturedVideoProps, FiveArticlesGrid, type FiveArticlesGridProps, Footer, type FooterProps, type FormSelectProps, GeneralSearchFilter, type GeneralSearchFilterProps, GenericDetailSection, type GenericDetailSectionProps, Header, type HeaderProps, Heading, type HeadingProps, Hero, HeroArticle, type HeroArticleProps, HeroCarousel, type HeroCarouselProps, HeroCourses, type HeroCoursesProps, HeroProfile, type HeroProfileProps, type HeroProps, ImageBlock, type ImageBlockProps, ImageCarousel, type ImageCarouselProps, InPageNavigation, type InPageNavigationProps, IntroText, type IntroTextProps, LeadNewsArticles, type LeadNewsArticlesProps, ListingFilterWrapper, type ListingFilterWrapperProps, ListingResults, ListingResultsCount, type ListingResultsCountProps, type ListingResultsProps, LocationSection, type LocationSectionProps, LocationSelector, type LocationSelectorProps, MainWrapper, type MainWrapperProps, ModalCTA, type ModalCTAProps, NewsArticlesPromoBlock, type NewsArticlesPromoBlockProps, Pagination, type PaginationProps, PromoBlock, PromoBlockGrid, type PromoBlockProps$1 as PromoBlockProps, QuoteBlock, type QuoteBlockProps, RelatedCourses, type RelatedCoursesProps, ResearchStoryCarousel, type ResearchStoryCarouselProps, RichText, type RichTextProps, ScholarshipCarousel, type ScholarshipCarouselProps, ScrollableTable, ScrollableTableCategory, type ScrollableTableProps, SearchCourses, type SearchCoursesProps, type SelectOptionsProps, SidebarWrapper, type SidebarWrapperProps, SignPost, type SignPostProps, SingleButton, type SingleButtonProps, SkipToContent, type SkipToContentProps, StaffListingCarousel, type StaffListingCarouselProps, StandardListingFilter, type StandardListingFilterProps, TabsBlock, type TabsBlockProps, TextWithBackground, type TextWithBackgroundProps, TopicSelector, type TopicSelectorProps, TwoColumnWrapper, type TwoColumnWrapperProps, VideoCardComponent, type VideoCardComponentProps, VideoEmbed, type VideoEmbedProps };
1771
+ export { Accordion, type AccordionProps, type AccreditationPromotionProps, AcreditationPromotion, AlertBanner, type AlertBannerProps, AnchorTarget, type AnchorTargetProps, Breadcrumbs, type BreadcrumbsProps, CTAComponent, type CTAComponentProps, CardProfile, type CardProfileProps, CardPromoProfile, type CardPromoProfileProps, CardStaff, type CardStaffProps, Carousel, type CarouselProps, type CenterWrapperProps, CenterWrapper as CentreWrapper, ClearingBanner, type ClearingBannerProps, CourseDeliveryPills, type CourseDeliveryPillsProps, EmbedWrapper, type EmbedWrapperProps, FactBoxes, type FactBoxesProps, FeaturedContent, type FeaturedContentProps, FeaturedSignpost, type FeaturedSignpostProps, FeaturedVideo, type FeaturedVideoProps, FiveArticlesGrid, type FiveArticlesGridProps, Footer, type FooterProps, type FormSelectProps, GeneralSearchFilter, type GeneralSearchFilterProps, GenericDetailSection, type GenericDetailSectionProps, Header, type HeaderProps, Heading, type HeadingProps, Hero, HeroArticle, type HeroArticleProps, HeroCarousel, type HeroCarouselProps, HeroCourses, type HeroCoursesProps, HeroProfile, type HeroProfileProps, type HeroProps, ImageBlock, type ImageBlockProps, ImageCarousel, type ImageCarouselProps, InPageNavigation, type InPageNavigationProps, IntroText, type IntroTextProps, LeadNewsArticles, type LeadNewsArticlesProps, ListTable, type ListTableProps, ListingFilterWrapper, type ListingFilterWrapperProps, ListingResults, ListingResultsCount, type ListingResultsCountProps, type ListingResultsProps, LocationSection, type LocationSectionProps, LocationSelector, type LocationSelectorProps, MainWrapper, type MainWrapperProps, ModalCTA, type ModalCTAProps, NewsArticlesPromoBlock, type NewsArticlesPromoBlockProps, Pagination, type PaginationProps, PromoBlock, PromoBlockGrid, type PromoBlockProps$1 as PromoBlockProps, QuoteBlock, type QuoteBlockProps, RelatedCourses, type RelatedCoursesProps, ResearchStoryCarousel, type ResearchStoryCarouselProps, RichText, type RichTextProps, ScholarshipCarousel, type ScholarshipCarouselProps, ScrollableTable, ScrollableTableCategory, type ScrollableTableProps, SearchCourses, type SearchCoursesProps, type SelectOptionsProps, SidebarWrapper, type SidebarWrapperProps, SignPost, type SignPostProps, SingleButton, type SingleButtonProps, SkipToContent, type SkipToContentProps, StaffListingCarousel, type StaffListingCarouselProps, StandardListingFilter, type StandardListingFilterProps, TabsBlock, type TabsBlockProps, TextWithBackground, type TextWithBackgroundProps, TopicSelector, type TopicSelectorProps, TwoColumnWrapper, type TwoColumnWrapperProps, VideoCardComponent, type VideoCardComponentProps, VideoEmbed, type VideoEmbedProps };