@nnc-digital/nnc-design-system 1.0.0-alpha49 → 1.0.0-alpha50

package/build/index.d.ts

@@ -0,0 +1,42 @@
+import Autocomplete from './library/components/Autocomplete/Autocomplete';
+import BackToTop from './library/components/BackToTop/BackToTop';
+import Button from './library/components/Button/Button';
+import BinCollection from './library/components/BinCollection/BinCollection';
+import DynamicIcon from './library/components/DynamicIcon/DynamicIcon';
+import Heading from './library/components/Heading/Heading';
+import HeadingWithIcon from './library/components/HeadingWithIcon/HeadingWithIcon';
+import Map from './library/components/Map/Map';
+import MapMarker from './library/components/MapMarker/MapMarker';
+import Pagination from './library/components/Pagination/Pagination';
+import CheckboxListFilter from './library/components/CheckboxListFilter/CheckboxListFilter';
+import DropDownFilter from './library/components/DropDownFilter/DropDownFilter';
+import PromotedLinks from './library/components/PromotedLinks/PromotedLinks';
+import StaticMap from './library/components/StaticMap/StaticMap';
+import TextInput from './library/components/TextInput/TextInput';
+export { Autocomplete, BackToTop, Button, BinCollection, DynamicIcon, Heading, HeadingWithIcon, Map, MapMarker, Pagination, CheckboxListFilter, DropDownFilter, PromotedLinks, StaticMap, TextInput, };
+import Accordion from './library/slices/Accordion/Accordion';
+import BlockQuote from './library/slices/BlockQuote/BlockQuote';
+import CallToAction from './library/slices/CallToAction/CallToAction';
+import CouncilTaxAlphabeticalDirectory from './library/slices/CouncilTaxAlphabeticalDirectory/CouncilTaxAlphabeticalDirectory';
+import Cards from './library/slices/Cards/Cards';
+import DownloadableFiles from './library/slices/DownloadableFiles/DownloadableFiles';
+import Divider from './library/slices/Divider/Divider';
+import GoogleMap from './library/slices/GoogleMap/GoogleMap';
+import Image from './library/slices/Image/Image';
+import ImageAndText from './library/slices/ImageAndText/ImageAndText';
+import InquestSchedule from './library/slices/InquestSchedule/InquestSchedule';
+import Promotions from './library/slices/Promotions/Promotions';
+import SearchBox from './library/slices/SearchBox/SearchBox';
+import Video from './library/slices/Video/Video';
+import WarningText from './library/slices/WarningText/WarningText';
+import WarningTextDisclaimer from './library/slices/WarningTextDisclaimer/WarningTextDisclaimer';
+export { Accordion, BlockQuote, CallToAction, Cards, CouncilTaxAlphabeticalDirectory, Divider, DownloadableFiles, GoogleMap, Image, ImageAndText, InquestSchedule, Promotions, SearchBox, Video, WarningText, WarningTextDisclaimer, };
+export * from './library/structure/PageStructures';
+export { GDS_theme, north_theme, west_theme, lb_theme_north, lb_theme_west } from './themes/theme_generator';
+export { GlobalStyleReset } from './themes/GlobalStyleReset.jsx';
+import DirectoryService from './library/directory/DirectoryService/DirectoryService';
+import DirectoryServiceList from './library/directory/DirectoryServiceList/DirectoryServiceList';
+import DirectoryShortList from './library/directory/DirectoryShortList/DirectoryShortList';
+import { DirectoryShortListProvider, useDirectoryShortListContext } from './library/contexts/DirectoryShortListProvider/DirectoryShortListProvider';
+import DirectoryDocumentList from './library/directory/DirectoryDocumentList/DirectoryDocumentList';
+export { DirectoryService, DirectoryServiceList, DirectoryShortList, DirectoryShortListProvider, useDirectoryShortListContext, DirectoryDocumentList, };

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

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

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

@@ -0,0 +1,26 @@
+export interface AlphabeticalDirectoryProps {
+    /**
+     * What is this?
+     */
+    data: Array<AlphabeticalDirectoryLetterProps>;
+}
+export interface AlphabeticalDirectoryLetterProps {
+    /**
+     * What is this?
+     */
+    group: string;
+    /**
+     * Data to show in directory
+     */
+    children: Array<AlphabeticalDirectoryDataProps>;
+}
+export interface AlphabeticalDirectoryDataProps {
+    /**
+     * What is this?
+     */
+    title: string;
+    /**
+     * Data to show in directory
+     */
+    url: string;
+}

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

@@ -0,0 +1,9 @@
+import React from 'react';
+import { AutocompleteProps } from './Autocomplete.types';
+/**
+ * Autocomplete input; Downshift wrapped around our Input component but with the capability to
+ * accept a list of suggestions which are presented to the user as they type and which they can
+ * click on to select. If viewing in Storybook, try typing the name of a fruit in the story examples.
+ */
+declare const Autocomplete: React.FunctionComponent<AutocompleteProps>;
+export default Autocomplete;

package/build/library/components/Autocomplete/Autocomplete.storydata.d.ts

@@ -0,0 +1,47 @@
+export declare const EmptyWithHiddenLabelData: {
+    id: string;
+    name: string;
+    labelText: string;
+    hasHiddenLabel: boolean;
+    placeholder: string;
+    suggestions: string[];
+    minimumMatchLength: number;
+};
+export declare const NoMatchingSuggestionEnlargedWithHiddenLabelData: {
+    id: string;
+    name: string;
+    labelText: string;
+    value: string;
+    isLarge: boolean;
+    hasHiddenLabel: boolean;
+    placeholder: string;
+    suggestions: string[];
+    minimumMatchLength: number;
+};
+export declare const DisplayingSuggestionsData: {
+    id: string;
+    name: string;
+    value: string;
+    showSuggestions: boolean;
+    placeholder: string;
+    suggestions: string[];
+    minimumMatchLength: number;
+};
+export declare const DisplayingSuggestionsLargeData: {
+    id: string;
+    name: string;
+    value: string;
+    showSuggestions: boolean;
+    isLarge: boolean;
+    placeholder: string;
+    suggestions: string[];
+    minimumMatchLength: number;
+};
+export declare const SuggestionChosenData: {
+    id: string;
+    name: string;
+    value: string;
+    placeholder: string;
+    suggestions: string[];
+    minimumMatchLength: number;
+};

package/build/library/components/Autocomplete/Autocomplete.test.d.ts

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

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

@@ -0,0 +1,78 @@
+export interface AutocompleteProps {
+    /**
+     * ID attribute of the Downshift control (subsidiary label/input/menu list get IDs based upon this)
+     */
+    id?: string;
+    /**
+     * Name attribute of the input control
+     */
+    name?: string;
+    /**
+     * Text content of the label for the control, if empty will use placeholder
+     */
+    labelText?: string;
+    /**
+     * If you want the label visually hidden (but available for screen readers)
+     */
+    hasHiddenLabel?: boolean;
+    /**
+     * Default value of the input control
+     */
+    value?: string;
+    /**
+     * Size of the input control
+     */
+    size?: number;
+    /**
+     * Placeholder within the input control
+     */
+    placeholder?: string;
+    /**
+     * For slightly larger display in some circumstances
+     */
+    isLarge?: boolean;
+    /**
+     * Set to true if there will be a button adjacent on the right (affects right-hand border radii)
+     */
+    hasAdjacentButton?: boolean;
+    /**
+     * Controls the input control's error state
+     */
+    isErrored?: boolean;
+    /**
+     * Text to display if input control is in error state
+     */
+    errorText?: string;
+    /**
+     * Array of suggestion strings
+     */
+    suggestions?: string[];
+    /**
+     * Controls whether suggestions are shown immediately (if value set also)
+     */
+    showSuggestions?: boolean;
+    /**
+     * The minimum number of characters that need to be typed before matches in the suggestions list are looked for
+     */
+    minimumMatchLength?: number;
+    /**
+     * The maximum number of matched suggestions shown in the dropdown list
+     */
+    maximumMatchesShown?: number;
+    /**
+     * Callback function for when a suggestion is selected
+     */
+    onSelect?: (selectedValue: string) => void;
+    /**
+     * Callback function for when input value changes
+     */
+    onChange?: (inputValue: string) => void;
+    /**
+     * Is the field required?
+     */
+    required?: boolean;
+    /**
+     * Is the autocomplete on a light background?
+     */
+    hasLightBackground?: boolean;
+}

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

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

package/build/library/components/BackToTop/BackToTop.test.d.ts

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

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

@@ -0,0 +1,6 @@
+export interface BackToTopProps {
+    /**
+     * Should the back to top button be displayed?
+     */
+    isActive: boolean;
+}

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { BinCollectionProps } from './BinCollection.types';
+/**
+ * Returns the Bin Collection Checker form component to conduct search by postcode.
+ */
+declare const BinCollection: React.FunctionComponent<BinCollectionProps>;
+export default BinCollection;