@nnc-digital/nnc-design-system 0.4.39 → 1.0.0-alpha10

package/build/src/library/pages/DirectoryServicePage/DirectoryServicePage.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const DirectoryServicePage: React.FunctionComponent;

package/build/src/library/pages/ErrorPage/ErrorPage.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export interface ErrorPageProps {
+    pageTitle: string;
+    errorCode: number;
+}
+export declare const ErrorPage: React.FC<ErrorPageProps>;

package/build/src/library/pages/Home/HomePage.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { HomePageProps } from './HomePage.types';
+/**
+ * An example home page layout constructed from the structures and components defined in the
+ * design system. The actual page layout is defined within the front end app and may be
+ * out of step with this example.
+ */
+export declare const HomePage: React.FunctionComponent<HomePageProps>;

package/build/src/library/pages/Home/HomePage.types.d.ts

@@ -0,0 +1,60 @@
+import React from 'react';
+import { HeroImageProp } from '../../structure/HomeHero/HomeHero.types';
+import { NewsArticleProps } from '../../structure/NewsArticleList/NewsArticleList.types';
+import { PromoBannerProps } from '../../structure/PromoBanner/PromoBanner.types';
+import { PromoProps } from '../../structure/PromoBlock/PromoBlock.types';
+import { PageLinkProp } from '../../structure/ServicesLinksList/ServicesLinksList.types';
+export interface HomePageProps {
+    /**
+     * The number of promotional tiles (0 to 4 supported)
+     */
+    numberOfPromos: number;
+    /**
+     * The number of news stories (0 to 9 supported)
+     */
+    numberOfNewsStories: number;
+    /**
+     * Title of the alert banner
+     */
+    alertBannerTitle: string;
+    /**
+     * Content of the alert banner
+     */
+    alertBannerContent: React.ReactNode;
+    /**
+     * Hero images
+     */
+    heroArray: Array<HeroImageProp>;
+    /**
+     * Promoted links
+     */
+    promotedLinksArray: Array<PageLinkProp>;
+    /**
+     * Service links
+     */
+    servicesArray: Array<PageLinkProp>;
+    /**
+     * Should the services list be boxed
+     */
+    isBoxed?: boolean;
+    /**
+     * News articles
+     */
+    newsArticlesArray: Array<NewsArticleProps>;
+    /**
+     * Promo banner
+     */
+    promoBannerData: PromoBannerProps;
+    /**
+     * Promo banner content (children)
+     */
+    promoBannerContent: React.ReactNode;
+    /**
+     * Promo blocks
+     */
+    promoBlocksArray: Array<PromoProps>;
+    /**
+     * Footer links
+     */
+    footerLinksArray: Array<PageLinkProp>;
+}

package/build/src/library/pages/MemorialPage/MemorialPage.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { MemorialPageProps } from './MemorialPage.types';
+/**
+ * An example memorialised home page layout constructed from the structures and components defined
+ * in the design system. The actual page layout is defined within the front end app and may be
+ * out of step with this example.
+ */
+export declare const MemorialPage: React.FunctionComponent<MemorialPageProps>;

package/build/src/library/pages/MemorialPage/MemorialPage.types.d.ts

@@ -0,0 +1,59 @@
+import React from 'react';
+import { NewsArticleProps } from '../../structure/NewsArticleList/NewsArticleList.types';
+import { PromoBannerProps } from '../../structure/PromoBanner/PromoBanner.types';
+import { PromoProps } from '../../structure/PromoBlock/PromoBlock.types';
+import { PageLinkProp } from '../../structure/ServicesLinksList/ServicesLinksList.types';
+export interface MemorialPageProps {
+    /**
+     * The number of promotional tiles (0 to 4 supported)
+     */
+    numberOfPromos: number;
+    /**
+     * The number of news stories (0 to 9 supported)
+     */
+    numberOfNewsStories: number;
+    /**
+     * Title of the alert banner
+     */
+    alertBannerTitle: string;
+    /**
+     * Content of the alert banner
+     */
+    alertBannerContent: React.ReactNode;
+    /**
+     * Condolence links on memorial hero
+     */
+    condolenceLinksArray: Array<PageLinkProp>;
+    /**
+     * Links below memorial hero
+     */
+    memorialServiceLinksArray: Array<PageLinkProp>;
+    /**
+     * Service links
+     */
+    servicesArray: Array<PageLinkProp>;
+    /**
+     * Should the services list be boxed
+     */
+    isBoxed?: boolean;
+    /**
+     * News articles
+     */
+    newsArticlesArray: Array<NewsArticleProps>;
+    /**
+     * Promo banner
+     */
+    promoBannerData: PromoBannerProps;
+    /**
+     * Promo banner content (children)
+     */
+    promoBannerContent: React.ReactNode;
+    /**
+     * Promo blocks
+     */
+    promoBlocksArray: Array<PromoProps>;
+    /**
+     * Footer links
+     */
+    footerLinksArray: Array<PageLinkProp>;
+}

package/build/src/library/pages/News/News.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export interface NewsProps {
+    hasResults: boolean;
+}
+export declare const News: React.FunctionComponent<NewsProps>;

package/build/src/library/pages/NewsArticle/NewsArticle.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export interface NewsArticleProps {
+    withImage?: string;
+    imagePlaceholder?: string;
+    isOld?: boolean;
+}
+export declare const NewsArticle: React.FC<NewsArticleProps>;

package/build/src/library/pages/SearchResultsPageExample/SearchResultsPageExample.d.ts

@@ -0,0 +1,29 @@
+import React from 'react';
+import { SignpostLinkProp } from '../../components/SignpostLinksList/SignpostLinksList.types';
+export interface SearchResultsPageExampleProps {
+    results: Array<SearchResultProps>;
+}
+interface SearchResultProps {
+    /**
+     * Search result title
+     */
+    title: string;
+    /**
+     * Link to page
+     */
+    link: string;
+    /**
+     * Summary of page
+     */
+    summary: string;
+    /**
+     * If it contains signposting links include them here
+     */
+    signpostLinksArray?: Array<SignpostLinkProp>;
+    /**
+     * If there is a service area tied to the result
+     */
+    service: string;
+}
+export declare const SearchResultsPageExample: React.FC<SearchResultsPageExampleProps>;
+export {};

package/build/src/library/pages/ServiceLandingPageExample/ServiceLandingPageExample.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import { ServiceLandingPageExampleProps } from './ServiceLandingPageExample.types';
+export declare const ServiceLandingPageExample: React.FunctionComponent<ServiceLandingPageExampleProps>;

package/build/src/library/pages/ServiceLandingPageExample/ServiceLandingPageExample.storydata.d.ts

@@ -0,0 +1,30 @@
+import React from 'react';
+import { SectionLinksProps } from '../../structure/SectionLinks/SectionLinks.types';
+import { FooterLinkProp } from '../../structure/Footer/Footer.types';
+import { BreadcrumbProp } from '../../structure/Breadcrumbs/Breadcrumbs.types';
+import { PageLinkProp, ServicesLinksListProps } from '../../structure/ServicesLinksList/ServicesLinksList.types';
+import { AlertBannerServiceProps } from '../../structure/AlertBannerService/AlertBannerService.types';
+import { CardsProps } from '../../slices/Cards/Cards.types';
+export declare const threeTopServicesData: ServicesLinksListProps;
+export declare const sixTopServicesData: ServicesLinksListProps;
+export declare const sections: SectionLinksProps[];
+export declare const footerLinks: FooterLinkProp[];
+export declare const breadcrumbs: BreadcrumbProp[];
+export declare const micrositeBreadcrumbs: BreadcrumbProp[];
+export declare const serviceAlert: AlertBannerServiceProps;
+/**
+ * Promo Page Storydata
+ */
+export declare const promoHeroImageData: {
+    headline: string;
+    content: string;
+    imageLarge: string;
+    imageSmall: string;
+    imageAltText: string;
+    backgroundBox: boolean;
+};
+export declare const promoTopServices: Array<PageLinkProp>;
+export declare const promoTopServicesData: ServicesLinksListProps;
+export declare const cardsData: CardsProps;
+export declare const imageCardsData: CardsProps;
+export declare const promoBodyText: React.ReactNode;

package/build/src/library/pages/ServiceLandingPageExample/ServiceLandingPageExample.types.d.ts

@@ -0,0 +1,52 @@
+import { BreadcrumbProp } from '../../structure/Breadcrumbs/Breadcrumbs.types';
+import { FooterLinkProp } from '../../structure/Footer/Footer.types';
+import { HeroImageProps } from '../../structure/HeroImage/HeroImage.types';
+import { SectionLinksProps } from '../../structure/SectionLinks/SectionLinks.types';
+import { ServicesLinksListProps } from '../../structure/ServicesLinksList/ServicesLinksList.types';
+import { AlertBannerServiceProps } from '../../structure/AlertBannerService/AlertBannerService.types';
+export interface ServiceLandingPageExampleProps {
+    /**
+     * The Service landing page title
+     */
+    title: string;
+    /**
+     * Hero image banner definition
+     */
+    heroImage?: HeroImageProps;
+    /**
+     * Body text below service links
+     */
+    bodyText?: string;
+    /**
+     * Array of breadcrumbs
+     */
+    breadcrumbsArray: Array<BreadcrumbProp>;
+    /**
+     * Array of Sections
+     */
+    sections: SectionLinksProps[];
+    /**
+     * Array of Footer links
+     */
+    footerLinksArray: FooterLinkProp[];
+    /**
+     * Top services to highlight below the heading or hero image
+     */
+    topServices?: ServicesLinksListProps;
+    /**
+     * Summary text describing the page
+     */
+    summary?: string;
+    /**
+     * Should the summary be displayed
+     */
+    showSummary?: Boolean;
+    /**
+     * Optional service alert banner
+     */
+    serviceAlert?: AlertBannerServiceProps;
+    /**
+     * Optional heading icon
+     */
+    icon?: string;
+}

package/build/src/library/pages/ServicePageExample/ServicePageExample.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { ContentsProps } from '../../structure/Contents/Contents.types';
+export interface ServicePageExampleProps {
+    showServiceAlert: boolean;
+    contents?: ContentsProps;
+}
+export declare const ServicePageExample: React.FunctionComponent<ServicePageExampleProps>;

package/build/src/library/pages/SignpostPageExample/SignpostPageExample.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { SignpostLinkProp } from '../../structure/SignpostLinks/SignpostLinks.types';
+export interface SignpostPageExampleProps {
+    signpostLinksArrayExample: Array<SignpostLinkProp>;
+    showServiceAlert: boolean;
+}
+export declare const SignpostPageExample: React.FunctionComponent<SignpostPageExampleProps>;

package/build/src/library/pages/Templates/Templates.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+export interface TemplatesProps {
+    /**
+     * Which page template is it
+     */
+    type: string;
+}
+export declare const Templates: React.FC<TemplatesProps>;

package/build/src/library/slices/Accordion/Accordion.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { AccordionProps } from './Accordion.types';
+declare const Accordion: React.FunctionComponent<AccordionProps>;
+export default Accordion;

package/build/src/library/slices/Accordion/Accordion.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/library/slices/Accordion/Accordion.types.d.ts

@@ -0,0 +1,52 @@
+export interface AccordionProps {
+    /**
+     * accepts multiple sections
+     */
+    sections: Array<AccordionSectionProps>;
+    /**
+     * We reuse this on filter pages - but it looks slightly different
+     */
+    isFilter?: boolean;
+    /**
+     * Should there be a read more link at the bottom of each section?
+     */
+    withReadMore?: boolean;
+}
+export interface AccordionSectionProps {
+    /**
+     * Section title
+     */
+    title: string;
+    /**
+     * Section content
+     */
+    content: React.ReactNode;
+    /**
+     * Section summary
+     */
+    summary?: string;
+    /**
+     * Is the section expanded
+     */
+    isExpanded?: boolean;
+    /**
+     * Identify the section so sections can have the same title
+     */
+    accordionSectionId?: number;
+    /**
+     * Method used internally for opening closing element
+     */
+    onToggle?: (title: any, value: any) => void;
+    /**
+     * We reuse this on filter pages where the section buttons have h4 styles, instead of h3 styles
+     */
+    isFilter?: boolean;
+    /**
+     * Should there be a read more link at the bottom of each section?
+     */
+    withReadMore?: boolean;
+    /**
+     * unique ID for the section
+     */
+    sectionId?: string;
+}

package/build/src/library/slices/Accordion/AccordionSection.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { AccordionSectionProps } from './Accordion.types';
+declare const AccordionSection: React.FunctionComponent<AccordionSectionProps>;
+export default AccordionSection;

package/build/src/library/slices/BlockQuote/BlockQuote.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { BlockQuoteProps } from "./BlockQuote.types";
+declare const BlockQuote: React.FC<BlockQuoteProps>;
+export default BlockQuote;

package/build/src/library/slices/BlockQuote/BlockQuote.types.d.ts

@@ -0,0 +1,10 @@
+export interface BlockQuoteProps {
+    /**
+     * 	The text of the quote
+     */
+    quote: React.ReactNode;
+    /**
+     * Optionally, the attribution of the quote
+     */
+    citation?: string;
+}

package/build/src/library/slices/CallToAction/CallToAction.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { ButtonProps } from '../../components/Button/Button.types';
+/**
+ * A button wrapped in a div used as a slice in the content management system
+ */
+declare const CallToAction: React.FunctionComponent<ButtonProps>;
+export default CallToAction;

package/build/src/library/slices/Cards/Cards.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { CardsProps } from './Cards.types';
+/**
+ * Multiple cards in a responsive grid
+ */
+declare const Cards: React.FunctionComponent<CardsProps>;
+export default Cards;

package/build/src/library/slices/Cards/Cards.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/library/slices/Cards/Cards.types.d.ts

@@ -0,0 +1,7 @@
+import { CardProps } from '../../components/Card/Card.types';
+export interface CardsProps {
+    /**
+     * An array of card
+     */
+    cards: CardProps[];
+}

package/build/src/library/slices/CouncilTaxAlphabeticalDirectory/CouncilTaxAlphabeticalDirectory.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { CouncilTaxAlphabeticalDirectoryProps } from './CouncilTaxAlphabeticalDirectory.types';
+/**
+ * An list of parishes, sorted alphabetically, containing parish council tax bands
+ */
+declare const CouncilTaxAlphabeticalDirectory: React.FunctionComponent<CouncilTaxAlphabeticalDirectoryProps>;
+export default CouncilTaxAlphabeticalDirectory;

package/build/src/library/slices/CouncilTaxAlphabeticalDirectory/CouncilTaxAlphabeticalDirectory.storydata.d.ts

@@ -0,0 +1,4 @@
+import { BandingAPIResponse, ParishAPIResponse, ParishBands } from './CouncilTaxAlphabeticalDirectory.types';
+export declare const exampleBands: ParishBands;
+export declare const exampleParishes: ParishAPIResponse[];
+export declare const exampleBandings: BandingAPIResponse[];

package/build/src/library/slices/CouncilTaxAlphabeticalDirectory/CouncilTaxAlphabeticalDirectory.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/library/slices/CouncilTaxAlphabeticalDirectory/CouncilTaxAlphabeticalDirectory.types.d.ts

@@ -0,0 +1,81 @@
+export interface CouncilTaxAlphabeticalDirectoryProps {
+    financialYear: string;
+    parishes: BandingAPIResponse[] | undefined;
+}
+/**
+ * The sorted parishes, grouped by first letter
+ */
+export interface SortedData {
+    /**
+     * A grouping letter
+     */
+    group: string;
+    /**
+     * An array of sorted parishes
+     */
+    children: SortedParish[];
+}
+/**
+ * The sorted parish with title and bands
+ */
+export interface SortedParish {
+    /**
+     * The banding_parish title
+     */
+    title: string;
+    /**
+     * An object of Parish Bands
+     */
+    values: ParishBands;
+}
+/**
+ * The council tax bands a-h
+ */
+export interface ParishBands {
+    a: string;
+    b: string;
+    c: string;
+    d: string;
+    e: string;
+    f: string;
+    g: string;
+    h: string;
+}
+/**
+ * The raw parish returned from the API
+ */
+export interface ParishAPIResponse {
+    /**
+     * The banding parish title
+     */
+    banding_parish: string;
+    /**
+     * An object of Parish Bands
+     */
+    bands: ParishBands;
+    /**
+     * The parish code
+     */
+    code: string;
+    /**
+     * The official parish title
+     */
+    official_parish: string;
+    /**
+     * The unitary council name, such as 'West' or 'North'
+     */
+    unitary: string;
+}
+/**
+ * The raw banding data from the API
+ */
+export interface BandingAPIResponse {
+    /**
+     * The parish name
+     */
+    parish: string;
+    /**
+     * An object of Parish Bands
+     */
+    bands: ParishBands;
+}

package/build/src/library/slices/Divider/Divider.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { DividerProps } from "./Divider.types";
+declare const Divider: React.FC<DividerProps>;
+export default Divider;

package/build/src/library/slices/Divider/Divider.types.d.ts

@@ -0,0 +1,2 @@
+export interface DividerProps {
+}

package/build/src/library/slices/DownloadableFiles/DownloadableFiles.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { DownloadableFilesProps } from "./DownloadableFiles.types";
+declare const DownloadableFiles: React.FC<DownloadableFilesProps>;
+export default DownloadableFiles;

package/build/src/library/slices/DownloadableFiles/DownloadableFiles.types.d.ts

@@ -0,0 +1,7 @@
+import { FileDownloadProps } from '../../components/FileDownload/FileDownload.types';
+export interface DownloadableFilesProps {
+    /**
+     * An array of downloadable files
+     */
+    files: Array<FileDownloadProps>;
+}

package/build/src/library/slices/GoogleMap/GoogleMap.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { GoogleMapProps } from './GoogleMap.types';
+/**
+ * A responsive Google Maps embed
+ */
+declare const GoogleMap: React.FunctionComponent<GoogleMapProps>;
+export default GoogleMap;

package/build/src/library/slices/GoogleMap/GoogleMap.storydata.d.ts

@@ -0,0 +1,44 @@
+export declare const GoogleMapWithTitleAndDescription: {
+    allowCookies: boolean;
+    title: string;
+    description: string;
+    link_title: string;
+    link_url: string;
+    iframe_html: string;
+};
+export declare const GoogleMapWithTitleOnly: {
+    title: string;
+    link_title: string;
+    link_url: string;
+    iframe_html: string;
+    allowCookies: boolean;
+};
+export declare const GoogleMapNoTitleOrDescription: {
+    link_title: string;
+    link_url: string;
+    iframe_html: string;
+    allowCookies: boolean;
+};
+export declare const GoogleMapWithTitleAndDescriptionDataWithoutCookies: {
+    allowCookies: boolean;
+    title: string;
+    description: string;
+    link_title: string;
+    link_url: string;
+    iframe_html: string;
+};
+export declare const GoogleMapWithTitleAndDescriptionDataAutodetectCookies: {
+    title: string;
+    description: string;
+    link_title: string;
+    link_url: string;
+    iframe_html: string;
+};
+export declare const GoogleMapWithInvalidLinks: {
+    title: string;
+    description: string;
+    link_title: string;
+    link_url: string;
+    iframe_html: string;
+    allowCookies: boolean;
+};

package/build/src/library/slices/GoogleMap/GoogleMap.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/library/slices/GoogleMap/GoogleMap.types.d.ts

@@ -0,0 +1,28 @@
+export interface GoogleMapProps {
+    /**
+     * Title text. Optional.
+     */
+    title?: string;
+    /**
+     * The description text displayed under the title and above the map. Optional.
+     */
+    description?: string;
+    /**
+     * The map's iframe code as provide by the 'Embed a map' sharing option on Google Maps.
+     * Used if cookies have been accepted.
+     */
+    iframe_html: string;
+    /**
+     * The map's URL as provided by the 'Send a link' sharing option on Google Maps.
+     * Used if cookies have not been accepted; a link will be displayed instead of an embed.
+     */
+    link_url: string;
+    /**
+     * Title for the link used if cookies were not accepted. Optional.
+     */
+    link_title?: string;
+    /**
+     * Allow overriding if cookies are allowed (for stories).
+     */
+    allowCookies?: boolean;
+}

package/build/src/library/slices/Image/Image.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { ImageProps } from './Image.types';
+/**
+ * Responsive image slice component that allows 4 by 3 or 16 by 9 images
+ * with an optional caption.
+ */
+declare const Image: React.FunctionComponent<ImageProps>;
+export default Image;

package/build/src/library/slices/Image/Image.storydata.d.ts

@@ -0,0 +1,2 @@
+import { ImageProps } from './Image.types';
+export declare const ImageWithCaption: ImageProps;

package/build/src/library/slices/Image/Image.test.d.ts

@@ -0,0 +1 @@
+export {};