@nnc-digital/nnc-design-system 1.0.0-alpha9 → 1.0.0-beta10

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

@@ -1,48 +1,52 @@
-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;
-}
+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;
+    /**
+     * URL of the hero video
+     */
+    heroVideoUrl?: 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

@@ -1,7 +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;
+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

@@ -1,14 +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;
-}[];
+/**
+ * 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.test.d.ts

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

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

@@ -1,54 +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;
-}
+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

@@ -1,7 +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;
+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

@@ -1,23 +1,22 @@
-/// <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;
-}
+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

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

@@ -1,27 +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;
-}
+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

@@ -1,7 +1,7 @@
-import React from "react";
-import { NewsArticleDateProps } from "./NewsArticleDate.types";
-/**
- * Form element - hint text
- */
-declare const NewsArticleDate: React.FC<NewsArticleDateProps>;
-export default NewsArticleDate;
+import React from 'react';
+import { NewsArticleDateProps } from './NewsArticleDate.types';
+/**
+ * The date of the news article
+ */
+declare const NewsArticleDate: React.FunctionComponent<NewsArticleDateProps>;
+export default NewsArticleDate;

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

@@ -1,10 +1,10 @@
-export interface NewsArticleDateProps {
-    /**
-     * The text in the hint
-     */
-    text: string;
-    /**
-     * The format for the date
-     */
-    format?: string;
-}
+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

@@ -1,7 +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;
+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.test.d.ts

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

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

@@ -1,23 +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;
-}
+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

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

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

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

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

@@ -1,7 +1,7 @@
-import React from "react";
-import { NewsArticleImageProps } from "./NewsArticleImage.types";
-/**
- * Form element - hint text
- */
-declare const NewsArticleImage: React.FC<NewsArticleImageProps>;
-export default NewsArticleImage;
+import React from 'react';
+import { NewsArticleImageProps } from './NewsArticleImage.types';
+/**
+ * An image for a news article
+ */
+declare const NewsArticleImage: React.FunctionComponent<NewsArticleImageProps>;
+export default NewsArticleImage;

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

@@ -1,18 +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;
-}
+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

@@ -1,7 +1,7 @@
-import { NewsArticleListProps } from './NewsArticleList.types';
-export declare const NewsArticleFilters: {
-    articleType: any;
-    services: any;
-    searchTerm: any;
-};
-export declare const newsArticleData: NewsArticleListProps;
+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

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

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

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

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

@@ -1,28 +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;
-}
+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;
+}