@nnc-digital/nnc-design-system 0.4.3

package/build/library/structure/PageSidebar/PageSidebar.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { PageSidebarProps } from "./PageSidebar.types";
+/**
+ * A container for holding the main content of a page
+ */
+declare const PageSidebar: React.FC<PageSidebarProps>;
+export default PageSidebar;

package/build/library/structure/PageSidebar/PageSidebar.types.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface PageSidebarProps {
+    /**
+     * All children content within the page
+     */
+    children: React.ReactNode;
+}

package/build/library/structure/PageStructures.d.ts

@@ -0,0 +1,42 @@
+import AccessibleLinks from './AccessibleLinks/AccessibleLinks';
+import AlertBanner from './AlertBanner/AlertBanner';
+import AlertBannerService from './AlertBannerService/AlertBannerService';
+import BackLink from './BackLink/BackLink';
+import Breadcrumbs from './Breadcrumbs/Breadcrumbs';
+import Contents from './Contents/Contents';
+import ContentsNavigation from './ContentsNavigation/ContentsNavigation';
+import CookieBanner from './CookieBanner/CookieBanner';
+import DisplayDate from './DisplayDate/DisplayDate';
+import Footer from './Footer/Footer';
+import FullWidthContainer from './FullWidthContainer/FullWidthContainer';
+import Header from './Header/Header';
+import HeroImage from './HeroImage/HeroImage';
+import HomeHero from './HomeHero/HomeHero';
+import MaxWidthContainer from './MaxWidthContainer/MaxWidthContainer';
+import MemorialHero from './MemorialHero/MemorialHero';
+import NewsArticleDate from './NewsArticleDate/NewsArticleDate';
+import NewsArticleFeaturedBlock from './NewsArticleFeaturedBlock/NewsArticleFeaturedBlock';
+import NewsArticleFilterAccordion from './NewsArticleFilterAccordion/NewsArticleFilterAccordion';
+import NewsArticleImage from './NewsArticleImage/NewsArticleImage';
+import NewsArticleList from './NewsArticleList/NewsArticleList';
+import NewsArticleListHeader from './NewsArticleListHeader/NewsArticleListHeader';
+import NewsArticleOldBanner from './NewsArticleOldBanner/NewsArticleOldBanner';
+import PageMain from './PageMain/PageMain';
+import PageSidebar from './PageSidebar/PageSidebar';
+import PageTitle from './PageTitle/PageTitle';
+import PageWithSidebarContainer from './PageWithSidebarContainer/PageWithSidebarContainer';
+import PageWrapper from './PageWrapper/PageWrapper';
+import PhaseBanner from './PhaseBanner/PhaseBanner';
+import PromoBanner from './PromoBanner/PromoBanner';
+import PromoBlock from './PromoBlock/PromoBlock';
+import Searchbar from './Searchbar/Searchbar';
+import SearchResultsList from './SearchResultsList/SearchResultsList';
+import SectionLinks from './SectionLinks/SectionLinks';
+import SectionLinksMobileContents from './SectionLinksMobileContents/SectionLinksMobileContents';
+import SectionLinksSidebar from './SectionLinksSidebar/SectionLinksSidebar';
+import ServiceLinksBoxed from './ServicesLinksBoxed/ServicesLinksBoxed';
+import ServicesLinksList from './ServicesLinksList/ServicesLinksList';
+import SignpostLinks from './SignpostLinks/SignpostLinks';
+import SkipToMainContent from './SkipToMainContent/SkipToMainContent';
+import Summary from './Summary/Summary';
+export { AccessibleLinks, AlertBanner, AlertBannerService, BackLink, Breadcrumbs, Contents, ContentsNavigation, CookieBanner, DisplayDate, Footer, FullWidthContainer, Header, HeroImage, HomeHero, MaxWidthContainer, MemorialHero, NewsArticleDate, NewsArticleFeaturedBlock, NewsArticleFilterAccordion, NewsArticleImage, NewsArticleList, NewsArticleListHeader, NewsArticleOldBanner, PhaseBanner, PageMain, PageSidebar, PageTitle, PageWithSidebarContainer, PageWrapper, PromoBanner, PromoBlock, Searchbar, SearchResultsList, SectionLinks, SectionLinksMobileContents, SectionLinksSidebar, ServiceLinksBoxed, ServicesLinksList, SignpostLinks, SkipToMainContent, Summary, };

package/build/library/structure/PageTitle/PageTitle.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { PageTitleProps } from "./PageTitle.types";
+/**
+ * A container for holding the main content of a page
+ */
+declare const PageTitle: React.FC<PageTitleProps>;
+export default PageTitle;

package/build/library/structure/PageTitle/PageTitle.types.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+export interface PageTitleProps {
+    /**
+     * Any unique class names to apply to the page container
+     */
+    classes?: string;
+    /**
+     * The PageTitle contents
+     */
+    children?: React.ReactNode;
+}

package/build/library/structure/PageWithSidebarContainer/PageWithSidebarContainer.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { PageWithSidebarContainerProps } from "./PageWithSidebarContainer.types";
+/**
+ * A container for holding the main content of a page
+ */
+declare const PageWithSidebarContainer: React.FC<PageWithSidebarContainerProps>;
+export default PageWithSidebarContainer;

package/build/library/structure/PageWithSidebarContainer/PageWithSidebarContainer.types.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+export interface PageWithSidebarContainerProps {
+    /**
+     * Rare occassions trhe sidebar is on the left
+     */
+    sidebarLeft?: boolean;
+    /**
+     * All children content within the page
+     */
+    children: React.ReactNode;
+}

package/build/library/structure/PageWrapper/PageWrapper.d.ts

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

package/build/library/structure/PageWrapper/PageWrapper.types.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+export interface PageWrapperProps {
+    /**
+     *
+     */
+    children: React.ReactNode;
+    /**
+     * which background colour from the theme to choose
+     */
+    colour: string;
+}

package/build/library/structure/PhaseBanner/PhaseBanner.d.ts

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

package/build/library/structure/PhaseBanner/PhaseBanner.types.d.ts

@@ -0,0 +1,3 @@
+export interface PhaseBannerProps {
+    isHome?: boolean;
+}

package/build/library/structure/PromoBanner/PromoBanner.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { PromoBannerProps } from './PromoBanner.types';
+/**
+ * Promotional banner used as the first wide line in a promotional block,
+ * incorporated within PromoBlock use.
+ */
+declare const PromoBanner: React.FunctionComponent<PromoBannerProps>;
+export default PromoBanner;

package/build/library/structure/PromoBanner/PromoBanner.storydata.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+export declare const PromoBannerContentText = "We\u2019re looking for people to do this amazing thing in an amazing manner, during an amazing time of amazingness.";
+export declare const PromoBannerContent: JSX.Element;
+export declare const PromoBannerData: {
+    title: string;
+    ctaUrl: string;
+    ctaText: string;
+    image1440x810: string;
+    image144x81: string;
+};

package/build/library/structure/PromoBanner/PromoBanner.types.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="react" />
+export interface PromoBannerProps {
+    /**
+     * Title of the promo banner
+     */
+    title: string;
+    /**
+     * Call to action text
+     */
+    ctaText: string;
+    /**
+     * Call to action url
+     */
+    ctaUrl: string;
+    /**
+     * The url of the image
+     */
+    image1440x810: string;
+    /**
+     * The url of the image in 10x smaller for lazy loading
+     */
+    image144x81: string;
+    /**
+     * The children used for the text section of the promo banner
+     */
+    children: React.ReactNode;
+}

package/build/library/structure/PromoBlock/PromoBlock.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { PromoBlockProps } from './PromoBlock.types';
+/**
+ * Promotional campaign block, showing a tile for each campaign, similar to news article featured block.
+ * Note that the main promotional campaign is to be displayed above these in a PromoBanner.
+ */
+declare const PromoBlock: React.FunctionComponent<PromoBlockProps>;
+export default PromoBlock;

package/build/library/structure/PromoBlock/PromoBlock.storydata.d.ts

@@ -0,0 +1,5 @@
+import { PromoProps } from './PromoBlock.types';
+/**
+ * Example data for the PromoBlock stories
+ */
+export declare const PromoBlocksData: Array<PromoProps>;

package/build/library/structure/PromoBlock/PromoBlock.types.d.ts

@@ -0,0 +1,36 @@
+export interface PromoBlockProps {
+    /**
+     * The promo tiles to show
+     */
+    promos: Array<PromoProps>;
+}
+export interface PromoProps {
+    /**
+     * The title of the promo
+     */
+    title: string;
+    /**
+     * Basic HTML content (no embedded slices) for the promo main body
+     */
+    content: string;
+    /**
+     * Text for the call to action link
+     */
+    callToActionText: string;
+    /**
+     * URL for the call to action link
+     */
+    callToActionURL: string;
+    /**
+     * Medium image (larger only used by main promo banner)
+     */
+    imageMedium: string;
+    /**
+     * Small placeholder image for lazy loading medium image
+     */
+    imageSmall: string;
+    /**
+     * Alt text for image
+     */
+    imageAltText?: string;
+}

package/build/library/structure/SearchHeader/SearchHeader.d.ts

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

package/build/library/structure/SearchHeader/SearchHeader.types.d.ts

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

package/build/library/structure/SearchResultsList/SearchResultsList.d.ts

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

package/build/library/structure/SearchResultsList/SearchResultsList.types.d.ts

@@ -0,0 +1,45 @@
+import { SignpostLinkProp } from '../../components/SignpostLinksList/SignpostLinksList.types';
+export interface SearchResultsListProps {
+    /**
+     * What you searched for
+     */
+    searchTerm: string;
+    /**
+     * Array of results
+     */
+    results: Array<SearchResultProps>;
+    /**
+     * The total number of results
+     */
+    totalResults?: number;
+    /**
+     * The current page number
+     */
+    pageNumber?: number;
+}
+export 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>;
+    /**
+     * Optional override for the top line of text
+     */
+    TopLineText?: string;
+    /**
+     * If there is a service area tied to the result
+     */
+    service?: string;
+}

package/build/library/structure/Searchbar/Searchbar.d.ts

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

package/build/library/structure/Searchbar/Searchbar.types.d.ts

@@ -0,0 +1,48 @@
+export interface SearchbarProps {
+    /**
+     * ID passed to the Autocomplete component
+     */
+    id?: string;
+    /**
+     * The searched for term
+     */
+    searchTerm?: string;
+    /**
+     * Placeholder text
+     */
+    placeholder?: string;
+    /**
+     * Whether or not this is the light version of the search
+     */
+    isLight?: boolean;
+    /**
+     * If used on it's own (eg search results page) then will be slightly larger
+     */
+    isLarge?: boolean;
+    /**
+     * Array of suggestion strings for autocomplete input
+     */
+    suggestions?: string[];
+    /**
+     * The minimum number of characters that need to be typed before matches in the suggestions list are looked for
+     */
+    minimumMatchLength?: number;
+    /**
+     * The maximum number of matched suggestions shown in the dropdown list
+     */
+    maximumMatchesShown?: number;
+    /**
+    * Where to post the form submission to and what params to use
+    */
+    submitInfo?: SubmitInfoProps;
+}
+export interface SubmitInfoProps {
+    /**
+     * Where we're posting the form to eg /search or /news
+     */
+    postTo: string;
+    /**
+     * Any additional parameters to send
+     */
+    params: object;
+}

package/build/library/structure/SectionLinks/SectionLinks.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { SectionLinksProps } from './SectionLinks.types';
+/**
+ * Display a list of links for a section with optional images
+ */
+declare const SectionLinks: React.FunctionComponent<SectionLinksProps>;
+export default SectionLinks;

package/build/library/structure/SectionLinks/SectionLinks.storydata.d.ts

@@ -0,0 +1,2 @@
+import { PageLinkProp } from './SectionLinks.types';
+export declare const pageLinksArray: PageLinkProp[];

package/build/library/structure/SectionLinks/SectionLinks.types.d.ts

@@ -0,0 +1,52 @@
+export interface SectionLinksProps {
+    /**
+     * The title of the section
+     */
+    sectionTitle: string;
+    /**
+     * If there is only one section then do not display the title
+     */
+    displayTitle?: boolean;
+    /**
+     * A url slug for the section title
+     */
+    sectionSlug: string;
+    /**
+     * An array of page links that sit under this section
+     */
+    pageLinksArray: Array<PageLinkProp>;
+    /**
+     * Should the section links have images
+     */
+    hasImages?: boolean;
+}
+export interface PageLinkProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * Summary of the page
+     */
+    summary: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+    /**
+     * Is the link to an external website?
+     */
+    isExternal?: boolean;
+    /**
+     * The small image url
+     */
+    imageSmall?: string | null;
+    /**
+     * The large image url
+     */
+    imageLarge?: string | null;
+    /**
+     * The image alt text
+     */
+    imageAltText?: string | null;
+}

package/build/library/structure/SectionLinksMobileContents/SectionLinksMobileContents.d.ts

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

package/build/library/structure/SectionLinksMobileContents/SectionLinksMobileContents.types.d.ts

@@ -0,0 +1,16 @@
+export interface SectionLinksMobileContentsProps {
+    /**
+    * An array of the SectionLinksMobileContents, each with a title and a URL not including the current page users are on
+    */
+    sectionLinksArray: Array<SectionProp>;
+}
+export interface SectionProp {
+    /**
+    * Title of the section
+    */
+    title: string;
+    /**
+    * ID slug of the section
+    */
+    id: string;
+}

package/build/library/structure/SectionLinksSidebar/SectionLinksSidebar.d.ts

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

package/build/library/structure/SectionLinksSidebar/SectionLinksSidebar.types.d.ts

@@ -0,0 +1,34 @@
+export interface SectionLinksSidebarProps {
+    /**
+     * Title
+     */
+    Title: string;
+    /**
+     * An array of sections
+     */
+    Sections: Array<SectionsProps>;
+}
+export interface SectionsProps {
+    /**
+     * The optional section title
+     */
+    SectionTitle?: string;
+    /**
+     * The array of section links
+     */
+    SectionLinks: Array<LinksProp>;
+}
+export interface LinksProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+    /**
+     * Is this the current page
+     */
+    isCurrent?: boolean;
+}

package/build/library/structure/ServicesLinksBoxed/ServicesLinksBoxed.d.ts

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

package/build/library/structure/ServicesLinksBoxed/ServicesLinksBoxed.storydata.d.ts

@@ -0,0 +1,9 @@
+export declare const serviceLinksArray: {
+    title: string;
+    url: string;
+    iconKey: string;
+    quickLinksArray: {
+        title: string;
+        url: string;
+    }[];
+}[];

package/build/library/structure/ServicesLinksBoxed/ServicesLinksBoxed.types.d.ts

@@ -0,0 +1,53 @@
+export interface ServiceLinksBoxedProps {
+    /**
+     * An array of all the top level service landing pages
+     */
+    serviceLinksArray: Array<PageLinkProp>;
+    /**
+     * Id of container
+     */
+    serviceId?: string;
+}
+export interface PageLinkProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+    /**
+     * The key of the icon
+     */
+    iconKey?: string;
+    /**
+     * Array of quick links for the service
+     */
+    quickLinksArray?: Array<QuickLinkProp>;
+    quickLinksShow?: boolean;
+}
+export interface QuickLinkProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+}
+export interface MemorialQuickLinkProp {
+    /**
+     * The key of the icon
+     */
+    iconKey?: string;
+    /**
+     * An array of Quick Links
+     */
+    link: Array<QuickLinkProp>;
+    /**
+     * Some summary text
+     */
+    summary: string;
+}

package/build/library/structure/ServicesLinksList/ServicesLinksList.d.ts

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

package/build/library/structure/ServicesLinksList/ServicesLinksList.types.d.ts

@@ -0,0 +1,68 @@
+export interface ServicesLinksListProps {
+    /**
+     * An array of all the top level service landing pages
+     */
+    serviceLinksArray: Array<PageLinkProp>;
+    /**
+     * Display a white background on each block
+     */
+    hasBackground?: boolean;
+    /**
+     * Hide the header
+     */
+    hideHeader?: boolean;
+    /**
+     * Show everything in a single column
+     */
+    oneCol?: boolean;
+    /**
+     * Id of container
+     */
+    serviceId?: string;
+    /**
+     * Should the view be boxed
+     */
+    isBoxed?: boolean;
+}
+export interface PageLinkProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+    /**
+     * The key of the icon
+     */
+    iconKey?: string;
+    /**
+     * Array of quick links for the service
+     */
+    quickLinksArray?: Array<QuickLinkProp>;
+}
+export interface QuickLinkProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+}
+export interface MemorialQuickLinkProp {
+    /**
+     * The key of the icon
+     */
+    iconKey?: string;
+    /**
+     * An array of Quick Links
+     */
+    link: Array<QuickLinkProp>;
+    /**
+     * Some summary text
+     */
+    summary: string;
+}

package/build/library/structure/SignpostLinks/SignpostLinks.d.ts

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

package/build/library/structure/SignpostLinks/SignpostLinks.types.d.ts

@@ -0,0 +1,32 @@
+export interface SignpostLinksProps {
+    /**
+     * Optional override for the top line of text
+     */
+    TopLineText?: string;
+    /**
+    * An array of the SignpostLinks
+    */
+    signpostLinksArray: Array<SignpostLinkProp>;
+    /**
+     * Optional, but recommended - a link to send the user to the other council's (West or North) specific service page, defaults to the homepage
+     */
+    otherCouncilLink?: string;
+}
+export interface SignpostLinkProp {
+    /**
+    * The number that represents the local area - based on the list of all local areas in alphabetical order
+    */
+    sovereignCode: number;
+    /**
+    * The name of the local area
+    */
+    areaName: string;
+    /**
+     * An optional override for the call to action text
+     */
+    cta_text?: string;
+    /**
+    * URL of this service on the local area's website
+    */
+    url: string;
+}