@motech-development/breeze-ui 2.4.0 → 3.0.1

package/lib/index.d.ts

@@ -1,489 +0,0 @@
-import * as react from 'react';
-import { ReactNode, FC, HTMLAttributes, ButtonHTMLAttributes, ChangeEvent, TdHTMLAttributes } from 'react';
-import * as styled_components from 'styled-components';
-import { FormikProps, FormikValues } from 'formik';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ObjectSchema } from 'yup';
-import { LinkProps } from 'react-router-dom';
-
-type AlertSpacing = 'sm' | 'md' | 'lg';
-declare const alertTheme: {
-    danger: {
-        background: string;
-        colour: string;
-    };
-    primary: {
-        background: string;
-        colour: string;
-    };
-    secondary: {
-        background: string;
-        colour: string;
-    };
-    success: {
-        background: string;
-        colour: string;
-    };
-};
-type AlertTheme = keyof typeof alertTheme;
-interface IAlertProps {
-    colour?: AlertTheme;
-    dismissable?: boolean | number;
-    icon?: ReactNode;
-    message: string;
-    spacing?: AlertSpacing;
-    onDismiss?: () => void;
-}
-declare const Alert: FC<IAlertProps>;
-
-interface IAppBarTheme {
-    [name: string]: {
-        background: string;
-        border: string;
-        colour: string;
-    };
-}
-declare const appBarTheme: IAppBarTheme;
-interface IAppBarProps {
-    children: ReactNode;
-    colour?: keyof typeof appBarTheme;
-    element?: 'header' | 'div';
-    fixed?: boolean;
-}
-declare const AppBar: FC<IAppBarProps>;
-
-interface IAvatarProps {
-    alt: string;
-    src: string;
-    width?: number;
-}
-declare const Avatar: FC<IAvatarProps>;
-
-declare const BaseStyles: styled_components.GlobalStyleComponent<{}, styled_components.DefaultTheme>;
-
-interface IBreakpoint {
-    children: ReactNode;
-    lg?: boolean;
-    md?: boolean;
-    sm?: boolean;
-    xs?: boolean;
-}
-declare const Breakpoint: FC<IBreakpoint>;
-
-declare const buttonTheme: {
-    danger: {
-        background: string;
-        colour: string;
-    };
-    primary: {
-        background: string;
-        colour: string;
-    };
-    secondary: {
-        background: string;
-        colour: string;
-    };
-    success: {
-        background: string;
-        colour: string;
-    };
-};
-type ButtonColour = keyof typeof buttonTheme;
-interface IBaseButtonProps {
-    block?: boolean;
-    colour?: ButtonColour;
-    size?: 'sm' | 'md' | 'lg';
-}
-
-interface IButtonProps extends IBaseButtonProps, HTMLAttributes<HTMLButtonElement> {
-    block?: boolean;
-    disabled?: boolean;
-    loading?: boolean;
-    type?: 'submit' | 'reset' | 'button';
-}
-declare const Button: FC<IButtonProps>;
-
-declare const ButtonLink: FC<ButtonHTMLAttributes<HTMLButtonElement>>;
-
-interface ICalendarProps {
-    selectedDate?: string;
-    id: string;
-    onDateChange: (date: string) => void;
-}
-declare const Calendar: FC<ICalendarProps>;
-
-declare const cardTheme: {
-    lg: {
-        padding: string;
-    };
-    md: {
-        padding: string;
-    };
-    none: {
-        padding: string;
-    };
-    sm: {
-        padding: string;
-    };
-};
-type CardPadding = keyof typeof cardTheme;
-interface ICardProps {
-    children: ReactNode;
-    padding?: CardPadding;
-}
-declare const Card: FC<ICardProps>;
-
-type CheckBoxSpacing = 'sm' | 'md' | 'lg';
-interface ICheckBoxProps {
-    disabled?: boolean;
-    helpText?: string;
-    label: string;
-    legend: string;
-    name: string;
-    readOnly?: boolean;
-    spacing?: CheckBoxSpacing;
-    onChange?: (e: ChangeEvent<HTMLInputElement>, form: FormikProps<FormikValues>) => void;
-}
-declare const CheckBox: FC<ICheckBoxProps>;
-
-interface IColProps {
-    children: ReactNode;
-    align?: 'centre' | 'left' | 'right';
-    lg?: number;
-    lgOffset?: number;
-    md?: number;
-    mdOffset?: number;
-    sm?: number;
-    smOffset?: number;
-    verticalAlign?: 'middle';
-    xs?: number;
-    xsOffset?: number;
-}
-declare const Col: FC<IColProps>;
-
-interface IContentProps {
-    children: ReactNode;
-}
-declare const Content: FC<IContentProps>;
-
-type DataTableTheme = 'default' | 'primary' | 'secondary';
-interface IDataTableProps<T> {
-    header?: ReactNode;
-    items: T[];
-    noResults: ReactNode;
-    theme?: DataTableTheme;
-    row: (item: T) => ReactNode;
-}
-declare function DataTable<T>({ header, items, noResults, row, theme, }: IDataTableProps<T>): JSX.Element;
-
-type InputSpacing = 'sm' | 'md' | 'lg';
-interface ITextBoxProps {
-    decimalScale?: number;
-    disabled?: boolean;
-    format?: string;
-    helpText?: string;
-    label: string;
-    name: string;
-    placeholder?: string;
-    prefix?: string;
-    readOnly?: boolean;
-    spacing?: InputSpacing;
-    suffix?: string;
-    type?: 'email' | 'number' | 'password' | 'text';
-    onChange?: (e: ChangeEvent<HTMLInputElement>, form: FormikProps<FormikValues>) => Promise<void> | void;
-}
-declare const TextBox: FC<ITextBoxProps>;
-
-interface IDatePickerProps {
-    disabled?: boolean;
-    helpText?: string;
-    label: string;
-    name: string;
-    readOnly?: boolean;
-    spacing?: InputSpacing;
-}
-declare const DatePicker: FC<IDatePickerProps>;
-
-interface IFormatDateTime {
-    ISOString: string;
-    formatted: string;
-}
-declare const formatDateTime: (value: string | number, format?: string) => IFormatDateTime;
-interface IDateTimeProps {
-    format?: string;
-    value: string | number;
-}
-declare const DateTime: FC<IDateTimeProps>;
-
-type FileUploadSpacing = 'sm' | 'md' | 'lg';
-interface IFileUploadProps {
-    accept?: string;
-    buttonText: string;
-    disabled?: boolean;
-    helpText?: string;
-    label: string;
-    loading?: boolean;
-    name: string;
-    spacing?: FileUploadSpacing;
-    onSelect: (file: File, form: FormikProps<FormikValues>) => void | Promise<void>;
-}
-declare const FileUpload: FC<IFileUploadProps>;
-
-interface IFormProps<T extends FormikValues = FormikValues> {
-    children: ReactNode;
-    cancel?: ReactNode;
-    initialValues: T;
-    loading?: boolean;
-    onPreSubmit?: (values: T) => T | Promise<T>;
-    onSubmit: (values: T) => void | Promise<void>;
-    submitLabel: string;
-    validationSchema: ObjectSchema<T>;
-}
-declare function Form<T extends FormikValues = FormikValues>({ children, cancel, initialValues, loading, onPreSubmit, onSubmit, submitLabel, validationSchema, }: IFormProps<T>): react_jsx_runtime.JSX.Element;
-
-type TUseBreakpoint = 'xs' | 'sm' | 'md' | 'lg';
-declare const useBreakpoint: () => TUseBreakpoint;
-
-type Handler = (event: globalThis.MouseEvent | TouchEvent) => void;
-declare const useOutsideClick: (ref: HTMLElement | null, handler: Handler) => void;
-
-interface IUseWindowSize {
-    height: number;
-    width: number;
-}
-declare const useWindowSize: () => IUseWindowSize;
-
-declare const Link: FC<LinkProps>;
-
-interface ILinkButtonProps extends IBaseButtonProps, LinkProps {
-    block?: boolean;
-}
-declare const LinkButton: FC<ILinkButtonProps>;
-
-interface ILoaderProps {
-    className?: string;
-    colour?: 'default' | 'secondary';
-}
-declare const Loader: FC<ILoaderProps>;
-
-interface IMasonryProps {
-    children: ReactNode | ReactNode[];
-    gutter?: string;
-    lg: number;
-    md: number;
-    sm: number;
-    xs: number;
-}
-declare const Masonry: FC<IMasonryProps>;
-
-type TModalSize = 'sm' | 'lg';
-interface IModalProps {
-    children: ReactNode;
-    isOpen: boolean;
-    size?: TModalSize;
-    title: string;
-    onDismiss: () => void;
-}
-declare const Modal: FC<IModalProps>;
-
-type Placement = 'bottom' | 'bottom-end' | 'bottom-start';
-interface INotificationsProps<T> {
-    alert: boolean;
-    cols?: number;
-    items: T[];
-    label: string;
-    noResults: ReactNode;
-    placement?: Placement;
-    row: (item: T) => ReactNode;
-    onClose: () => void | Promise<void>;
-}
-declare function Notifications<T>({ alert, cols, items, label, noResults, onClose, placement, row, }: INotificationsProps<T>): JSX.Element;
-
-declare const Overlay: styled_components.StyledComponent<"div", styled_components.DefaultTheme, {}, never>;
-
-interface IPageTitleProps {
-    subTitle?: string;
-    title: string;
-}
-declare const PageTitle: FC<IPageTitleProps>;
-
-interface IProgressBarProps {
-    max?: number;
-    progress: number;
-}
-declare const ProgressBar: FC<IProgressBarProps>;
-
-type RadioSpacing = 'sm' | 'md' | 'lg';
-interface IRadioOption {
-    name: string;
-    value: string;
-}
-interface IRadioProps {
-    disabled?: boolean;
-    helpText?: string;
-    label: string;
-    name: string;
-    options: IRadioOption[];
-    readOnly?: boolean;
-    spacing?: RadioSpacing;
-    onChange?: (e: ChangeEvent<HTMLInputElement>, form: FormikProps<FormikValues>) => void;
-}
-declare const Radio: FC<IRadioProps>;
-
-interface IRowProps {
-    children: ReactNode;
-    columns?: number;
-    gutter?: string;
-}
-type TRowData<TInput, TOutput> = (input: TInput) => FC<TOutput>;
-declare const Row: FC<IRowProps>;
-
-declare const ScrollToTop: FC;
-
-type SelectSpacing = 'sm' | 'md' | 'lg';
-interface ISelectOption {
-    name: string;
-    value: string;
-}
-interface ISelectProps {
-    disabled?: boolean;
-    helpText?: string;
-    label: string;
-    name: string;
-    options: ISelectOption[];
-    placeholder: string;
-    readOnly?: boolean;
-    spacing?: SelectSpacing;
-    onChange?: (e: ChangeEvent<HTMLSelectElement>, form: FormikProps<FormikValues>) => void;
-}
-declare const Select: FC<ISelectProps>;
-
-interface IStepperProps {
-    children: ReactNode[];
-    nextLabel: string;
-    onComplete?: ReactNode;
-    onStart?: ReactNode;
-    previousLabel: string;
-    start?: number;
-    enableNext?: (step: number) => boolean;
-}
-declare const Stepper: FC<IStepperProps>;
-
-interface ITableProps extends HTMLAttributes<HTMLTableElement> {
-    children: ReactNode;
-    fixed?: boolean;
-}
-declare const Table: FC<ITableProps>;
-
-declare const TableBody: styled_components.StyledComponent<"tbody", styled_components.DefaultTheme, {}, never>;
-
-interface ITableCellProps extends TdHTMLAttributes<HTMLTableDataCellElement> {
-    as?: 'td' | 'th';
-    noWrap?: boolean;
-}
-declare const TableCell: FC<ITableCellProps>;
-
-declare const TableHead: styled_components.StyledComponent<"thead", styled_components.DefaultTheme, {}, never>;
-
-declare const tableRowTheme: {
-    default: {
-        background: string;
-        border: string;
-        colour: string;
-    };
-    primary: {
-        background: string;
-        border: string;
-        colour: string;
-    };
-    secondary: {
-        background: string;
-        border: string;
-        colour: string;
-    };
-};
-interface ITableRowProps extends HTMLAttributes<HTMLTableRowElement> {
-    colour?: keyof typeof tableRowTheme;
-}
-declare const TableRow: FC<ITableRowProps>;
-
-interface IAddToast {
-    colour: AlertTheme;
-    message: string;
-    onDismiss?: () => void;
-}
-interface IToastContext {
-    add: (alert: IAddToast) => void;
-    remove: (id: string) => void;
-}
-declare const ToastContext: react.Context<IToastContext | null>;
-declare const useToast: () => IToastContext;
-interface IToastProviderProps {
-    children: ReactNode;
-}
-declare const ToastProvider: FC<IToastProviderProps>;
-
-declare const tooltipTheme: {
-    danger: {
-        background: string;
-        colour: string;
-    };
-    primary: {
-        background: string;
-        colour: string;
-    };
-    secondary: {
-        background: string;
-        colour: string;
-    };
-    success: {
-        background: string;
-        colour: string;
-    };
-};
-type TooltipPlacement = 'auto-start' | 'auto' | 'auto-end' | 'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-end' | 'bottom' | 'bottom-start' | 'left-end' | 'left' | 'left-start';
-interface ITooltipProps {
-    colour?: keyof typeof tooltipTheme;
-    id: string;
-    message: ReactNode;
-    parent: ReactNode;
-    placement: TooltipPlacement;
-}
-declare const Tooltip: FC<ITooltipProps>;
-
-interface ITypeaheadSuggestion {
-    name: string;
-    value: string;
-}
-interface ITypeaheadProps extends Omit<ITextBoxProps, 'type' | 'onChange'> {
-    suggestions: ITypeaheadSuggestion[];
-}
-declare const Typeahead: FC<ITypeaheadProps>;
-
-declare const margins: {
-    lg: number;
-    md: number;
-    none: number;
-    sm: number;
-};
-type TypographyVariants = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p';
-interface ITypographyProps {
-    align?: 'left' | 'right' | 'center';
-    breakWord?: boolean;
-    children: ReactNode;
-    className?: string;
-    component: TypographyVariants;
-    id?: string;
-    margin?: keyof typeof margins;
-    rule?: boolean;
-    truncate?: boolean;
-    variant: TypographyVariants | 'lead';
-}
-declare const Typography: FC<ITypographyProps>;
-
-interface IWindowProps {
-    children: ReactNode;
-}
-declare const Window: FC<IWindowProps>;
-
-export { Alert, type AlertTheme, AppBar, Avatar, BaseStyles, Breakpoint, Button, ButtonLink, Calendar, Card, CheckBox, Col, Content, DataTable, DatePicker, DateTime, FileUpload, Form, type IAddToast, type IAlertProps, type IAppBarProps, type IAvatarProps, type IButtonProps, type ICalendarProps, type ICardProps, type ICheckBoxProps, type IColProps, type IContentProps, type IDataTableProps, type IDatePickerProps, type IDateTimeProps, type IFileUploadProps, type IFormProps, type ILinkButtonProps, type ILoaderProps, type IMasonryProps, type IModalProps, type INotificationsProps, type IPageTitleProps, type IProgressBarProps, type IRadioOption, type IRadioProps, type IRowProps, type ISelectOption, type ISelectProps, type IStepperProps, type ITableCellProps, type ITableProps, type ITableRowProps, type ITextBoxProps, type ITypeaheadProps, type ITypeaheadSuggestion, type ITypographyProps, type IWindowProps, Link, LinkButton, Loader, Masonry, Modal, Notifications, Overlay, PageTitle, ProgressBar, Radio, Row, ScrollToTop, Select, Stepper, type TRowData, Table, TableBody, TableCell, TableHead, TableRow, TextBox, ToastContext, ToastProvider, Tooltip, Typeahead, Typography, Window, formatDateTime, useBreakpoint, useOutsideClick, useToast, useWindowSize };