@nnc-digital/nnc-design-system 0.4.3

package/build/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/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/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/library/slices/Accordion/Accordion.types.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="react" />
+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/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/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/library/slices/BlockQuote/BlockQuote.types.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+export interface BlockQuoteProps {
+    /**
+     * 	The text of the quote
+     */
+    quote: React.ReactNode;
+    /**
+     * Optionally, the attribution of the quote
+     */
+    citation?: string;
+}

package/build/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.FC<ButtonProps>;
+export default CallToAction;

package/build/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/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/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/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/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/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/library/slices/Divider/Divider.types.d.ts

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

package/build/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/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/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/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/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/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/library/slices/Image/Image.storydata.d.ts

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

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

@@ -0,0 +1,26 @@
+export interface ImageProps {
+    /**
+     * The large image url
+     */
+    imageLarge: string;
+    /**
+     * The small image url
+     */
+    imageSmall: string;
+    /**
+     * The image alt text to describe the image
+     */
+    imageAltText?: string | null;
+    /**
+     * The image ratio, either '4by3' or '16by9'
+     */
+    ratio: string;
+    /**
+     * The optional image caption that goes under the image
+     */
+    caption?: string | null;
+    /**
+     * Set to true to have following text wrap against image
+     */
+    wrapText?: boolean;
+}

package/build/library/slices/ImageAndText/ImageAndText.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { ImageAndTextProps } from './ImageAndText.types';
+/**
+ * A container for an image and text content, with an optional heading
+ */
+declare const ImageAndText: React.FunctionComponent<ImageAndTextProps>;
+export default ImageAndText;

package/build/library/slices/ImageAndText/ImageAndText.storydata.d.ts

@@ -0,0 +1,2 @@
+import { ImageAndTextProps } from './ImageAndText.types';
+export declare const ImageAndTextWithHeading: ImageAndTextProps;

package/build/library/slices/ImageAndText/ImageAndText.types.d.ts

@@ -0,0 +1,15 @@
+import { ImageProps } from '../Image/Image.types';
+export interface ImageAndTextProps {
+    /**
+     * An optional heading
+     */
+    heading?: string | null;
+    /**
+     * The string of html text content
+     */
+    textContent: string;
+    /**
+     * The image, containing the paths, alt text and caption
+     */
+    image?: ImageProps | null;
+}

package/build/library/slices/InquestSchedule/InquestSchedule.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { InquestScheduleProps } from './InquestSchedule.types';
+/**
+ * A table displaying a schedule of inquests
+ */
+declare const InquestSchedule: React.FunctionComponent<InquestScheduleProps>;
+export default InquestSchedule;

package/build/library/slices/InquestSchedule/InquestSchedule.storydata.d.ts

@@ -0,0 +1,2 @@
+import { CaseAppointmentProps } from './InquestSchedule.types';
+export declare const ExampleInquestScheduleData: CaseAppointmentProps;

package/build/library/slices/InquestSchedule/InquestSchedule.types.d.ts

@@ -0,0 +1,24 @@
+export interface InquestScheduleProps {
+    /**
+     * An array of Case Appointments
+     */
+    caseAppointments: CaseAppointmentProps[];
+    /**
+     * The table title or caption
+     */
+    title: string;
+    /**
+     * Was there an error fetching results
+     */
+    error?: boolean;
+}
+export interface CaseAppointmentProps {
+    fullName: string;
+    age: number;
+    placeOfDeath?: string | null;
+    dateTimeOfDeath: string;
+    coroner: string;
+    courtroomFullAddress: string;
+    appointmentType: string;
+    startDateTime: string;
+}

package/build/library/slices/Promotions/Promotions.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PromoBlockProps } from '../../structure/PromoBlock/PromoBlock.types';
+/**
+ * Combined promotional banner and promotional block for use as a slice on any page
+ */
+declare const Promotions: React.FunctionComponent<PromoBlockProps>;
+export default Promotions;

package/build/library/slices/SearchBox/SearchBox.d.ts

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

package/build/library/slices/SearchBox/SearchBox.storydata.d.ts

@@ -0,0 +1,2 @@
+import { SearchBoxProps } from './SearchBox.types';
+export declare const ExampleSearchBoxProps: SearchBoxProps;

package/build/library/slices/SearchBox/SearchBox.types.d.ts

@@ -0,0 +1,41 @@
+import { CustomSearchProps } from '../../components/CustomSearch/CustomSearch.types';
+export interface SearchBoxProps {
+    /**
+     * The Custom Search sub-component props
+     */
+    customSearch: CustomSearchProps;
+    /**
+     * URL of the hero image (min 400pix high)
+     */
+    imageLarge?: string | null;
+    /**
+     * URL of the a smaller version of the image for lazy loading
+     */
+    imageSmall?: string | null;
+    /**
+     * Optional alt text for the image - ideally the image should be decorative only and not require a long description
+     */
+    imageAltText?: string | null;
+    /**
+     * Optional call to action link
+     */
+    searchBoxLink?: SearchBoxLinkProps | null;
+    /**
+     * Is the search box link primary (true) or secondary (false)
+     */
+    searchBoxLinkIsPrimary?: boolean;
+    /**
+     * Optional title
+     */
+    title?: string | null;
+}
+export interface SearchBoxLinkProps {
+    /**
+     * The url for the link
+     */
+    url: string;
+    /**
+     * The text for the link
+     */
+    title: string;
+}

package/build/library/slices/Video/Video.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { VideoProps } from './Video.types';
+/**
+ * A responsive video embed for YouTube or Vimeo
+ */
+declare const Video: React.FunctionComponent<VideoProps>;
+export default Video;

package/build/library/slices/Video/Video.types.d.ts

@@ -0,0 +1,22 @@
+export interface VideoProps {
+    /**
+     * The unique video id
+     */
+    video_id: string;
+    /**
+     * The video streaming provider
+     */
+    provider: VideoProvider;
+    /**
+     * The description link text displayed when cookies are disabled
+     */
+    description: string;
+    /**
+     * Allow overriding if cookies are allowed
+     */
+    allowCookies?: boolean;
+}
+export declare enum VideoProvider {
+    YouTube = "YouTube",
+    Vimeo = "Vimeo"
+}

package/build/library/slices/WarningText/WarningText.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { WarningTextProps } from './WarningText.types';
+/**
+ * Display text as a highlight or warning with a title
+ */
+declare const WarningText: React.FunctionComponent<WarningTextProps>;
+export default WarningText;

package/build/library/slices/WarningText/WarningText.types.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+export interface WarningTextProps {
+    /**
+     * 	The title of the warning
+     */
+    title: string;
+    /**
+     * 	Optional to change the colour from a secondary colour to warning
+     */
+    isWarning?: boolean;
+    /**
+     * The WarningText contents
+     */
+    children?: React.ReactNode;
+}

package/build/library/slices/WarningTextDisclaimer/WarningTextDisclaimer.d.ts

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

package/build/library/slices/WarningTextDisclaimer/WarningTextDisclaimer.types.d.ts

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

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

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

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

@@ -0,0 +1,20 @@
+export interface AccessibleLinkProps {
+    /**
+     * An array of links for the accessible links section at the top of the page, for things like accessibility message and feedback form
+     */
+    AccessibleLinksArray?: Array<AccessibleLinkProp>;
+}
+export interface AccessibleLinkProp {
+    /**
+    * 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/AlertBanner/AlertBanner.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { AlertBannerProps } from './AlertBanner.types';
+/**
+ * A site wide alert banner, once dismissed it won't be shown again
+ */
+declare const AlertBanner: React.FunctionComponent<AlertBannerProps>;
+export default AlertBanner;

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

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+export interface AlertBannerProps {
+    /**
+     * Title of the alert
+     */
+    title: string;
+    /**
+     * A unique idenification for the alert banner to store the localstorage for the hide button
+     */
+    uid: string;
+    /**
+     * The type of alert
+     */
+    alertType?: 'alert' | 'warning' | 'positive' | 'london_bridge';
+    /**
+     * All children content for the banner
+     */
+    children: React.ReactNode;
+}

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import { AlertBannerServiceProps } from './AlertBannerService.types';
+/**
+ * A banner to be displayed at the top of a page before the main content
+ * to draw the viewer's attention to an alert notice
+ */
+declare const AlertBannerService: React.FunctionComponent<AlertBannerServiceProps>;
+export default AlertBannerService;

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

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+export interface AlertBannerServiceProps {
+    /**
+     * The optional title of this alert banner
+     */
+    title?: string;
+    /**
+     * Set to true for additional margin above the alert banner
+     */
+    hasTopSpacing?: boolean;
+    /**
+     * The type of alert banner
+     */
+    alertType?: 'alert' | 'warning' | 'positive' | 'london_bridge';
+    /**
+     * All child content for the alert banner
+     */
+    children: React.ReactNode;
+}