@nnc-digital/nnc-design-system 0.4.3

package/build/library/directory/DirectoryServiceList/DirectoryServiceList.types.d.ts

@@ -0,0 +1,136 @@
+import { Dispatch, SetStateAction } from 'react';
+import { DirectoryServiceProps } from '../DirectoryService/DirectoryService.types';
+export interface DirectoryServiceListProps {
+    /**
+     * Are the ages in months? Defaults to false
+     */
+    ageInMonths?: boolean;
+    /**
+     * The base url for the directory
+     */
+    directoryPath: string;
+    /**
+     * The url to the shortlist
+     */
+    shortListPath: string;
+    /**
+     * An array of Directory Services
+     */
+    services: DirectoryServiceProps[];
+    /**
+     * The search term string
+     */
+    search?: string;
+    /**
+     * Function prop passed in to handle updating search
+     */
+    setSearch: Dispatch<SetStateAction<string>>;
+    /**
+     * The postcode search term
+     */
+    postcode?: string;
+    /**
+     * Function prop passed in to handle updating postcode
+     */
+    setPostcode: Dispatch<SetStateAction<string>>;
+    /**
+     * The total amount of results
+     */
+    totalResults?: number;
+    /**
+     * The total amount of pages
+     */
+    pageNumber?: number;
+    /**
+     * Function prop passed in to handle the update page number
+     */
+    setPageNumber: Dispatch<SetStateAction<number>>;
+    /**
+     * The number of results per page
+     */
+    perPage?: number;
+    /**
+     * The max length of each service description extract
+     */
+    extractLength?: number;
+    /**
+     * The filter categories
+     */
+    categories?: DirectoryCategory[];
+    /**
+     * Function prop passed in to handle updating categories
+     */
+    setCategories: Dispatch<SetStateAction<DirectoryCategory[]>>;
+    /**
+     * The minimum age filter
+     */
+    minimumAge?: number | string;
+    /**
+     * Function prop passed in to handle updating minimumAge
+     */
+    setMinimumAge: Dispatch<SetStateAction<number | string | undefined>>;
+    /**
+     * The maximum age filter
+     */
+    maximumAge?: number | string;
+    /**
+     * Function prop passed in to handle updating maximumAge
+     */
+    setMaximumAge: Dispatch<SetStateAction<number | string | undefined>>;
+    /**
+     *  Where to centre the map, in the format 'lat,lng'
+     */
+    mapCenter?: string;
+    /**
+     * The optional zoom level, between 1 and 20. 1 = world, 20 = buildings
+     */
+    mapZoom?: number;
+    /**
+     * Is the data loading
+     */
+    isLoading: boolean;
+    /**
+     * Does the directory have documents?
+     */
+    hasDocuments?: boolean;
+}
+export interface DirectoryCategory {
+    /**
+     * The category label
+     */
+    label: string;
+    /**
+     * The vocabulary name
+     */
+    vocabulary: string;
+    /**
+     * An array of taxonomies
+     */
+    options: DirectoryTaxonomy[];
+    /**
+     * Should multiple options be allowed
+     */
+    singleSelection: boolean;
+}
+export interface DirectoryTaxonomy {
+    /**
+     * Unique taxonomy identifier in curie format (e.g. localOffer1)
+     */
+    id: string;
+    /**
+     * The name of the taxonomy
+     */
+    name: string;
+    /**
+     * The vocabulary name
+     */
+    vocabulary: string;
+    /**
+     * The optional parent taxonomy
+     */
+    parent?: string | null;
+    /**
+     * Is the option checked
+     */
+    checked: boolean;
+}

package/build/library/directory/DirectoryShortList/DirectoryShortList.d.ts

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

package/build/library/directory/DirectoryShortList/DirectoryShortList.types.d.ts

@@ -0,0 +1,6 @@
+export interface DirectoryShortListProps {
+    /**
+     * The path of the directory
+     */
+    directoryPath: string;
+}

package/build/library/directory/ServiceContact/ServiceContact.d.ts

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

package/build/library/directory/ServiceContact/ServiceContact.types.d.ts

@@ -0,0 +1,42 @@
+export interface ServiceContactComponentProps {
+    /**
+     * The optional email address
+     */
+    email?: string;
+    /**
+     * The optional website address
+     */
+    website?: string;
+    /**
+     * An array of service contacts. May be empty.
+     */
+    contacts: ServiceContactProps[];
+}
+export interface ServiceContactProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The name of the contact
+     */
+    name: string;
+    /**
+     * The job title of the contact
+     */
+    title: string;
+    /**
+     * The array of phone numbers
+     */
+    phones: PhoneProps[];
+}
+export interface PhoneProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The telephone number
+     */
+    number: string;
+}

package/build/library/directory/ServiceSocialLinks/ServiceSocialLinks.d.ts

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

package/build/library/directory/ServiceSocialLinks/ServiceSocialLinks.storydata.d.ts

@@ -0,0 +1,2 @@
+import { ServiceSocialLinksProps } from './ServiceSocialLinks.types';
+export declare const ExampleSocialProfiles: ServiceSocialLinksProps;

package/build/library/directory/ServiceSocialLinks/ServiceSocialLinks.types.d.ts

@@ -0,0 +1,24 @@
+export interface ServiceSocialLinksProps {
+    /**
+     * An array of social links
+     */
+    profiles?: SocialProfile[];
+}
+export interface SocialProfile {
+    /**
+     * The id for the social profile
+     */
+    id: number;
+    /**
+     * The profile name
+     */
+    name: string;
+    /**
+     * The link to the profile
+     */
+    link: string;
+    /**
+     * The social network name
+     */
+    social_network: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'youtube';
+}

package/build/library/helpers/UseLocalStorage.d.ts

@@ -0,0 +1,2 @@
+declare const useLocalStorage: (key: any, initialValue: any) => any[];
+export default useLocalStorage;

package/build/library/helpers/api-helpers.d.ts

@@ -0,0 +1,120 @@
+export declare const PostcodeSearchApiUrl: string;
+export interface PostcodeResultsProps {
+    /**
+     * An array of addresses
+     */
+    addresses: AddressProps[];
+    /**
+     * The postcode searched for
+     */
+    postcode: string;
+    /**
+     * Quantity of records in this payload
+     */
+    records_in_payload: number;
+    /**
+     * The requested page
+     */
+    requested_page: number;
+    /**
+     * The total number of pages
+     */
+    total_pages: number;
+    /**
+     * The total number of records
+     */
+    total_records: number;
+    /**
+     * An array of sovereigns
+     */
+    sovereigns: SovereignProps[];
+    /**
+     * An array of Unitaries
+     */
+    unitaries: UnitaryProps[];
+}
+export interface SovereignProps {
+    /**
+     * The sovereign name
+     */
+    name: string;
+    /**
+     * The optional website
+     */
+    website?: string;
+}
+export interface UnitaryProps {
+    /**
+     * The Unitary council name
+     */
+    name: string;
+}
+export interface AddressProps {
+    /**
+     * Council tax bands
+     */
+    bands: CouncilTaxBands;
+    /**
+     * The address as a one line string
+     */
+    single_line_address: string;
+    /**
+     * Latitude of the address
+     */
+    latitude: string;
+    /**
+     * Longitude of the address
+     */
+    longitude: string;
+    /**
+     * The parish
+     */
+    parish: string;
+    /**
+     * The polling district
+     */
+    polling_district: string;
+    /**
+     * The postcode
+     */
+    postcode: string;
+    /**
+     * The postcode without spaces
+     */
+    postcodens: string;
+    /**
+     * The sovereign council name
+     */
+    sovereign: string;
+    /**
+     * The unitary council name
+     */
+    unitary: string;
+    /**
+     * The Unique Property Reference Number
+     */
+    uprn: string;
+    /**
+     * The ward
+     */
+    ward: string;
+    /**
+     * The website url
+     */
+    website_url: string;
+}
+export interface AddressesProps {
+    title: string;
+    value: string;
+    extra?: AddressProps;
+}
+export interface CouncilTaxBands {
+    a: string;
+    b: string;
+    c: string;
+    d: string;
+    e: string;
+    f: string;
+    g: string;
+    h: string;
+}

package/build/library/pages/ContentPage/ContentPage.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export interface ContentPageProps {
+}
+export declare const ContentPage: React.FunctionComponent<ContentPageProps>;

package/build/library/pages/ContentPage/ContentPage.storydata.d.ts

@@ -0,0 +1,10 @@
+/** Example story data for Content Page example */
+export declare const smallTable: {
+    caption: string;
+    headings: string[];
+    data: string[][];
+};
+export declare const largeTable: {
+    caption: string;
+    headings: string[];
+};

package/build/library/pages/CouncilTaxPageExample/CouncilTaxPageExample.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export interface CouncilTaxPageExampleProps {
+    version: string;
+}
+export declare const CouncilTaxPageExample: React.FC<CouncilTaxPageExampleProps>;

package/build/library/pages/CouncilTaxParishPageExample/CouncilTaxParishPageExample.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export interface CouncilTaxParishPageExampleProps {
+    version: string;
+}
+export declare const CouncilTaxParishPageExample: React.FC<CouncilTaxParishPageExampleProps>;

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

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

package/build/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/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/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/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/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/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/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/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/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/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/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/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>;