@scottish-government/designsystem-react 0.12.1 → 0.13.0

package/@types/components/Button.d.ts

@@ -1,17 +0,0 @@
-declare namespace SGDS.Component {
-    type ButtonStyle = 'primary' | 'secondary';
-    type ButtonType = 'submit' | 'reset' | 'button';
-    type ButtonWidth = 'fluid' | 'fixed' | 'max';
-
-    interface Button extends React.AllHTMLAttributes<HTMLButtonElement> {
-        hasLinkStyle?: boolean,
-        href?: string,
-        icon?: IconName,
-        isIconLeft?: boolean
-        isIconOnly?: boolean,
-        isSmall?: boolean,
-        buttonStyle?: ButtonStyle,
-        type?: ButtonType
-        width?: ButtonWidth
-    }
-}

package/@types/components/ButtonGroup.d.ts

@@ -1,5 +0,0 @@
-declare namespace SGDS.Component {
-    interface ButtonGroup extends React.AllHTMLAttributes<HTMLElement> {
-        isInline?: boolean
-    }
-}

package/@types/components/CategoryItem.d.ts

@@ -1,10 +0,0 @@
-declare namespace SGDS.Component {
-    interface CategoryItem extends React.AllHTMLAttributes<HTMLElement> {
-        className?: string,
-        headingLevel?: SGDS.HeadingLevel,
-        href?: string,
-        linkComponent?: SGDS.LinkComponent
-        tagName?: string,
-        title: string,
-    }
-}

package/@types/components/CategoryList.d.ts

@@ -1,7 +0,0 @@
-declare namespace SGDS.Component {
-    interface CategoryList extends React.AllHTMLAttributes<HTMLElement> {
-        className?: string,
-        isGrid?: boolean,
-        isOrdered?: boolean
-    }
-}

package/@types/components/Checkbox.d.ts

@@ -1,11 +0,0 @@
-declare namespace SGDS.Component {
-    namespace Checkbox {
-        interface Group extends React.AllHTMLAttributes<HTMLElement> {
-            isSmall?: boolean
-        }
-    }
-
-    interface Checkbox extends CheckboxRadioBase<HTMLInputElement> {
-        isExclusive?: boolean
-    }
-}

package/@types/components/ConfirmationMessage.d.ts

@@ -1,7 +0,0 @@
-declare namespace SGDS.Component {
-    interface ConfirmationMessage extends React.AllHTMLAttributes<HTMLElement> {
-        ariaLive: React.AriaAttributes['aria-live'],
-        headingLevel: HeadingLevel,
-        title: string
-    }
-}

package/@types/components/ContentsNav.d.ts

@@ -1,13 +0,0 @@
-declare namespace SGDS.Component {
-    namespace ContentsNav {
-        interface ContentsNavItem extends React.AllHTMLAttributes<HTMLElement> {
-            isCurrent?: boolean,
-            linkComponent?: SGDS.LinkComponent;
-        }
-    }
-
-    interface ContentsNav extends React.AllHTMLAttributes<HTMLElement> {
-        ariaLabel: React.AriaAttributes['aria-label'],
-        title: string
-    }
-}

package/@types/components/DatePicker.d.ts

@@ -1,20 +0,0 @@
-declare namespace SGDS.Component {
-    interface DatePicker extends React.AllHTMLAttributes<HTMLElement> {
-        dateSelectCallback?: Function;
-        disabledDates?: string,
-        hasError?: boolean,
-        errorMessage?: string,
-        id: string,
-        hintText?: string,
-        iconPath?: string,
-        label: string,
-        maxDate?: string,
-        minDate?: string,
-        isMultiple?: boolean,
-        name?: string,
-        onBlur?: React.EventHandler<any>,
-        onChange?: React.EventHandler<any>,
-        value?: string,
-        width?: SGDS.InputWidth
-    }
-}

package/@types/components/Details.d.ts

@@ -1,6 +0,0 @@
-declare namespace SGDS.Component {
-    interface Details extends React.AllHTMLAttributes<HTMLDetailsElement> {
-        title?: string,
-        summary: string
-    }
-}

package/@types/components/ErrorMessage.d.ts

@@ -1,5 +0,0 @@
-declare namespace SGDS.Component {
-    interface ErrorMessage extends React.AllHTMLAttributes<HTMLElement> {
-        id?: string
-    }
-}

package/@types/components/ErrorSummary.d.ts

@@ -1,12 +0,0 @@
-declare namespace SGDS.Component {
-    namespace ErrorSummary {
-        interface Item extends React.AllHTMLAttributes<HTMLElement> {
-            fragmentId: string,
-            linkComponent?: SGDS.LinkComponent
-        }
-    }
-
-    interface ErrorSummary extends React.AllHTMLAttributes<HTMLElement> {
-        title: string
-    }
-}

package/@types/components/FileDownload.d.ts

@@ -1,11 +0,0 @@
-declare namespace SGDS.Component {
-    interface FileDownload extends React.AllHTMLAttributes<HTMLElement> {
-        cover?: string,
-        fileSize?: string,
-        fileType?: string,
-        fileUrl: string,
-        icon?: DocumentIconName,
-        isHighlighted?: boolean,
-        title: string
-    }
-}

package/@types/components/HideThisPage.d.ts

@@ -1,5 +0,0 @@
-declare namespace SGDS.Component {
-    interface HideThisPage extends React.AllHTMLAttributes<HTMLElement> {
-        escapeUrl?: string
-    }
-}

package/@types/components/InsetText.d.ts

@@ -1,5 +0,0 @@
-declare namespace SGDS.Component {
-    interface InsetText extends React.AllHTMLAttributes<HTMLElement> {
-
-    }
-}

package/@types/components/Metadata.d.ts

@@ -1,11 +0,0 @@
-declare namespace SGDS.Component {
-    namespace Metadata {
-        interface Item extends React.AllHTMLAttributes<HTMLElement> {
-            name: string
-        }
-    }
-
-    interface Metadata extends React.AllHTMLAttributes<HTMLDListElement> {
-        isInline?: boolean
-    }
-}

package/@types/components/NotificationPanel.d.ts

@@ -1,7 +0,0 @@
-declare namespace SGDS.Component {
-    interface NotificationPanel extends React.AllHTMLAttributes<HTMLDivElement> {
-        ariaLive?: React.AriaAttributes['aria-live'],
-        headingLevel?: HeadingLevel,
-        title: string
-    }
-}

package/@types/components/PageHeader.d.ts

@@ -1,7 +0,0 @@
-declare namespace SGDS.Component {
-    interface PageHeader extends React.AllHTMLAttributes<HTMLHeadingElement> {
-        label?: string,
-        title: string,
-        titleId?: string
-    }
-}

package/@types/components/Pagination.d.ts

@@ -1,22 +0,0 @@
-declare namespace SGDS.Component {
-    namespace Pagination {
-        interface Page extends React.AllHTMLAttributes<HTMLElement> {
-            ariaLabel: React.AriaAttributes['aria-label'],
-            isCurrent?: boolean,
-            href: string,
-            linkComponent?: SGDS.LinkComponent,
-            onClick?: React.EventHandler<any>
-        }
-    }
-
-    interface Pagination extends React.AllHTMLAttributes<HTMLElement> {
-        ariaLabel: React.AriaAttributes['aria-label'],
-        className?: string,
-        linkComponent?: SGDS.LinkComponent,
-        onClick?: React.EventHandler<any>,
-        padding: number,
-        page: number,
-        pattern: string,
-        totalPages: number
-    }
-}

package/@types/components/PhaseBanner.d.ts

@@ -1,5 +0,0 @@
-declare namespace SGDS.Component {
-    interface PhaseBanner extends React.AllHTMLAttributes<HTMLDivElement> {
-        phaseName: string
-    }
-}

package/@types/components/Question.d.ts

@@ -1,11 +0,0 @@
-declare namespace SGDS.Component {
-    type QuestionTags = 'div' | 'fieldset';
-
-    interface Question extends React.AllHTMLAttributes<HTMLElement> {
-        errorMessage?: string,
-        hasError?: boolean,
-        hintText?: string,
-        legend?: string,
-        tagName: QuestionTags
-    }
-}

package/@types/components/RadioButton.d.ts

@@ -1,14 +0,0 @@
-declare namespace SGDS.Component {
-    namespace RadioButton {
-        interface Group extends React.AllHTMLAttributes<HTMLElement> {
-            isInline?: boolean,
-            name?: string,
-            isSmall?: boolean
-        }
-    }
-
-    interface RadioButton extends CheckboxRadioBase<HTMLInputElement> {
-        id: string,
-        name?: string
-    }
-}

package/@types/components/SearchFacets.d.ts

@@ -1,18 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SearchFacets {
-        interface Group extends React.AllHTMLAttributes<HTMLElement> {
-            joinContent?: string,
-            title: string
-        }
-
-        interface Item extends React.AllHTMLAttributes<HTMLElement> {
-            accessibleName?: string
-            joinContent?: string
-            title: string
-        }
-    }
-
-    interface SearchFacets extends React.AllHTMLAttributes<HTMLElement> {
-        headingId?: string
-    }
-}

package/@types/components/SearchFilters.d.ts

@@ -1,14 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SearchFilters {
-        interface Panel extends  React.AllHTMLAttributes<HTMLElement> {
-            activeFilterCount?: number,
-            heading: string | React.ReactNode
-            isScrollable?: boolean,
-            legend: string,
-        }
-    }
-
-    interface SearchFilters extends React.AllHTMLAttributes<HTMLElement> {
-        searchResultsContainerId?: string
-    }
-}

package/@types/components/SearchResult.d.ts

@@ -1,30 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SearchResult {
-        interface Content extends React.AllHTMLAttributes<HTMLElement> {
-
-        }
-
-        interface Context extends React.AllHTMLAttributes<HTMLDListElement> {
-            title: string
-        }
-
-        interface ContextItem extends React.AllHTMLAttributes<HTMLElement> {
-
-        }
-
-        interface Media extends React.AllHTMLAttributes<HTMLElement> {
-
-        }
-
-        interface Meta extends React.AllHTMLAttributes<HTMLElement> {
-        }
-    }
-
-    interface SearchResult extends React.AllHTMLAttributes<HTMLElement> {
-        href: string,
-        isPromoted?: boolean,
-        linkComponent?: SGDS.LinkComponent,
-        promotedTitle?: string,
-        title: string
-    }
-}

package/@types/components/SearchSort.d.ts

@@ -1,9 +0,0 @@
-declare namespace SGDS.Component {
-    interface SearchSort extends React.AllHTMLAttributes<HTMLElement> {
-        children: React.ReactNode;
-        className?: string;
-        id?: string;
-        label?: string;
-        onApply?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
-    }
-}

package/@types/components/Select.d.ts

@@ -1,7 +0,0 @@
-declare namespace SGDS.Component {
-    interface Select extends FormFieldBase<HTMLDivElement> {
-        defaultValue?: string,
-        placeholder?: string,
-        width?: InputWidth
-    }
-}

package/@types/components/SequentialNavigation.d.ts

@@ -1,14 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SequentialNavigation {
-        interface Link extends React.AllHTMLAttributes<HTMLDivElement> {
-            href: string,
-            isPrev?: boolean,
-            linkComponent?: SGDS.LinkComponent,
-            textLabel: string
-        }
-    }
-
-    interface SequentialNavigation extends React.AllHTMLAttributes<HTMLElement> {
-        ariaLabel?: React.AriaAttributes['aria-label']
-    }
-}

package/@types/components/SideNavigation.d.ts

@@ -1,18 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SideNavigation {
-        interface List extends React.AllHTMLAttributes<HTMLUListElement> {
-            isRoot?: boolean
-        }
-
-        interface Item extends React.AllHTMLAttributes<HTMLLIElement> {
-            isCurrent?: boolean,
-            href: string,
-            linkComponent?: SGDS.LinkComponent,
-            title: string,
-        }
-    }
-
-    interface SideNavigation extends React.AllHTMLAttributes<HTMLElement> {
-        ariaLabel?: string
-    }
-}

package/@types/components/SiteFooter.d.ts

@@ -1,25 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SiteFooter {
-        interface Links extends React.AllHTMLAttributes<HTMLUListElement> {
-        }
-
-        interface Link extends React.AllHTMLAttributes<HTMLLIElement> {
-            href?: string,
-            linkComponent?: SGDS.LinkComponent
-        }
-
-        interface License extends React.AllHTMLAttributes<HTMLDivElement> {
-            href?: string,
-            logoSrc?: string
-        }
-
-        interface Org extends React.AllHTMLAttributes<HTMLDivElement> {
-            href?: string,
-            title: string
-        }
-    }
-
-    interface SiteFooter extends React.AllHTMLAttributes<HTMLElement> {
-
-    }
-}

package/@types/components/SiteHeader.d.ts

@@ -1,20 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SiteHeader {
-        interface Brand extends React.AllHTMLAttributes<HTMLElement> {
-            homeUrl: string,
-            linkComponent?: SGDS.LinkComponent,
-            siteTitle?: string
-        }
-    }
-    interface SiteHeader extends React.AllHTMLAttributes<HTMLHeadingElement> {
-        logo?: {
-            alt?: string,
-            href?: string,
-            src?: string
-        },
-        navigationItems: SGDS.Component.SiteNavigation.Item[],
-        phaseBanner?: SGDS.Component.PhaseBanner,
-        siteSearch?: SGDS.Component.SiteSearch,
-        siteTitle?: string
-    }
-}

package/@types/components/SiteNavigation.d.ts

@@ -1,13 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SiteNavigation {
-        interface Item extends React.AllHTMLAttributes<HTMLLIElement> {
-            isCurrent?: boolean,
-            href: string,
-            linkComponent?: SGDS.LinkComponent
-        }
-    }
-
-    interface SiteNavigation extends React.AllHTMLAttributes<HTMLElement> {
-        ref?: React.RefObject<null>
-    }
-}

package/@types/components/SiteSearch.d.ts

@@ -1,14 +0,0 @@
-declare namespace SGDS.Component {
-    type FormMethods = 'GET' | 'POST';
-
-    interface SiteSearch extends React.AllHTMLAttributes<HTMLInputElement> {
-        action?: string,
-        autocompleteEndpoint?: string,
-        autocompleteSuggestionMappingFunction?: Function,
-        id: string,
-        method?: FormMethods,
-        minLength?: number,
-        name?: string,
-        placeholder?: string
-    }
-}

package/@types/components/SkipLinks.d.ts

@@ -1,13 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SkipLinks {
-        interface Link extends React.AllHTMLAttributes<HTMLLIElement> {
-            fragmentId: string
-        }
-    }
-
-    interface SkipLinks extends React.AllHTMLAttributes<HTMLDivElement> {
-        mainContentId?: string,
-        mainLinkText?: string,
-        isStatic?: boolean
-    }
-}

package/@types/components/SummaryCard.d.ts

@@ -1,6 +0,0 @@
-declare namespace SGDS.Component {
-    interface SummaryCard extends React.AllHTMLAttributes<HTMLElement> {
-        headingLevel?: SGDS.HeadingLevel,
-        title: string
-    }
-}

package/@types/components/SummaryList.d.ts

@@ -1,14 +0,0 @@
-declare namespace SGDS.Component {
-    namespace SummaryList {
-        interface Answer extends React.AllHTMLAttributes<HTMLElement> {
-        }
-
-        interface Item extends React.LiHTMLAttributes<HTMLLIElement> {
-            title: string
-        }
-    }
-
-    interface SummaryList extends React.OlHTMLAttributes<HTMLOListElement> {
-        isBorderless?: boolean
-    }
-}

package/@types/components/Table.d.ts

@@ -1,8 +0,0 @@
-declare namespace SGDS.Component {
-    type SmallScreen = 'scrolling' | 'boxes';
-
-    interface Table extends React.AllHTMLAttributes<HTMLTableElement> {
-        className?: string,
-        smallscreen?: SmallScreen
-    }
-}

package/@types/components/Tabs.d.ts

@@ -1,21 +0,0 @@
-declare namespace SGDS.Component {
-    namespace Tabs {
-        interface Item extends React.AllHTMLAttributes<HTMLElement> {
-            isBorderless?: boolean,
-            id: string,
-            tabLabel: string
-        }
-
-        interface TabListItem extends React.AllHTMLAttributes<HTMLLIElement> {
-            href: string
-        }
-    }
-
-    interface Tabs extends React.AllHTMLAttributes<HTMLElement> {
-        baseId: string,
-        isBorderless?: boolean,
-        headingLevel?: SGDS.HeadingLevel,
-        isManual?: boolean,
-        title: string
-    }
-}

package/@types/components/Tag.d.ts

@@ -1,5 +0,0 @@
-declare namespace SGDS.Component {
-    interface Tag extends React.AllHTMLAttributes<HTMLElement> {
-        colour?: TagColour
-    }
-}

package/@types/components/TaskList.d.ts

@@ -1,22 +0,0 @@
-declare namespace SGDS.Component {
-    namespace TaskList {
-        interface Group extends React.AllHTMLAttributes<HTMLElement> {
-            intro?: string,
-            title: string
-        }
-
-        interface Item extends React.AllHTMLAttributes<HTMLElement> {
-            href?: string,
-            id?: string,
-            isComplete?: boolean,
-            linkComponent?: SGDS.LinkComponent,
-            statusText?: string,
-            tagColour?: TagColour,
-            title: string
-        }
-    }
-
-    interface TaskList extends React.AllHTMLAttributes<HTMLElement> {
-        headingId?: string
-    }
-}

package/@types/components/TextInput.d.ts

@@ -1,12 +0,0 @@
-declare namespace SGDS.Component {
-    interface TextInput extends TextInputBase<HTMLInputElement> {
-        buttonIcon?: IconName,
-        buttonText?: string,
-        className?: string,
-        currencySymbol?: string,
-        hasButton?: boolean,
-        isCurrency?: boolean,
-        type?: string,
-        width?: InputWidth
-    }
-}

package/@types/components/Textarea.d.ts

@@ -1,4 +0,0 @@
-declare namespace SGDS.Component {
-    interface Textarea extends TextInputBase<HTMLTextAreaElement> {
-    }
-}

package/@types/components/WarningText.d.ts

@@ -1,5 +0,0 @@
-declare namespace SGDS.Component {
-    interface WarningText extends React.AllHTMLAttributes<HTMLElement> {
-
-    }
-}

package/@types/global.d.ts

@@ -1 +0,0 @@
-import React from 'react'

package/@types/sgds.d.ts

@@ -1,49 +0,0 @@
-declare namespace SGDS {
-    type HeadingLevel = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
-    type IconName = 'ArrowUpward' | 'CalendarToday' | 'Cancel' | 'CheckCircle' | 'ChevronLeft' | 'ChevronRight' | 'Close' | 'Description' | 'DoubleChevronLeft' | 'DoubleChevronRight' | 'Error' | 'ExpandLess' | 'ExpandMore' | 'List' | 'Menu' | 'PriorityHigh' | 'Search';
-    type DocumentIconName = 'Audio' | 'Csv' | 'Excel' | 'File' | 'Generic' | 'Geodata' | 'Ical' | 'Ico' | 'Image' | 'Odf' | 'Odg' | 'Odp' | 'Ods' | 'Odt' | 'Pdf' | 'Ppt' | 'Rtf' | 'Text' | 'Video' | 'Word' | 'Xml' | 'Zip';
-    type InputWidth = 'fixed-20' | 'fixed-10' | 'fixed-5' | 'fixed-4' | 'fixed-3' | 'fixed-2' | 'fluid-three-quarters' | 'fluid-two-thirds' | 'fluid-half' | 'fluid-one-third' | 'fluid-one-quarter';
-    type TagColour = 'grey' | 'green' | 'teal' | 'blue' | 'purple' | 'pink' | 'red' | 'orange' | 'yellow';
-    type TextInputType = 'date' | 'datetime-local' | 'email' | 'month' | 'number' | 'password' | 'search' | 'tel' | 'text' | 'time' | 'url' | 'week';
-
-    type LinkComponent = (linkComponent: LinkComponentProps) => React.ReactNode;
-
-    type LinkComponentProps = {
-        'aria-label'?: React.AriaAttributes['aria-label'],
-        'aria-current'?: React.AriaAttributes['aria-current'];
-        'aria-describedby'?: React.AriaAttributes['aria-describedby'];
-        children?: React.ReactNode,
-        className?: string,
-        href?: string,
-        onClick?: React.EventHandler<any>
-    }
-
-    interface CheckboxRadioBase<T> extends React.AllHTMLAttributes<T> {
-        checked?: boolean,
-        hintText?: string,
-        id?: string,
-        label: string,
-        name?: string,
-        onBlur?: React.EventHandler<any>,
-        onChange?: React.EventHandler<any>,
-        isSmall?: boolean
-    }
-
-    interface FormFieldBase<T> extends React.AllHTMLAttributes <T> {
-        errorMessage?: string,
-        hasError?: boolean,
-        id: string,
-        hintText?: string,
-        label: string,
-        name?: string,
-        onBlur?: React.EventHandler<any>,
-        onChange?: React.EventHandler<any>
-    }
-
-    interface TextInputBase<T> extends FormFieldBase<T> {
-        countThreshold?: number,
-        maxlength?: number,
-        placeholder?: string,
-        value?: string
-    }
-}

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * as common from './common';
-export * as components from './components';
-export * as hooks from './hooks';
-export * as images from './images';