@uob-web-and-digital/component-library 0.0.2 → 0.0.3

package/dist/index.d.ts

@@ -1,7 +1,80 @@
-import './base.scss';
-import Footer from './components/Footer/Footer';
-import { Header } from './components/Header/Header';
-import MainWrapper from './components/MainWrapper/MainWrapper';
-import SignPost from './components/SignPost/SignPost';
-import SkipToContent from './components/SkipToContent/SkipToContent';
+import { ReactElement, PropsWithChildren } from 'react';
+
+type ThemeProps = 'uobmain' | 'redexample';
+
+interface FooterLinkProps {
+    label: string;
+    href: string;
+    externalLink: boolean;
+}
+interface FooterProps {
+    theme: ThemeProps;
+    summaryLinks: FooterLinkProps[];
+    hygieneLinks: FooterLinkProps[];
+    locations: FooterLinkProps[];
+}
+declare function Footer({ theme, locations, summaryLinks, hygieneLinks }: FooterProps): ReactElement;
+
+interface HeaderLink {
+    label: string;
+    url: string;
+    description?: string;
+    children?: HeaderLink[];
+}
+
+interface HeaderProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    /**
+     * Large nav links on the main menu
+     */
+    primaryLinks: HeaderLink[];
+    /**
+     * Small nav links on the main menu
+     */
+    secondaryLinks: HeaderLink[];
+    homepageUrl: string;
+    dubaiUrl: string;
+    ukUrl: string;
+    activeCampus: 'uk' | 'dubai';
+}
+declare const Header: ({ theme, primaryLinks, secondaryLinks, homepageUrl, dubaiUrl, ukUrl, activeCampus }: HeaderProps) => ReactElement;
+
+interface MainWrapperProps {
+}
+declare function MainWrapper({ children }: PropsWithChildren<MainWrapperProps>): ReactElement;
+
+interface SignPostProps {
+    /**
+     * The theme to use
+     */
+    theme: ThemeProps;
+    /**
+     * Whether to inverse the colours
+     */
+    inverse?: boolean;
+    /**
+     * A SignPost can have 2 or 4 items
+     */
+    items: readonly [SignPostItem, SignPostItem];
+}
+type SignPostItem = {
+    title: string;
+    tag: string;
+    linkLabel: string;
+    linkUrl: string;
+    external?: boolean;
+};
+/**
+ * Text promo block with a link
+ */
+declare function SignPost({ theme, inverse, items }: SignPostProps): ReactElement;
+
+interface SkipToContentProps {
+    theme: ThemeProps;
+}
+declare function SkipToContent({ theme }: SkipToContentProps): ReactElement;
+
 export { Footer, Header, MainWrapper, SignPost, SkipToContent };