@uob-web-and-digital/component-library 0.0.35 → 0.0.36

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

@@ -11,5 +11,9 @@ export interface RichTextProps {
      */
     inverse?: boolean;
     text: string;
+    /**
+     * The fullWidth version of this component is used for in study pages
+     */
+    fullWidth?: boolean;
 }
-export default function RichText({ text, theme, inverse }: RichTextProps): ReactElement;
+export default function RichText({ text, theme, inverse, fullWidth }: RichTextProps): ReactElement;

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

@@ -51,8 +51,12 @@ export interface SearchCoursesProps {
      * The wrapped version of this component is used for Hero
      */
     wrapped?: boolean;
+    /**
+     * The fullWidth version of this component is used for in study pages
+     */
+    fullWidth?: boolean;
 }
 /**
  * Search component
  */
-export default function SearchCourses({ theme, inverse, title, defaultSearchTerm, placeholder, filterTitle, filterFieldName, filterOptions, defaultFilter, resultsUrl, wrapped }: SearchCoursesProps): ReactElement;
+export default function SearchCourses({ theme, inverse, title, defaultSearchTerm, placeholder, filterTitle, filterFieldName, filterOptions, defaultFilter, resultsUrl, wrapped, fullWidth }: SearchCoursesProps): ReactElement;

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

@@ -0,0 +1,11 @@
+import { ReactElement, ReactNode } from 'react';
+import { ThemeProps } from '../../../themeProps';
+import './sidebarWrapper.scss';
+export interface SidebarWrapperProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    children: ReactNode;
+}
+export default function SidebarWrapper({ theme, children }: SidebarWrapperProps): ReactElement;

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

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

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

@@ -14,6 +14,10 @@ export interface SignPostProps {
      * A SignPost can have 2 or 4 items
      */
     items: readonly [SignPostItem, SignPostItem];
+    /**
+     * The fullWidth version of this component is used for in study pages
+     */
+    fullWidth?: boolean;
 }
 type SignPostItem = {
     title: string;
@@ -25,5 +29,5 @@ type SignPostItem = {
 /**
  * Text promo block with a link
  */
-export default function SignPost({ theme, inverse, items }: SignPostProps): ReactElement;
+export default function SignPost({ theme, inverse, items, fullWidth }: SignPostProps): ReactElement;
 export {};

package/dist/index.d.ts

@@ -415,11 +415,15 @@ interface SearchCoursesProps {
      * The wrapped version of this component is used for Hero
      */
     wrapped?: boolean;
+    /**
+     * The fullWidth version of this component is used for in study pages
+     */
+    fullWidth?: boolean;
 }
 /**
  * Search component
  */
-declare function SearchCourses({ theme, inverse, title, defaultSearchTerm, placeholder, filterTitle, filterFieldName, filterOptions, defaultFilter, resultsUrl, wrapped }: SearchCoursesProps): ReactElement;
+declare function SearchCourses({ theme, inverse, title, defaultSearchTerm, placeholder, filterTitle, filterFieldName, filterOptions, defaultFilter, resultsUrl, wrapped, fullWidth }: SearchCoursesProps): ReactElement;
 
 interface SignPostProps {
     /**
@@ -434,6 +438,10 @@ interface SignPostProps {
      * A SignPost can have 2 or 4 items
      */
     items: readonly [SignPostItem, SignPostItem];
+    /**
+     * The fullWidth version of this component is used for in study pages
+     */
+    fullWidth?: boolean;
 }
 type SignPostItem = {
     title: string;
@@ -445,7 +453,7 @@ type SignPostItem = {
 /**
  * Text promo block with a link
  */
-declare function SignPost({ theme, inverse, items }: SignPostProps): ReactElement;
+declare function SignPost({ theme, inverse, items, fullWidth }: SignPostProps): ReactElement;
 
 interface SkipToContentProps {
     theme: ThemeProps;
@@ -504,8 +512,12 @@ interface RichTextProps {
      */
     inverse?: boolean;
     text: string;
+    /**
+     * The fullWidth version of this component is used for in study pages
+     */
+    fullWidth?: boolean;
 }
-declare function RichText({ text, theme, inverse }: RichTextProps): ReactElement;
+declare function RichText({ text, theme, inverse, fullWidth }: RichTextProps): ReactElement;
 
 interface TextWithBackgroundProps {
     /**
@@ -591,4 +603,57 @@ interface ImageBlockProps extends HeadingProps {
 }
 declare function ImageBlock({ theme, inverse, title, description, linkProps, fullWidth, images }: ImageBlockProps): ReactElement | null;
 
-export { Breadcrumbs, Carousel, FeaturedContent, FeaturedSignpost, FeaturedVideo, Footer, Header, Hero, HeroCarousel, ImageBlock, IntroText, MainWrapper, RichText, SearchCourses, SignPost, SkipToContent, TextWithBackground, VideoCardComponent };
+interface AccordionItemProps {
+    key?: number;
+    title: string;
+    text: string;
+    theme: ThemeProps;
+    inverse?: boolean;
+    titleTag: 'h2' | 'h3' | 'h4';
+}
+
+interface AccordionProps {
+    theme: ThemeProps;
+    inverse?: boolean;
+    heading?: Omit<HeadingProps, 'theme' | 'inverse'>;
+    accordionItems: AccordionItemProps[];
+}
+declare function Accordion({ theme, inverse, heading, accordionItems }: AccordionProps): ReactElement;
+
+interface PromoBlockProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    /**
+     * Whether to inverse the colours
+     */
+    inverse?: boolean;
+    /**
+     * Optional title of the component
+     */
+    title?: string;
+    /**
+     * Optional description of the component
+     */
+    description?: string;
+    /**
+     * Optional link elements
+     */
+    link?: LinkWithArrowProps;
+    /**
+     * Promo block will work with three card types
+     */
+    type: 'promo' | 'promo-signpost' | 'promo-video';
+    /**
+     * A Promo block component can have any number of items
+     */
+    cards: CardPromoProps[] | CardPromoSignpostProps[] | CardPromoVideoProps[];
+    /**
+     * Only applies to the signpost card and if there is only one
+     */
+    imageOrientation: 'left' | 'right';
+}
+declare function PromoBlock({ theme, inverse, type, title, description, link, cards, imageOrientation }: PromoBlockProps): ReactElement | null;
+
+export { Accordion, Breadcrumbs, Carousel, FeaturedContent, FeaturedSignpost, FeaturedVideo, Footer, Header, Hero, HeroCarousel, ImageBlock, IntroText, MainWrapper, PromoBlock, RichText, SearchCourses, SignPost, SkipToContent, TextWithBackground, VideoCardComponent };