@nnc-digital/nnc-design-system 0.4.3

package/build/library/components/HeadingWithIconLink/HeadingWithIconLink.d.ts

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

package/build/library/components/HeadingWithIconLink/HeadingWithIconLink.types.d.ts

@@ -0,0 +1,14 @@
+export interface HeadingWithIconLinkProps {
+    /**
+     * The key for the icon
+     */
+    iconKey?: string;
+    /**
+     * The link for the icons
+     */
+    link: string;
+    /**
+     * The title text for the heading
+     */
+    title: string;
+}

package/build/library/components/HintText/HintText.d.ts

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

package/build/library/components/HintText/HintText.types.d.ts

@@ -0,0 +1,6 @@
+export interface HintTextProps {
+    /**
+     * The text in the hint
+     */
+    text: string;
+}

package/build/library/components/Input/Input.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { InputProps } from './Input.types';
+/**
+ * Primary UI component for user interaction
+ * If value is set then treat as controlled component
+ */
+declare const Input: React.FunctionComponent<InputProps>;
+export default Input;

package/build/library/components/Input/Input.types.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="react" />
+export interface InputProps {
+    /**
+     * The type, defaults to text
+     */
+    type?: string;
+    /**
+     * The placeholder text for the input
+     */
+    placeholder?: string;
+    /**
+     * The name of the input
+     */
+    isErrored?: boolean;
+    /**
+     * An optional string to explain the error
+     */
+    errorText?: string;
+    /**
+     * The name of the input
+     */
+    name: string;
+    /**
+     * The max length attribute
+     */
+    maxLength?: number;
+    /**
+     * Optional default value.
+     * Don't set both defaultValue and value.
+     */
+    defaultValue?: string | number;
+    /**
+     * An optional function to be called on change
+     */
+    onChange?: React.ReactNode | ((e: any) => void);
+    /**
+     * The optional input id
+     */
+    id?: string;
+    /**
+     * The optional value for a controlled component.
+     * Don't set both defaultValue and value.
+     */
+    value?: string | number;
+}

package/build/library/components/LoadingSpinner/LoadingSpinner.d.ts

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

package/build/library/components/LoadingSpinner/LoadingSpinner.types.d.ts

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

package/build/library/components/Map/Map.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { MapProps } from './Map.types';
+/**
+ * An interactive Google Map which can accept MapMarkers as children
+ */
+declare const Map: React.FunctionComponent<MapProps>;
+export default Map;

package/build/library/components/Map/Map.types.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="google.maps" />
+import React from 'react';
+export interface MapProps {
+    /**
+     * Where to centre the map
+     */
+    center: google.maps.LatLngLiteral;
+    /**
+     * The zoom level
+     */
+    zoom: number;
+    /**
+     * Contents of the map
+     */
+    children: React.ReactNode;
+}

package/build/library/components/MapMarker/MapMarker.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="google.maps" />
+import React from 'react';
+/**
+ * A Google Maps marker to be placed inside a Map component
+ */
+declare const MapMarker: React.FunctionComponent<google.maps.MarkerOptions>;
+export default MapMarker;

package/build/library/components/Pagination/Pagination.d.ts

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

package/build/library/components/Pagination/Pagination.types.d.ts

@@ -0,0 +1,23 @@
+import { Dispatch, SetStateAction } from 'react';
+export interface PaginationProps {
+    /**
+     * What page are we on?
+     */
+    currentPage: number;
+    /**
+     * How many results are we showing per page, defaults to 10
+     */
+    resultsPerPage?: number;
+    /**
+     * What is the total number of results
+     */
+    totalResults: number;
+    /**
+     * Which end point are we going to - defaults to search
+     */
+    postTo?: string;
+    /**
+     * An optional pagination override function
+     */
+    buttonClickOverride?: Dispatch<SetStateAction<number>>;
+}

package/build/library/components/PostCodeAddressDropdown/PostCodeAddressDropdown.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PostCodeAddressDropdownProps } from './PostCodeAddressDropdown.types';
+/**
+ * The dropdown component for selecting and displaying address information
+ */
+declare const PostCodeAddressDropdown: React.FunctionComponent<PostCodeAddressDropdownProps>;
+export default PostCodeAddressDropdown;

package/build/library/components/PostCodeAddressDropdown/PostCodeAddressDropdown.types.d.ts

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

package/build/library/components/PostCodeAddressSearch/PostCodeAddressSearch.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PostCodeAddressSearchProps } from './PostCodeAddressSearch.types';
+/**
+ * The functionality for searching for a postcode
+ */
+declare const PostCodeAddressSearch: React.FunctionComponent<PostCodeAddressSearchProps>;
+export default PostCodeAddressSearch;

package/build/library/components/PostCodeAddressSearch/PostCodeAddressSearch.types.d.ts

@@ -0,0 +1,23 @@
+import { SignpostLinkProp } from '../../structure/SignpostLinks/SignpostLinks.types';
+export interface PostCodeAddressSearchProps {
+    /**
+     * Title of postcode search link
+     */
+    title?: string;
+    /**
+     * Is there an error in the form?
+     */
+    formError?: boolean;
+    /**
+     * An array of the SignpostLinks
+     */
+    signPostLinks?: 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;
+    /**
+     * Optional - changes it to only give back the area you are from
+     */
+    isUnitary?: boolean;
+}

package/build/library/components/PostCodeAddressTable/PostCodeAddressTable.d.ts

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

package/build/library/components/PostCodeAddressTable/PostCodeAddressTable.types.d.ts

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

package/build/library/components/PostCodeSearch/PostCodeSearch.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PostCodeSearchProps } from './PostCodeSearch.types';
+/**
+ * The functionality for searching for a postcode
+ */
+declare const PostCodeSearch: React.FunctionComponent<PostCodeSearchProps>;
+export default PostCodeSearch;

package/build/library/components/PostCodeSearch/PostCodeSearch.types.d.ts

@@ -0,0 +1,52 @@
+import { AddressProps, SovereignProps, UnitaryProps } from '../../helpers/api-helpers';
+import { SignpostLinkProp } from '../../structure/SignpostLinks/SignpostLinks.types';
+export interface PostCodeSearchProps {
+    /**
+     * Title of postcode search link
+     */
+    title?: string;
+    /**
+     * Is there an error in the form?
+     */
+    formError?: boolean;
+    /**
+     * An array of the SignpostLinks
+     */
+    signPostLinks?: 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;
+    /**
+     * Optional - changes it to only give back the area you are from
+     */
+    isUnitary?: boolean;
+}
+export interface AddressOption {
+    /**
+     * The title of the address
+     */
+    title: string;
+    /**
+     * The uprn value
+     */
+    value: string;
+    /**
+     * Array of postcode response props
+     */
+    info: AddressOptionInfoProps[];
+}
+export interface AddressOptionInfoProps {
+    /**
+     * An array of sovereigns
+     */
+    sovereigns: SovereignProps[];
+    /**
+     * An array of Unitaries
+     */
+    unitaries: UnitaryProps[];
+    /**
+     * An array of addresses for the postcode
+     */
+    addresses: AddressProps[];
+}

package/build/library/components/PromotedLinks/PromotedLinks.d.ts

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

package/build/library/components/PromotedLinks/PromotedLinks.types.d.ts

@@ -0,0 +1,20 @@
+export interface PromotedLinksProps {
+    /**
+     * The main promoted links, an array that should be from 1-4, preferably 3
+     */
+    promotedLinksArray: Array<PromotedLinkProp>;
+    /**
+     * One column layout
+     */
+    oneCol?: boolean;
+}
+export interface PromotedLinkProp {
+    /**
+     * The title of the link
+     */
+    title: string;
+    /**
+     * The url of the link
+     */
+    url: string;
+}

package/build/library/components/RadioCheckboxInput/RadioCheckboxInput.d.ts

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

package/build/library/components/RadioCheckboxInput/RadioCheckboxInput.types.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="react" />
+export interface RadioCheckboxInputProps {
+    /**
+     * Is the input checked?
+     */
+    checked: boolean;
+    /**
+     * The label for the input
+     */
+    label: string;
+    /**
+     * The name of the input
+     */
+    name: string;
+    /**
+     * The on change function
+     */
+    onChange?: React.ReactNode | ((e: any) => void);
+    /**
+     * Is this a single selection, if true radio, if false checkbox
+     */
+    singleSelection: boolean;
+    /**
+     * The value of the input
+     */
+    value: string;
+}

package/build/library/components/RemovableTag/RemovableTag.d.ts

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

package/build/library/components/RemovableTag/RemovableTag.types.d.ts

@@ -0,0 +1,8 @@
+export interface RemovableTagProps {
+    label: string;
+    value: string;
+    preposition?: string;
+    index?: number;
+    param?: string;
+    clickHandler?: Function;
+}

package/build/library/components/RemoveAllFilters/RemoveAllFilters.d.ts

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

package/build/library/components/RemoveAllFilters/RemoveAllFilters.types.d.ts

@@ -0,0 +1,3 @@
+export interface RemoveAllFiltersProps {
+    count: number;
+}

package/build/library/components/Row/Row.d.ts

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

package/build/library/components/Row/Row.types.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+export interface RowProps {
+    /**
+     * Option to display the border
+     * Should only used for demonstrating grid
+     */
+    hasBorder?: boolean;
+    /**
+     * Is the container an unordered list?
+     */
+    isList?: boolean;
+    /**
+     * Option to prevent wrapping
+     */
+    hasWrap?: boolean;
+    /**
+     * The contents of the Row (should be Column)
+     */
+    children?: React.ReactNode;
+}

package/build/library/components/SignpostLinksList/SignpostLinksList.d.ts

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

package/build/library/components/SignpostLinksList/SignpostLinksList.types.d.ts

@@ -0,0 +1,24 @@
+export interface SignpostLinksListProps {
+    /**
+     * An array of the SignpostLinks
+     */
+    signpostLinksArray: Array<SignpostLinkProp>;
+}
+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;
+}

package/build/library/components/SortBy/SortBy.d.ts

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

package/build/library/components/SortBy/SortBy.types.d.ts

@@ -0,0 +1,20 @@
+export interface SortByProps {
+    /**
+    * What we're currently sorting by
+    */
+    selected?: string;
+    /**
+     * What to show in the dropdown
+     */
+    options: Array<SortByValsProps>;
+}
+export interface SortByValsProps {
+    /**
+     * Text shown in dropdown
+     */
+    title: string;
+    /**
+     * Filter sent to the all seeing server
+     */
+    value: string;
+}

package/build/library/components/StaticMap/StaticMap.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { StaticMapProps } from './StaticMap.types';
+/**
+ * A static Google map with optional markers
+ */
+declare const StaticMap: React.FunctionComponent<StaticMapProps>;
+export default StaticMap;

package/build/library/components/StaticMap/StaticMap.types.d.ts

@@ -0,0 +1,52 @@
+export interface StaticMapProps {
+    /**
+     *  Where to centre the map, in the format lat,lng
+     */
+    centre: string;
+    /**
+     * The alt text for the static map image
+     */
+    imageAltText: string;
+    /**
+     * The type of map
+     */
+    mapType?: 'roadmap' | 'satellite' | 'terrain' | 'hybrid';
+    /**
+     * An array of map markers
+     */
+    mapMarkers?: MapMarkerProps[];
+    /**
+     * The size of the map in the format wxh, such as 640x320
+     */
+    size?: string;
+    /**
+     * The optional zoom level, between 1 and 20. 1 = world, 20 = buildings
+     */
+    zoom?: number;
+}
+export interface MapMarkerProps {
+    /**
+     * Optional marker colour. Default is red
+     */
+    colour?: 'black' | 'brown' | 'green' | 'purple' | 'yellow' | 'blue' | 'gray' | 'orange' | 'red' | 'white';
+    /**
+     * Optional label. Single character only A-Z, 0-9
+     */
+    label?: string;
+    /**
+     * The latitude
+     */
+    lat: number;
+    /**
+     * The longitude
+     */
+    lng: number;
+    /**
+     * Optional marker size. Default is normal
+     */
+    size?: 'tiny' | 'mid' | 'small' | 'normal';
+    /**
+     * Optional marker title
+     */
+    title?: string;
+}

package/build/library/components/SummaryList/SummaryList.d.ts

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

package/build/library/components/SummaryList/SummaryList.types.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+export interface SummaryListProps {
+    /**
+     * An array of SummaryRowProps
+     */
+    terms: SummaryRowProps[];
+    /**
+     * Option to remove margin (default is true)
+     */
+    hasMargin?: boolean;
+}
+export interface SummaryRowProps {
+    /**
+     * The title for the summary item
+     */
+    term: string;
+    /**
+     * The detail content
+     */
+    detail: React.ReactChild;
+}

package/build/library/components/TextInput/TextInput.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { TextInputProps } from "./TextInput.types";
+/**
+ * Standard text input component
+ */
+declare const TextInput: React.FunctionComponent<TextInputProps>;
+export default TextInput;

package/build/library/components/TextInput/TextInput.types.d.ts

@@ -0,0 +1,34 @@
+export interface TextInputProps {
+    /**
+     * The ID of the control
+     */
+    id?: string;
+    /**
+     * The name of the input
+     */
+    name?: string;
+    /**
+     * The value of the input
+     */
+    value?: string;
+    /**
+     * The character size of the input
+     */
+    size?: Number;
+    /**
+     * The placeholder text for the input
+     */
+    placeholder?: string;
+    /**
+     * For slightly larger display in some circumstances
+     */
+    isLarge?: boolean;
+    /**
+     * Error state of the input
+     */
+    isErrored?: boolean;
+    /**
+     * An optional string to explain the error
+     */
+    errorText?: string;
+}

package/build/library/components/icons/ChevronIcon/ChevronIcon.d.ts

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

package/build/library/components/icons/ChevronIcon/ChevronIcon.types.d.ts

@@ -0,0 +1,10 @@
+export interface ChevronIconProps {
+    /**
+     * The colour of the icon
+     */
+    colourFill?: string;
+    /**
+     * The direction of the chevron, choice of "left", "up", "right", or "down"
+     */
+    direction?: string;
+}

package/build/library/components/icons/CloseIcon/CloseIcon.d.ts

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

package/build/library/components/icons/CloseIcon/CloseIcon.types.d.ts

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

package/build/library/components/icons/DownloadFileIcon/DownloadFileIcon.d.ts

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

package/build/library/components/icons/DownloadFileIcon/DownloadFileIcon.types.d.ts

@@ -0,0 +1,6 @@
+export interface DownloadFileIconProps {
+    /**
+     * The colour of the icon
+     */
+    colourFill?: string;
+}

package/build/library/components/icons/EmailIcon/EmailIcon.d.ts

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

package/build/library/components/icons/EmailIcon/EmailIcon.types.d.ts

@@ -0,0 +1,6 @@
+export interface EmailIconProps {
+    /**
+     * The colour of the icon
+     */
+    colourFill?: string;
+}