@apolitical/component-library 0.0.5 → 1.1.0-beta.2

package/layout/download-section/download-section.d.ts

@@ -0,0 +1,21 @@
+interface ButtonProps {
+    /** The text to display on the button */
+    text: string;
+    /** The link to the download */
+    link: string;
+    /** The GTM event context */
+    eventContext?: string;
+}
+interface Props {
+    /** Content to be rendered */
+    text: string | {
+        element: string;
+        text: string;
+    };
+    /** Props for `Button` component; multiple buttons can be passed in */
+    buttons: ButtonProps[];
+    /** Additional classes */
+    className?: string;
+}
+declare const DownloadSection: ({ text, buttons, className }: Props) => import("react/jsx-runtime").JSX.Element;
+export default DownloadSection;

package/layout/download-section/index.d.ts

@@ -0,0 +1 @@
+export { default as DownloadSection } from './download-section';

package/layout/index.d.ts

@@ -1 +1,3 @@
-export { default as Layout } from './layout';
+export * from './download-section';
+export * from './logos';
+export * from './page-layout';

package/layout/logos/index.d.ts

@@ -0,0 +1 @@
+export { default as Logos } from './logos';

package/layout/logos/logos.d.ts

@@ -0,0 +1,24 @@
+export interface LogosType {
+    logo: {
+        url: string;
+        type?: string;
+        width?: number;
+        height?: number;
+    };
+    nameOfBusiness: string;
+    link?: false | string;
+    description?: false | string;
+}
+interface Props {
+    /** The title to show above the logos */
+    title?: false | string | {
+        element: string;
+        text: string;
+    };
+    /** The logos to show */
+    logos?: Array<LogosType>;
+    /** Additional classes */
+    className?: string;
+}
+declare const Logos: ({ title: titleProps, logos, className }: Props) => import("react/jsx-runtime").JSX.Element | null;
+export default Logos;

package/layout/logos/logos.mock.d.ts

@@ -0,0 +1,3 @@
+import type { LogosType } from './logos';
+declare const data: Array<LogosType>;
+export default data;

package/layout/page-layout/components/cookie-banner/cookie-banner.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    /** The language to use */
+    locale?: string;
+}
+declare const CookieBannerWrapper: ({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default CookieBannerWrapper;

package/layout/page-layout/components/cookie-banner/index.d.ts

@@ -0,0 +1 @@
+export { default as CookieBanner } from './cookie-banner';

package/layout/page-layout/components/footer/footer.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    /** The language to use */
+    locale?: string;
+}
+declare const FooterWrapper: ({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default FooterWrapper;

package/layout/page-layout/components/footer/footer.data.d.ts

@@ -0,0 +1,6 @@
+declare const data: {
+    [key: string]: {
+        [key: string]: string | string[] | object;
+    };
+};
+export default data;

package/layout/page-layout/components/footer/index.d.ts

@@ -0,0 +1 @@
+export { default as Footer } from './footer';

package/layout/page-layout/components/header/__mocks__/header.data.d.ts

@@ -0,0 +1,83 @@
+declare namespace _default {
+    export namespace link {
+        let href: string;
+    }
+    export namespace buttons {
+        namespace buttonWithProps {
+            let href_1: string;
+            export { href_1 as href };
+            export namespace props {
+                let variant: string;
+            }
+        }
+        namespace buttonWithoutProps {
+            let href_2: string;
+            export { href_2 as href };
+        }
+    }
+    export namespace doTrack {
+        let href_3: string;
+        export { href_3 as href };
+        let doTrack_1: boolean;
+        export { doTrack_1 as doTrack };
+    }
+    export namespace doTrackWithGTMType {
+        let href_4: string;
+        export { href_4 as href };
+        let doTrack_2: boolean;
+        export { doTrack_2 as doTrack };
+        export let gtmType: string;
+    }
+    export namespace dontTrack {
+        let href_5: string;
+        export { href_5 as href };
+        let doTrack_3: boolean;
+        export { doTrack_3 as doTrack };
+    }
+    export namespace defaultTrack {
+        let href_6: string;
+        export { href_6 as href };
+    }
+    export namespace parent {
+        let order: string[];
+        namespace child {
+            let order_1: string[];
+            export { order_1 as order };
+            export namespace grandchild {
+                let href_7: string;
+                export { href_7 as href };
+            }
+        }
+    }
+    export namespace badParent {
+        let order_2: string[];
+        export { order_2 as order };
+    }
+    export namespace submenu {
+        let order_3: string[];
+        export { order_3 as order };
+        export namespace child_1 {
+            let href_8: string;
+            export { href_8 as href };
+        }
+        export { child_1 as child };
+    }
+    export namespace variant_1 {
+        let href_9: string;
+        export { href_9 as href };
+        export let hasVariantText: boolean;
+    }
+    export { variant_1 as variant };
+    export namespace onlyShowLoggedIn {
+        let href_10: string;
+        export { href_10 as href };
+        export let onlyShow: string;
+    }
+    export namespace onlyShowLoggedOut {
+        let href_11: string;
+        export { href_11 as href };
+        let onlyShow_1: string;
+        export { onlyShow_1 as onlyShow };
+    }
+}
+export default _default;

package/layout/page-layout/components/header/components/header-link/header-link.d.ts

@@ -0,0 +1,13 @@
+interface Props {
+    id: string;
+    isLoggedIn?: boolean;
+    isDesktopVersion?: boolean;
+    menus?: {
+        navigation?: boolean;
+        account?: boolean;
+    };
+    callback?: (id: string, value: boolean) => void;
+    doTrack?: boolean | null;
+}
+declare const HeaderLink: ({ id, isLoggedIn, isDesktopVersion, menus, callback, doTrack: doTrackProp, }: Props) => import("react/jsx-runtime").JSX.Element | null;
+export default HeaderLink;

package/layout/page-layout/components/header/components/header-link/index.d.ts

@@ -0,0 +1 @@
+export { default as HeaderLink } from './header-link';

package/layout/page-layout/components/header/components/index.d.ts

@@ -0,0 +1 @@
+export * from './header-link';

package/layout/page-layout/components/header/header.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    /** The language to use */
+    locale?: string;
+}
+declare const HeaderWrapper: ({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default HeaderWrapper;

package/layout/page-layout/components/header/header.data.d.ts

@@ -0,0 +1,112 @@
+declare namespace _default {
+    let order: string[];
+    namespace home {
+        let href: string;
+        let hasVariantText: boolean;
+        let gtmType: string;
+    }
+    namespace topics {
+        let order_1: string[];
+        export { order_1 as order };
+        export let menuId: string;
+        export let explore: {
+            order: string[];
+            events: {
+                href: string;
+                className: string;
+            };
+            courses: {
+                href: string;
+                gtmType: string;
+                className: string;
+            };
+            'q-and-a': {
+                href: string;
+                className: string;
+            };
+            articles: {
+                href: string;
+                gtmType: string;
+                className: string;
+            };
+        };
+        let topics_1: {
+            order: string[];
+            className: string;
+            climate: {
+                href: string;
+            };
+            'cities-and-local-government': {
+                href: string;
+            };
+            'digital-and-data': {
+                href: string;
+            };
+            education: {
+                href: string;
+            };
+            'equity-justice-and-inclusion': {
+                href: string;
+            };
+            'health-and-social-care': {
+                href: string;
+            };
+            innovation: {
+                href: string;
+            };
+            'leadership-and-skills': {
+                href: string;
+            };
+            'life-in-government': {
+                href: string;
+            };
+            policymaking: {
+                href: string;
+            };
+            'transport-and-infrastructure': {
+                href: string;
+            };
+            'work-and-the-economy': {
+                href: string;
+            };
+        };
+        export { topics_1 as topics };
+    }
+    namespace partners {
+        let href_1: string;
+        export { href_1 as href };
+        export let onlyShow: string;
+    }
+    let account: {
+        order: string[];
+        className: string;
+        onlyShow: string;
+        doTrack: boolean;
+        profile: {
+            href: string;
+        };
+        settings: {
+            href: string;
+        };
+        'log-out': {
+            href: string;
+            className: string;
+        };
+    };
+    namespace buttons {
+        let order_2: string[];
+        export { order_2 as order };
+        export namespace login {
+            let href_2: string;
+            export { href_2 as href };
+        }
+        export namespace signup {
+            let href_3: string;
+            export { href_3 as href };
+            export namespace props {
+                let variant: string;
+            }
+        }
+    }
+}
+export default _default;

package/layout/page-layout/components/header/header.helpers.d.ts

@@ -0,0 +1,39 @@
+export default helpers;
+declare namespace helpers {
+    let timeouts: {};
+    let handlerCalled: {};
+    function getIsDesktopVersion(isLoggedIn: any, screenWidth: any): {};
+    function shouldChangeHeaderIsVisible(value: any, menus: any, dispatch: any): void;
+    function handleMenus({ id, value, menus, dispatch }: {
+        id: any;
+        value: any;
+        menus: any;
+        dispatch: any;
+    }): void;
+    function findFirstChild(ref: any, key: any, value?: boolean): any;
+    function autoFocus({ menu, navigationRef, isDesktopVersion, focusElements, dispatch }: {
+        menu: any;
+        navigationRef: any;
+        isDesktopVersion: any;
+        focusElements: any;
+        dispatch: any;
+    }): void;
+    namespace events {
+        function onClick(e: any, { id, callback, isOpen }: {
+            id: any;
+            callback: any;
+            isOpen: any;
+        }): void;
+        function onFocus({ id }: {
+            id: any;
+        }): void;
+        function onMouseEnter({ id, callback }: {
+            id: any;
+            callback: any;
+        }): void;
+        function onBlur({ id, callback }: {
+            id: any;
+            callback: any;
+        }): void;
+    }
+}

package/layout/page-layout/components/header/header.mock.d.ts

@@ -0,0 +1,29 @@
+declare const _default: {
+    user: {
+        id: string;
+        email: string;
+        name: string;
+    };
+    headerLinks: {
+        en: {
+            header_link: string;
+            header_buttons_buttonWithProps: string;
+            header_buttons_buttonWithoutProps: string;
+            header_doTrack: string;
+            header_doTrackWithGTMType: string;
+            header_dontTrack: string;
+            header_defaultTrack: string;
+            header_parent: string;
+            header_parent_child: string;
+            header_parent_child_grandchild: string;
+            header_badParent: string;
+            header_submenu: string;
+            header_submenu_child: string;
+            header_variant_loggedIn: string;
+            header_variant_loggedOut: string;
+            header_onlyShowLoggedIn: string;
+            header_onlyShowLoggedOut: string;
+        };
+    };
+};
+export default _default;

package/layout/page-layout/components/header/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Header } from './header';
+export { default as headerData } from './header.data';

package/layout/page-layout/components/index.d.ts

@@ -0,0 +1,3 @@
+export * from './cookie-banner';
+export * from './footer';
+export * from './header';

package/layout/page-layout/index.d.ts

@@ -0,0 +1,2 @@
+export * from './components';
+export { default as PageLayout } from './page-layout';

package/layout/page-layout/page-layout.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+interface Props {
+    /** Content to show on the page */
+    children: React.ReactNode;
+    /** Handle errors */
+    reportError: () => void;
+    background?: 'default' | 'gradient';
+    /** Optionally hide the footer, for pages where we need to focus the user's attention, like onboarding */
+    showFooter?: boolean;
+    /** Additional classes */
+    className?: string;
+    /** The language to use */
+    locale?: string;
+}
+declare const PageLayout: ({ children, reportError, showFooter, background, className, locale }: Props) => import("react/jsx-runtime").JSX.Element;
+export default PageLayout;

package/loaders/index.d.ts

@@ -0,0 +1,4 @@
+export * from './loading-block';
+export * from './loading-placeholder';
+export * from './loading-state';
+export * from './progress-bar';

package/loaders/loading-block/index.d.ts

@@ -0,0 +1 @@
+export { default as LoadingBlock } from './loading-block';

package/loaders/loading-block/loading-block.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+interface Props {
+    /** The amount of progress, shown as a percent */
+    progress?: number;
+    /** The text and icons to show at different progress points */
+    steps?: false | {
+        [key: string]: {
+            text: string;
+            icon?: string;
+        };
+    };
+    /** Additional classes */
+    className?: string;
+    /** The language for the text */
+    locale?: string;
+}
+declare const _default: React.MemoExoticComponent<({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element>;
+export default _default;

package/loaders/loading-placeholder/index.d.ts

@@ -0,0 +1 @@
+export { default as LoadingPlaceholder } from './loading-placeholder';

package/loaders/loading-placeholder/loading-placeholder.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+interface Props {
+    /** The element that will render around the content. */
+    element?: 'span' | 'div' | 'p' | 'li';
+    /** Additional styling, to add width and height */
+    style?: React.CSSProperties;
+    /** Additional classes */
+    className?: string;
+}
+declare const LoadingPlaceholder: ({ element, className, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default LoadingPlaceholder;

package/loaders/loading-state/index.d.ts

@@ -0,0 +1 @@
+export { default as LoadingState } from './loading-state';

package/loaders/loading-state/loading-state.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    layout?: 'overview-page';
+}
+declare const LoadingState: ({ layout }: Props) => import("react/jsx-runtime").JSX.Element;
+export default LoadingState;

package/loaders/progress-bar/index.d.ts

@@ -0,0 +1 @@
+export { default as ProgressBar } from './progress-bar';

package/loaders/progress-bar/progress-bar.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+interface Props {
+    /** The amount of progress, shown as a percent */
+    progress?: number;
+    /** Text to display for screen readers */
+    text?: string | boolean;
+    /** Additional classes */
+    className?: string;
+    /** The language for the text */
+    locale?: string;
+}
+declare const _default: React.MemoExoticComponent<({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element>;
+export default _default;

package/modals/modal/index.d.ts

@@ -0,0 +1 @@
+export { default as Modal } from './modal';

package/modals/modal/modal.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+interface Props {
+    /** The content to display */
+    children: React.ReactNode | string;
+    /** Additional classes */
+    className?: string;
+}
+declare const Modal: ({ children, className }: Props) => import("react/jsx-runtime").JSX.Element;
+export default Modal;

package/navigation/filters/filters.d.ts

@@ -0,0 +1,28 @@
+export interface FilterType {
+    id: string;
+    text: string;
+    disabled?: boolean;
+    callback?: () => void;
+}
+interface Props {
+    /** The filter details */
+    options: FilterType[];
+    /** A filter for 'all' */
+    allOption?: boolean | {
+        text?: string;
+        callback?: () => void;
+    };
+    /** Whether the filter allows multiple selections */
+    allowMultiple?: boolean;
+    /** The callback function for when the filter changes */
+    onChange?: (options: {
+        current: string[];
+        previous: string[];
+    }) => void;
+    /** Additional classes */
+    className?: string;
+    /** The language to use */
+    locale?: string;
+}
+declare const FiltersWrapper: ({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default FiltersWrapper;

package/navigation/filters/index.d.ts

@@ -0,0 +1 @@
+export { default as Filters } from './filters';

package/navigation/index.d.ts

@@ -0,0 +1,4 @@
+export * from './filters';
+export * from './load-more';
+export * from './logo';
+export * from './tags';

package/navigation/load-more/index.d.ts

@@ -0,0 +1 @@
+export { default as LoadMore } from './load-more';

package/navigation/load-more/load-more.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+import { ButtonIconType } from '../../general';
+interface Props {
+    /** The current page we're viewing */
+    page?: number;
+    /** The number of elements we're looking to display */
+    length?: number;
+    /** The total number of elements that will be displayed on screen */
+    limit?: number;
+    /** The function that will be invoked when the button is clicked */
+    loadNextPage: ((e: React.MouseEvent<HTMLElement>) => void);
+    /** An icon for the button - uses `Button`'s icon format */
+    icon: ButtonIconType;
+    /** Text displayed in the component */
+    messages: {
+        button: string;
+        endOfFeed: string;
+        error: string;
+    };
+    /** Additional classes  */
+    className?: string;
+    /** GTM event context */
+    gtmContext?: string;
+    /** The language to use */
+    locale?: string;
+}
+declare const LoadMoreWrapper: ({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default LoadMoreWrapper;

package/navigation/logo/index.d.ts

@@ -0,0 +1 @@
+export { default as Logo } from './logo';

package/navigation/logo/logo.d.ts

@@ -0,0 +1,12 @@
+interface Props {
+    /** Style variant of the logo */
+    variant?: 'default' | 'inverted';
+    /** Version of the logo, defaulting to showing whatever fits into the screen size best  */
+    version?: 'default' | 'small' | 'full';
+    /** Additional classes */
+    className?: string;
+    /** The language to use */
+    locale?: string;
+}
+declare const LogoWrapper: ({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default LogoWrapper;

package/navigation/tags/index.d.ts

@@ -0,0 +1 @@
+export { default as Tags } from './tags';

package/navigation/tags/tags.d.ts

@@ -0,0 +1,20 @@
+interface Props {
+    /** The tags for the content */
+    tags?: string[];
+    /** The colour of the tags */
+    color?: 'default' | 'light';
+    /** Force the tags to be on one line */
+    forceOneLine?: boolean;
+    /** Whether the tags can have links */
+    canHaveLinks?: boolean;
+    /** Additional classes */
+    className?: string;
+    /** The GTM event type */
+    gtmType?: string;
+    /** The GTM event context */
+    gtmContext?: string;
+    /** The language to use */
+    locale?: string;
+}
+declare const TagsWrapper: ({ locale, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default TagsWrapper;

package/navigation/tags/tags.helpers.d.ts

@@ -0,0 +1,34 @@
+export namespace intlPath {
+    let _default: string;
+    export { _default as default };
+    export let headerTopics: string;
+}
+export const tags: {
+    topic: {
+        Climate: string;
+        CitiesAndLocalGovernment: string;
+        DigitalAndData: string;
+        Education: string;
+        EquityJusticeAndInclusion: string;
+        HealthAndSocialCare: string;
+        Innovation: string;
+        LeadershipAndSkills: string;
+        LifeInGovernment: string;
+        Policymaking: string;
+        TransportAndInfrastructure: string;
+        WorkAndTheEconomy: string;
+    };
+    'from the community': string;
+};
+declare namespace _default {
+    function getTagDetails(tag: any): {
+        id: any;
+        href: any;
+        text: string;
+    } | {
+        id: any;
+        text: string;
+        href?: undefined;
+    } | null;
+}
+export default _default;