@nnc-digital/nnc-design-system 1.0.0-alpha4 → 1.0.0-alpha40

package/build/library/directory/DirectoryServiceList/DirectoryServiceList.types.d.ts

@@ -1,136 +1,148 @@
-import { Dispatch, SetStateAction } from 'react';
-import { DirectoryServiceProps } from '../DirectoryService/DirectoryService.types';
-export interface DirectoryServiceListProps {
-    /**
-     * Are the ages in months? Defaults to false
-     */
-    ageInMonths?: boolean;
-    /**
-     * The base url for the directory
-     */
-    directoryPath: string;
-    /**
-     * The url to the shortlist
-     */
-    shortListPath: string;
-    /**
-     * An array of Directory Services
-     */
-    services: DirectoryServiceProps[];
-    /**
-     * The search term string
-     */
-    search?: string;
-    /**
-     * Function prop passed in to handle updating search
-     */
-    setSearch: Dispatch<SetStateAction<string>>;
-    /**
-     * The postcode search term
-     */
-    postcode?: string;
-    /**
-     * Function prop passed in to handle updating postcode
-     */
-    setPostcode: Dispatch<SetStateAction<string>>;
-    /**
-     * The total amount of results
-     */
-    totalResults?: number;
-    /**
-     * The total amount of pages
-     */
-    pageNumber?: number;
-    /**
-     * Function prop passed in to handle the update page number
-     */
-    setPageNumber: Dispatch<SetStateAction<number>>;
-    /**
-     * The number of results per page
-     */
-    perPage?: number;
-    /**
-     * The max length of each service description extract
-     */
-    extractLength?: number;
-    /**
-     * The filter categories
-     */
-    categories?: DirectoryCategory[];
-    /**
-     * Function prop passed in to handle updating categories
-     */
-    setCategories: Dispatch<SetStateAction<DirectoryCategory[]>>;
-    /**
-     * The minimum age filter
-     */
-    minimumAge?: number | string;
-    /**
-     * Function prop passed in to handle updating minimumAge
-     */
-    setMinimumAge: Dispatch<SetStateAction<number | string | undefined>>;
-    /**
-     * The maximum age filter
-     */
-    maximumAge?: number | string;
-    /**
-     * Function prop passed in to handle updating maximumAge
-     */
-    setMaximumAge: Dispatch<SetStateAction<number | string | undefined>>;
-    /**
-     *  Where to centre the map, in the format 'lat,lng'
-     */
-    mapCenter?: string;
-    /**
-     * The optional zoom level, between 1 and 20. 1 = world, 20 = buildings
-     */
-    mapZoom?: number;
-    /**
-     * Is the data loading
-     */
-    isLoading: boolean;
-    /**
-     * Does the directory have documents?
-     */
-    hasDocuments?: boolean;
-}
-export interface DirectoryCategory {
-    /**
-     * The category label
-     */
-    label: string;
-    /**
-     * The vocabulary name
-     */
-    vocabulary: string;
-    /**
-     * An array of taxonomies
-     */
-    options: DirectoryTaxonomy[];
-    /**
-     * Should multiple options be allowed
-     */
-    singleSelection: boolean;
-}
-export interface DirectoryTaxonomy {
-    /**
-     * Unique taxonomy identifier in curie format (e.g. localOffer1)
-     */
-    id: string;
-    /**
-     * The name of the taxonomy
-     */
-    name: string;
-    /**
-     * The vocabulary name
-     */
-    vocabulary: string;
-    /**
-     * The optional parent taxonomy
-     */
-    parent?: string | null;
-    /**
-     * Is the option checked
-     */
-    checked: boolean;
-}
+import { Dispatch, SetStateAction } from 'react';
+import { DirectoryServiceProps } from '../DirectoryService/DirectoryService.types';
+export interface DirectoryServiceListProps {
+    /**
+     * Are the ages in months? Defaults to false
+     */
+    ageInMonths?: boolean;
+    /**
+     * The base url for the directory
+     */
+    directoryPath: string;
+    /**
+     * The url to the shortlist
+     */
+    shortListPath: string;
+    /**
+     * An array of Directory Services
+     */
+    services: DirectoryServiceProps[];
+    /**
+     * The search term string
+     */
+    search?: string;
+    /**
+     * Function prop passed in to handle updating search
+     */
+    setSearch: Dispatch<SetStateAction<string>>;
+    /**
+     * The optional proximity the postcode will search. Defaults to 2 miles.
+     */
+    proximity?: number;
+    /**
+     * Should the postcode search be shown? Defaults to true.
+     */
+    showPostcodeSearch?: boolean;
+    /**
+     * The postcode search term
+     */
+    postcode?: string;
+    /**
+     * Function prop passed in to handle updating postcode
+     */
+    setPostcode: Dispatch<SetStateAction<string>>;
+    /**
+     * The total amount of results
+     */
+    totalResults?: number;
+    /**
+     * The total amount of pages
+     */
+    pageNumber?: number;
+    /**
+     * Function prop passed in to handle the update page number
+     */
+    setPageNumber: Dispatch<SetStateAction<number>>;
+    /**
+     * The number of results per page
+     */
+    perPage?: number;
+    /**
+     * The max length of each service description extract
+     */
+    extractLength?: number;
+    /**
+     * The filter categories
+     */
+    categories?: DirectoryCategory[];
+    /**
+     * Function prop passed in to handle updating categories
+     */
+    setCategories: Dispatch<SetStateAction<DirectoryCategory[]>>;
+    /**
+     * The minimum age filter
+     */
+    minimumAge?: number | string;
+    /**
+     * Function prop passed in to handle updating minimumAge
+     */
+    setMinimumAge: Dispatch<SetStateAction<number | string | undefined>>;
+    /**
+     * The maximum age filter
+     */
+    maximumAge?: number | string;
+    /**
+     * Function prop passed in to handle updating maximumAge
+     */
+    setMaximumAge: Dispatch<SetStateAction<number | string | undefined>>;
+    /**
+     *  Where to centre the map, in the format 'lat,lng'
+     */
+    mapCenter?: string;
+    /**
+     * The optional zoom level, between 1 and 20. 1 = world, 20 = buildings
+     */
+    mapZoom?: number;
+    /**
+     * Is the data loading
+     */
+    isLoading: boolean;
+    /**
+     * Does the directory have documents?
+     */
+    hasDocuments?: boolean;
+    /**
+     * Is the component in error state
+     */
+    isError?: boolean;
+}
+export interface DirectoryCategory {
+    /**
+     * The category label
+     */
+    label: string;
+    /**
+     * The vocabulary name
+     */
+    vocabulary: string;
+    /**
+     * An array of taxonomies
+     */
+    options: DirectoryTaxonomy[];
+    /**
+     * Should multiple options be allowed
+     */
+    singleSelection: boolean;
+}
+export interface DirectoryTaxonomy {
+    /**
+     * Unique taxonomy identifier in curie format (e.g. localOffer1)
+     */
+    id: string;
+    /**
+     * The name of the taxonomy
+     */
+    name: string;
+    /**
+     * The vocabulary name
+     */
+    vocabulary: string;
+    /**
+     * The optional parent taxonomy
+     */
+    parent?: string | null;
+    /**
+     * Is the option checked
+     */
+    checked: boolean;
+}

package/build/library/directory/DirectoryShortList/DirectoryShortList.d.ts

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

package/build/library/directory/DirectoryShortList/DirectoryShortList.test.d.ts

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

package/build/library/directory/DirectoryShortList/DirectoryShortList.types.d.ts

@@ -1,6 +1,6 @@
-export interface DirectoryShortListProps {
-    /**
-     * The path of the directory
-     */
-    directoryPath: string;
-}
+export interface DirectoryShortListProps {
+    /**
+     * The path of the directory
+     */
+    directoryPath: string;
+}

package/build/library/directory/ServiceContact/ServiceContact.d.ts

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

package/build/library/directory/ServiceContact/ServiceContact.test.d.ts

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

package/build/library/directory/ServiceContact/ServiceContact.types.d.ts

@@ -1,42 +1,42 @@
-export interface ServiceContactComponentProps {
-    /**
-     * The optional email address
-     */
-    email?: string;
-    /**
-     * The optional website address
-     */
-    website?: string;
-    /**
-     * An array of service contacts. May be empty.
-     */
-    contacts: ServiceContactProps[];
-}
-export interface ServiceContactProps {
-    /**
-     * The unique identifier
-     */
-    id: number;
-    /**
-     * The name of the contact
-     */
-    name: string;
-    /**
-     * The job title of the contact
-     */
-    title: string;
-    /**
-     * The array of phone numbers
-     */
-    phones: PhoneProps[];
-}
-export interface PhoneProps {
-    /**
-     * The unique identifier
-     */
-    id: number;
-    /**
-     * The telephone number
-     */
-    number: string;
-}
+export interface ServiceContactComponentProps {
+    /**
+     * The optional email address
+     */
+    email?: string;
+    /**
+     * The optional website address
+     */
+    website?: string;
+    /**
+     * An array of service contacts. May be empty.
+     */
+    contacts: ServiceContactProps[];
+}
+export interface ServiceContactProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The name of the contact
+     */
+    name: string;
+    /**
+     * The job title of the contact
+     */
+    title: string;
+    /**
+     * The array of phone numbers
+     */
+    phones: PhoneProps[];
+}
+export interface PhoneProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The telephone number
+     */
+    number: string;
+}

package/build/library/directory/ServiceSocialLinks/ServiceSocialLinks.d.ts

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

package/build/library/directory/ServiceSocialLinks/ServiceSocialLinks.storydata.d.ts

@@ -1,2 +1,2 @@
-import { ServiceSocialLinksProps } from './ServiceSocialLinks.types';
-export declare const ExampleSocialProfiles: ServiceSocialLinksProps;
+import { ServiceSocialLinksProps } from './ServiceSocialLinks.types';
+export declare const ExampleSocialProfiles: ServiceSocialLinksProps;

package/build/library/directory/ServiceSocialLinks/ServiceSocialLinks.test.d.ts

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

package/build/library/directory/ServiceSocialLinks/ServiceSocialLinks.types.d.ts

@@ -1,24 +1,24 @@
-export interface ServiceSocialLinksProps {
-    /**
-     * An array of social links
-     */
-    profiles?: SocialProfile[];
-}
-export interface SocialProfile {
-    /**
-     * The id for the social profile
-     */
-    id: number;
-    /**
-     * The profile name
-     */
-    name: string;
-    /**
-     * The link to the profile
-     */
-    link: string;
-    /**
-     * The social network name
-     */
-    social_network: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'youtube';
-}
+export interface ServiceSocialLinksProps {
+    /**
+     * An array of social links
+     */
+    profiles?: SocialProfile[];
+}
+export interface SocialProfile {
+    /**
+     * The id for the social profile
+     */
+    id: number;
+    /**
+     * The profile name
+     */
+    name: string;
+    /**
+     * The link to the profile
+     */
+    link: string;
+    /**
+     * The social network name
+     */
+    social_network: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'youtube';
+}

package/build/library/helpers/UseLocalStorage.d.ts

@@ -1,2 +1,2 @@
-declare const useLocalStorage: (key: any, initialValue: any) => any[];
-export default useLocalStorage;
+declare const useLocalStorage: (key: any, initialValue: any) => any[];
+export default useLocalStorage;