@nnc-digital/nnc-design-system 0.4.3

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

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

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

@@ -0,0 +1,6 @@
+export interface BackLinkProps {
+    /**
+     * What is this?
+     */
+    link: string;
+}

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

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

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

@@ -0,0 +1,20 @@
+export interface BreadcrumbsProps {
+    /**
+     * An array of the breadcrumbs, each with a title and a URL not including the current page users are on
+     */
+    breadcrumbsArray: Array<BreadcrumbProp>;
+    /**
+     * Should the breadcrumbs have bottom margin
+     */
+    hasMargin?: boolean;
+}
+export interface BreadcrumbProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+}

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

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

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

@@ -0,0 +1,2 @@
+import { ContentLink } from './Contents.types';
+export declare const ContentsExampleData: ContentLink[];

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

@@ -0,0 +1,24 @@
+export interface ContentsProps {
+    /**
+     * An array of content links
+     */
+    contents: ContentLink[];
+    /**
+     * The optional current path
+     */
+    currentPath?: string;
+    /**
+     * The optional contents title, defaults to 'Contents'
+     */
+    title?: string;
+}
+export interface ContentLink {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+}

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

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

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

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

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

@@ -0,0 +1,31 @@
+/// <reference types="react" />
+export interface CookieBannerProps {
+    /**
+     * Title of cookie banner
+     */
+    title: string;
+    /**
+     * Paragraph about cookies
+     */
+    paragraph: React.ReactNode;
+    /**
+     * Accept all button text
+     */
+    acceptButtonText: string;
+    /**
+     * Confirmation of acceptance text
+     */
+    acceptConfirmationText?: string;
+    /**
+     * Reject all button text
+     */
+    rejectButtonText: string;
+    /**
+     * Confirmation of rejection text
+     */
+    rejectConfirmationText?: string;
+    /**
+     * gets called on accept - lets you do extra things - like set the 🍪
+     */
+    acceptCallback?: Function;
+}

package/build/library/structure/CookieBanner/CookieClear.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+interface CookieClearProps {
+}
+declare const CookieBanner: React.FunctionComponent<CookieClearProps>;
+export default CookieBanner;

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { DisplayDateProps } from "./DisplayDate.types";
+/**
+ * Form element - hint text
+ */
+declare const DisplayDate: React.FC<DisplayDateProps>;
+export default DisplayDate;

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

@@ -0,0 +1,18 @@
+export interface DisplayDateProps {
+    /**
+     * The text in the hint
+     */
+    text: string;
+    /**
+     * The format for the date - default it timestamp
+     */
+    format: string;
+    /**
+     * Text before the date (no spaces included on render in case you need a colon: before the date)
+     */
+    preText?: string;
+    /**
+     * Text after the date
+     */
+    postText?: string;
+}

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

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

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

@@ -0,0 +1,24 @@
+export interface FooterProps {
+    /**
+     * An array of links for the bottom of the footer, for things like cookie and privacy policies
+     */
+    footerLinksArray?: Array<FooterLinkProp>;
+    /**
+     * The year for the copyright
+     */
+    year?: string;
+}
+export interface FooterLinkProp {
+    /**
+    * Title of the link
+    */
+    title: string;
+    /**
+    * URL of the link
+    */
+    url: string;
+    /**
+    * Is the link to an external website?
+    */
+    isExternal?: boolean;
+}

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { FullWidthContainerProps } from './FullWidthContainer.types';
+/**
+ * A Full Width Container with optional padding and background
+ */
+declare const FullWidthContainer: React.FunctionComponent<FullWidthContainerProps>;
+export default FullWidthContainer;

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

@@ -0,0 +1,15 @@
+import React from 'react';
+export interface FullWidthContainerProps {
+    /**
+     * Show background colour when true
+     */
+    hasBackground?: boolean;
+    /**
+     * Show top and bottom padding when true
+     */
+    hasPadding?: boolean;
+    /**
+     * The FullWidthContainer contents
+     */
+    children?: React.ReactNode;
+}

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { HeaderProps } from './Header.types';
+/**
+ * The header that should appear at the top of every page.
+ */
+declare const Header: React.FunctionComponent<HeaderProps>;
+export default Header;

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

@@ -0,0 +1,31 @@
+/// <reference types="react" />
+export interface HeaderProps {
+    /**
+     * Hide the searchbar, set to true on the search page so there aren't two search inputs.
+     */
+    hideSearchBar?: boolean;
+    /**
+     * Link to the root of the website that will be used on the logo
+     */
+    homeLink?: string;
+    /**
+     * Set to true to include a link to /news in the header
+     */
+    hasNewsLink?: boolean;
+    /**
+     * Link to the list of all services displayed at top right (#all-services anchor added to this)
+     */
+    allServicesLink?: string;
+    /**
+     * This flag is used to alter the all-services link to an in-page anchor if true
+     */
+    isHomepage?: boolean;
+    /**
+     * Array of suggestions for the autocomplete input in the search bar
+     */
+    searchSuggestions?: string[];
+    /**
+     * The Header contents
+     */
+    children?: React.ReactNode;
+}

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import { HeroImageProps } from './HeroImage.types';
+/**
+ * Hero image banner with optional text and call to action with varying presentation of text area.
+ * For optional use at the top of a service landing page, if set in the CMS.
+ */
+declare const HeroImage: React.FunctionComponent<HeroImageProps>;
+export default HeroImage;

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

@@ -0,0 +1,6 @@
+import { HeroImageProps } from './HeroImage.types';
+export declare const HeroImageExampleBoxedData: HeroImageProps;
+export declare const HeroImageExampleGradientData: HeroImageProps;
+export declare const HeroImageExampleMicroSiteData: HeroImageProps;
+export declare const HeroImageExampleBoxedWithBreadcrumbData: HeroImageProps;
+export declare const HeroImageExampleBoxedWithCustomSearch: HeroImageProps;

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

@@ -0,0 +1,48 @@
+import { CustomSearchProps } from '../../components/CustomSearch/CustomSearch.types';
+import { BreadcrumbProp } from '../Breadcrumbs/Breadcrumbs.types';
+export interface HeroImageProps {
+    /**
+     * Headline text, optional. Intention to use page title if missing.
+     */
+    headline?: string;
+    /**
+     * Any text after the headline and before the call to action, optional
+     */
+    content?: string;
+    /**
+     * URL of the hero image (min 400pix high)
+     */
+    imageLarge: string;
+    /**
+     * URL of the a smaller version of the image for lazy loading
+     */
+    imageSmall: string;
+    /**
+     * Optional alt text for the image - ideally the image should be decorative only and not require a long description
+     */
+    imageAltText?: string;
+    /**
+     * Optional call to action text
+     */
+    callToActionText?: string;
+    /**
+     * Optional call to action link URL
+     */
+    callToActionURL?: string;
+    /**
+     * Is the call to action a primary button
+     */
+    callToActionIsPrimary?: boolean;
+    /**
+     * Set to true to put the text and call to action on a white box, false to overlay on a darkened image
+     */
+    backgroundBox: boolean;
+    /**
+     * An optional breadcrumb. If not set then the breadcrumb is not shown
+     */
+    breadcrumb?: BreadcrumbProp;
+    /**
+     * An optional custom search
+     */
+    customSearch?: CustomSearchProps;
+}

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { HomeHeroProps } from './HomeHero.types';
+/**
+ * The Hero that should appear at the top of the home page.
+ */
+declare const HomeHero: React.FunctionComponent<HomeHeroProps>;
+export default HomeHero;

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

@@ -0,0 +1,14 @@
+/**
+ * Example data for the HomeHero stories
+ */
+export declare const HomeHeroCommon: {
+    searchSuggestions: string[];
+    imagesArray: {
+        image1440x810: string;
+        image144x81: string;
+    }[];
+};
+export declare const HomeHeroPromotedLinks: {
+    title: string;
+    url: string;
+}[];

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

@@ -0,0 +1,54 @@
+export interface HomeHeroProps {
+    /**
+     * The line of text before the logo
+     */
+    topline?: string;
+    /**
+     * URL of an alternative logo to override the preset ones (520 x 150 px)
+     */
+    imageOverrideLogo?: string;
+    /**
+     * Alt text for overridden logo
+     */
+    imageOverrideLogoAltText?: string;
+    /**
+    * The line of text after the logo
+    */
+    strapline?: string;
+    /**
+     * The images for the hero, minimum of one
+     */
+    imagesArray: Array<HeroImageProp>;
+    /**
+     * The main promoted links, an array that should be from 1-4, preferably 3
+     */
+    promotedLinksArray: Array<PromotedLinkProp>;
+    /**
+     * Array of suggestion strings for autocomplete search input
+     */
+    searchSuggestions?: string[];
+}
+export interface HeroImageProp {
+    /**
+     * The url of the image
+     */
+    image1440x810: string;
+    /**
+     * The url of the image in 10x smaller for lazy loading
+     */
+    image144x81: string;
+    /**
+     * Optional alt text for the image - this should only be included if the image contains content that is important to users and not purely decorative
+     */
+    imageAltText?: string;
+}
+export interface PromotedLinkProp {
+    /**
+     * The title of the link
+     */
+    title: string;
+    /**
+     * The url of the link
+     */
+    url: string;
+}

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

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

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

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+export interface MaxWidthContainerProps {
+    /**
+     * Any unique class names to apply to the page container outer div
+     */
+    classes?: string;
+    /**
+     * Remove background colour
+     */
+    noBackground?: boolean;
+    /**
+     * Remove bottom padding
+     */
+    noPadding?: boolean;
+    /**
+     * Allow overflow to be visible in inner div (only makes sense with padding allowed)
+     */
+    overflowVisible?: boolean;
+    /**
+     * The MaxWidthContainer contents
+     */
+    children?: React.ReactNode;
+}

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

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

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

@@ -0,0 +1,27 @@
+import React from "react";
+export interface MemorialHeroProps {
+    /**
+   * Full sized image
+   */
+    src: string;
+    /**
+     * smaller version as a placeholder for lazy loading
+     */
+    placeholder: string;
+    /**
+     * Alt text for hero
+     */
+    alt: string;
+    /**
+     * The name of the sites theme
+     */
+    theme: object;
+    /**
+     * Pass through any children to be shown
+     */
+    children: React.ReactNode;
+    /**
+     * Anthing in this section will be themed as defined
+     */
+    councilServices: React.ReactNode;
+}

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { NewsArticleDateProps } from "./NewsArticleDate.types";
+/**
+ * Form element - hint text
+ */
+declare const NewsArticleDate: React.FC<NewsArticleDateProps>;
+export default NewsArticleDate;

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

@@ -0,0 +1,10 @@
+export interface NewsArticleDateProps {
+    /**
+     * The text in the hint
+     */
+    text: string;
+    /**
+     * The format for the date
+     */
+    format?: string;
+}

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { NewsArticleFeaturedBlockProps } from './NewsArticleFeaturedBlock.types';
+/**
+ * Block displaying up to 9 news article tiles, with image, title and date for each
+ */
+declare const NewsArticleFeaturedBlock: React.FunctionComponent<NewsArticleFeaturedBlockProps>;
+export default NewsArticleFeaturedBlock;

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

@@ -0,0 +1,23 @@
+export interface NewsArticleFeaturedBlockProps {
+    /**
+     * Array of news article data
+     */
+    articles: Array<NewsArticleProps>;
+    /**
+     * Optionally do not display the title
+     */
+    withoutTitle?: boolean;
+    /**
+     * Optionally add a button to view all news
+     */
+    viewAllLink?: string;
+}
+export interface NewsArticleProps {
+    id: string;
+    url: string;
+    title: string;
+    date: number;
+    image720x405: string;
+    image72x41: string;
+    imageAltText?: string;
+}

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

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

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

@@ -0,0 +1,7 @@
+import { AccordionSectionProps } from '../../slices/Accordion/Accordion.types';
+export interface NewsArticleFilterAccordionProps {
+    /**
+     * What is this?
+     */
+    sections: Array<AccordionSectionProps>;
+}

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { NewsArticleImageProps } from "./NewsArticleImage.types";
+/**
+ * Form element - hint text
+ */
+declare const NewsArticleImage: React.FC<NewsArticleImageProps>;
+export default NewsArticleImage;

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

@@ -0,0 +1,18 @@
+export interface NewsArticleImageProps {
+    /**
+     * The url of the image
+     */
+    image1440x810: string;
+    /**
+     * The url of the image in 10x smaller for lazy loading
+     */
+    image144x81: string;
+    /**
+     * Optional alt text for the image - this should only be included if the image contains content that is important to users and not purely decorative
+     */
+    imageAltText?: string;
+    /**
+     * An optional caption to be presented underneath the image
+     */
+    imageCaption?: string;
+}

package/build/library/structure/NewsArticleList/NewsArticleData.d.ts

@@ -0,0 +1,7 @@
+import { NewsArticleListProps } from './NewsArticleList.types';
+export declare const NewsArticleFilters: {
+    articleType: any;
+    services: any;
+    searchTerm: any;
+};
+export declare const newsArticleData: NewsArticleListProps;

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

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

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

@@ -0,0 +1,28 @@
+export interface NewsArticleListProps {
+    /**
+     * Array of results
+     */
+    results: Array<NewsArticleProps>;
+    /**
+     * The total number of results
+     */
+    totalResults?: number;
+    /**
+     * The current page number
+     */
+    pageNumber?: number;
+    /**
+     * What we're currently sorting by
+     */
+    sortBy?: string;
+}
+export interface NewsArticleProps {
+    id: string;
+    title: string;
+    excerpt: string;
+    date: number;
+    image720x405: string;
+    image72x41: string;
+    imageAltText?: string;
+    url: string;
+}

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

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

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

@@ -0,0 +1,6 @@
+import { SortByValsProps } from './../../components/SortBy/SortBy.types';
+export interface NewsArticleListHeaderProps {
+    totalResults: number;
+    sortBy: string;
+    sortByOptions: Array<SortByValsProps>;
+}

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { NewsArticleOldBannerProps } from "./NewsArticleOldBanner.types";
+/**
+ * Form element - hint text
+ */
+declare const NewsArticleOldBanner: React.FC<NewsArticleOldBannerProps>;
+export default NewsArticleOldBanner;

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

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

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

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

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

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+export interface PageMainProps {
+    /**
+     * Any unique class names to apply to the page container
+     */
+    classes?: string;
+    /**
+     * Should the paragraph text be full width?
+     */
+    fullWidthText?: boolean;
+    /**
+     * The PageMain contents
+     */
+    children?: React.ReactNode;
+}