@uniformdev/design-system 13.0.1-alpha.96

package/dist/index.d.ts

@@ -0,0 +1,257 @@
+import * as React$1 from 'react';
+import React__default, { ReactNode } from 'react';
+import * as _emotion_react from '@emotion/react';
+import { SerializedStyles } from '@emotion/react';
+import { ButtonProps as ButtonProps$1 } from 'reakit/Button';
+import { IconBaseProps, IconType } from 'react-icons';
+import * as _emotion_react_types_jsx_namespace from '@emotion/react/types/jsx-namespace';
+import { MenuHTMLProps, MenuProps as MenuProps$1, MenuStateReturn } from 'reakit/Menu';
+import { MenuItemHTMLProps } from 'reakit';
+
+declare type ThemeProps = {
+    disableReset?: boolean;
+};
+declare const Theme: React__default.ElementType;
+
+declare const input: _emotion_react.SerializedStyles;
+declare const inputError: _emotion_react.SerializedStyles;
+declare const inputSelect: _emotion_react.SerializedStyles;
+
+declare const scrollbarStyles: _emotion_react.SerializedStyles;
+
+declare type ButtonThemeProps = 'primary' | 'secondary' | 'tertiary' | 'unimportant' | 'ghost';
+declare type ButtonSizeProps = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+declare type ButtonProps = ButtonProps$1 & {
+    buttonType?: ButtonThemeProps;
+    /**
+     * @deprecated size might no longer be used as we are trying to consolidate button designs
+     */
+    size?: ButtonSizeProps;
+    /**
+     * @deprecated rounded is no longer used
+     */
+    rounded?: boolean;
+};
+/**
+ * Button component
+ * @component
+ * @param {string} buttonType - sets the theme of the button
+ * @param {BaseButtonProps} props - object of button props from reakit
+ * @param {React.ReactNode} children - react child elements
+ * @returns (
+ *  <Button buttonType="secondary" onClick={() => alert('hello button')}>Click me</Button>
+ * )
+ */
+declare const Button: React$1.FC<ButtonProps>;
+
+declare const iconNames: readonly ["add-r", "add", "airplane", "alarm", "album", "align-bottom", "align-center", "align-left", "align-middle", "align-right", "align-top", "anchor", "apple-watch", "arrange-back", "arrange-front", "arrow-align-h", "arrow-align-v", "arrow-bottom-left-o", "arrow-bottom-left-r", "arrow-bottom-left", "arrow-bottom-right-o", "arrow-bottom-right-r", "arrow-bottom-right", "arrow-down-o", "arrow-down-r", "arrow-down", "arrow-left-o", "arrow-left-r", "arrow-left", "arrow-long-down-c", "arrow-long-down-e", "arrow-long-down-l", "arrow-long-down-r", "arrow-long-down", "arrow-long-left-c", "arrow-long-left-e", "arrow-long-left-l", "arrow-long-left-r", "arrow-long-left", "arrow-long-right-c", "arrow-long-right-e", "arrow-long-right-l", "arrow-long-right-r", "arrow-long-right", "arrow-long-up-c", "arrow-long-up-e", "arrow-long-up-l", "arrow-long-up-r", "arrow-long-up", "arrow-right-o", "arrow-right-r", "arrow-right", "arrow-top-left-o", "arrow-top-left-r", "arrow-top-left", "arrow-top-right-o", "arrow-top-right-r", "arrow-top-right", "arrow-up-o", "arrow-up-r", "arrow-up", "arrows-breake-h", "arrows-breake-v", "arrows-exchange-alt-v", "arrows-exchange-alt", "arrows-exchange-v", "arrows-exchange", "arrows-expand-down-left", "arrows-expand-down-right", "arrows-expand-left-alt", "arrows-expand-left", "arrows-expand-right-alt", "arrows-expand-right", "arrows-expand-up-left", "arrows-expand-up-right", "arrows-h-alt", "arrows-h", "arrows-merge-alt-h", "arrows-merge-alt-v", "arrows-scroll-h", "arrows-scroll-v", "arrows-shrink-h", "arrows-shrink-v", "arrows-v-alt", "arrows-v", "assign", "asterisk", "attachment", "attribution", "awards", "backspace", "band-aid", "battery-empty", "battery-full", "battery", "bee", "bell", "bitbucket", "block", "board", "bolt", "bookmark", "border-all", "border-bottom", "border-left", "border-right", "border-style-dashed", "border-style-dotted", "border-style-solid", "border-top", "bot", "bowl", "box", "boy", "briefcase", "browse", "browser", "brush", "bulb", "c-plus-plus", "calculator", "calendar-dates", "calendar-due", "calendar-next", "calendar-today", "calendar-two", "calendar", "calibrate", "camera", "cap", "captions", "card-clubs", "card-diamonds", "card-hearts", "card-spades", "carousel", "cast", "chart", "check-o", "check-r", "check", "chevron-double-down-o", "chevron-double-down-r", "chevron-double-down", "chevron-double-left-o", "chevron-double-left-r", "chevron-double-left", "chevron-double-right-o", "chevron-double-right-r", "chevron-double-right", "chevron-double-up-o", "chevron-double-up-r", "chevron-double-up", "chevron-down-o", "chevron-down-r", "chevron-down", "chevron-left-o", "chevron-left-r", "chevron-left", "chevron-right-o", "chevron-right-r", "chevron-right", "chevron-up-o", "chevron-up-r", "chevron-up", "clapper-board", "clipboard", "close-o", "close-r", "close", "cloud", "code-slash", "code", "coffee", "collage", "color-bucket", "color-picker", "comment", "community", "components", "compress-left", "compress-right", "compress-v", "compress", "controller", "copy", "copyright", "corner-double-down-left", "corner-double-down-right", "corner-double-left-down", "corner-double-left-up", "corner-double-right-down", "corner-double-right-up", "corner-double-up-left", "corner-double-up-right", "corner-down-left", "corner-down-right", "corner-left-down", "corner-left-up", "corner-right-down", "corner-right-up", "corner-up-left", "corner-up-right", "credit-card", "crop", "cross", "crown", "danger", "dark-mode", "data", "database", "debug", "desktop", "details-less", "details-more", "dialpad", "disc", "display-flex", "display-fullwidth", "display-grid", "display-spacing", "distribute-horizontal", "distribute-vertical", "dock-bottom", "dock-left", "dock-right", "dock-window", "dollar", "drive", "drop-invert", "drop-opacity", "drop", "duplicate", "edit-black-point", "edit-contrast", "edit-exposure", "edit-fade", "edit-flip-h", "edit-flip-v", "edit-highlight", "edit-markup", "edit-mask", "edit-noise", "edit-shadows", "edit-straight", "edit-unmask", "eject", "enter", "erase", "ereader", "ericsson", "ethernet", "euro", "expand", "export", "extension-add", "extension-alt", "extension-remove", "extension", "external", "eye-alt", "eye", "feed", "file-add", "file-document", "file-remove", "file", "film", "filters", "flag-alt", "flag", "folder-add", "folder-remove", "folder", "font-height", "font-spacing", "format-bold", "format-center", "format-color", "format-heading", "format-indent-decrease", "format-indent-increase", "format-italic", "format-justify", "format-left", "format-line-height", "format-right", "format-separator", "format-slash", "format-strike", "format-text", "format-underline", "format-uppercase", "games", "gender-female", "gender-male", "ghost-character", "gift", "girl", "git-branch", "git-commit", "git-fork", "git-pull", "glass-alt", "glass", "globe-alt", "globe", "gym", "hashtag", "headset", "heart", "home-alt", "home-screen", "home", "icecream", "image", "import", "inbox", "infinity", "info", "inpicture", "insert-after-o", "insert-after-r", "insert-after", "insert-before-o", "insert-before-r", "insert-before", "insights", "internal", "key", "keyboard", "keyhole", "laptop", "layout-grid-small", "layout-grid", "layout-list", "layout-pin", "link", "list-tree", "list", "live-photo", "loadbar-alt", "loadbar-doc", "loadbar-sound", "loadbar", "lock-unlock", "lock", "log-in", "log-off", "log-out", "loupe", "magnet", "mail-forward", "mail-open", "mail-reply", "mail", "math-divide", "math-equal", "math-minus", "math-percent", "math-plus", "maximize-alt", "maximize", "media-live", "media-podcast", "menu-boxed", "menu-cake", "menu-cheese", "menu-grid-o", "menu-grid-r", "menu-hotdog", "menu-left-alt", "menu-left", "menu-motion", "menu-oreos", "menu-right-alt", "menu-right", "menu-round", "menu", "merge-horizontal", "merge-vertical", "mic", "mini-player", "minimize-alt", "minimize", "modem", "moon", "more-alt", "more-o", "more-r", "more-vertical-alt", "more-vertical-o", "more-vertical-r", "more-vertical", "more", "mouse", "move-down", "move-left", "move-right", "move-task", "move-up", "music-note", "music-speaker", "music", "nametag", "notes", "notifications", "options", "organisation", "password", "path-back", "path-crop", "path-divide", "path-exclude", "path-front", "path-intersect", "path-outline", "path-trim", "path-unite", "pen", "pentagon-bottom-left", "pentagon-bottom-right", "pentagon-down", "pentagon-left", "pentagon-right", "pentagon-top-left", "pentagon-top-right", "pentagon-up", "performance", "phone", "photoscan", "piano", "pill", "pin-alt", "pin-bottom", "pin-top", "pin", "play-backwards", "play-button-o", "play-button-r", "play-button", "play-forwards", "play-list-add", "play-list-check", "play-list-remove", "play-list-search", "play-list", "play-pause-o", "play-pause-r", "play-pause", "play-stop-o", "play-stop-r", "play-stop", "play-track-next-o", "play-track-next-r", "play-track-next", "play-track-prev-o", "play-track-prev-r", "play-track-prev", "plug", "polaroid", "poll", "presentation", "printer", "profile", "pull-clear", "push-chevron-down-o", "push-chevron-down-r", "push-chevron-down", "push-chevron-left-o", "push-chevron-left-r", "push-chevron-left", "push-chevron-right-o", "push-chevron-right-r", "push-chevron-right", "push-chevron-up-o", "push-chevron-up-r", "push-chevron-up", "push-down", "push-left", "push-right", "push-up", "qr", "quote-o", "quote", "radio-check", "radio-checked", "ratio", "read", "readme", "record", "redo", "remote", "remove-r", "remove", "rename", "reorder", "repeat", "ring", "row-first", "row-last", "ruler", "sand-clock", "scan", "screen-mirror", "screen-shot", "screen-wide", "screen", "scroll-h", "scroll-v", "search-found", "search-loading", "search", "select-o", "select-r", "select", "server", "shape-circle", "shape-half-circle", "shape-hexagon", "shape-rhombus", "shape-square", "shape-triangle", "shape-zigzag", "share", "shield", "shopping-bag", "shopping-cart", "shortcut", "sidebar-open", "sidebar-right", "sidebar", "signal", "size", "sleep", "smart-home-boiler", "smart-home-cooker", "smart-home-heat", "smart-home-light", "smart-home-refrigerator", "smart-home-wash-machine", "smartphone-chip", "smartphone-ram", "smartphone-shake", "smartphone", "smile-mouth-open", "smile-neutral", "smile-no-mouth", "smile-none", "smile-sad", "smile-upside", "smile", "software-download", "software-upload", "sort-az", "sort-za", "space-between-v", "space-between", "spinner-alt", "spinner-two-alt", "spinner-two", "spinner", "stack", "stopwatch", "stories", "style", "sun", "support", "swap-vertical", "swap", "sweden", "swiss", "sync", "tab", "tag", "tap-double", "tap-single", "template", "tennis", "terminal", "terrain", "thermometer", "thermostat", "tikcode", "time", "timelapse", "timer", "today", "toggle-off", "toggle-on", "toggle-square-off", "toggle-square", "toolbar-bottom", "toolbar-left", "toolbar-right", "toolbar-top", "toolbox", "touchpad", "track", "transcript", "trash-empty", "trash", "tree", "trees", "trending-down", "trending", "trophy", "tv", "ui-kit", "umbrella", "unavailable", "unblock", "undo", "unsplash", "usb-c", "usb", "user-add", "user-list", "user-remove", "user", "view-cols", "view-comfortable", "view-day", "view-grid", "view-list", "view-month", "view-split", "vinyl", "voicemail-o", "voicemail-r", "voicemail", "volume", "webcam", "website", "work-alt", "yinyang", "zoom-in", "zoom-out"];
+declare type IconName = typeof iconNames[number];
+
+declare type IconColorProps = 'green' | 'red' | 'gray' | 'currentColor';
+interface IconProps extends IconBaseProps {
+    icon: IconName | IconType;
+    iconColorClass?: IconColorProps;
+}
+declare const Icon: React__default.NamedExoticComponent<IconProps>;
+
+declare type IconsMap = Record<string, IconType>;
+declare function useIconContext(): {
+    iconsMap: IconsMap;
+    isLoading: boolean;
+};
+declare function IconsProvider({ children }: {
+    children: ReactNode;
+}): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const Caption: React$1.FC;
+
+declare type ErrorMessageProps = {
+    message?: string;
+};
+declare const ErrorMessage: ({ message }: ErrorMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
+
+declare type InputTextProps = React$1.InputHTMLAttributes<HTMLInputElement> & {
+    label?: string;
+    caption?: string;
+    icon?: React$1.ReactElement;
+    showLabel?: boolean;
+    errorMessage?: string;
+    capture?: boolean | 'user' | 'environment';
+    /** @deprecated */
+    classNameContainer?: string;
+    /** @deprecated */
+    classNameControl?: string;
+    /** @deprecated */
+    classNameLabel?: string;
+};
+/**
+ * Input Component
+ * @component
+ * @param {string} label - sets the label value
+ * @param {string} caption - sets help text value
+ * @param {boolean} showLabel - sets whether to hide the label and use aria-label on the input itself
+ * @param {React.ReactElement} icon - add an input icon to the input field
+ * @param {string} errorMessage - sets shows the the error message value
+ * @returns <Input label="my label" />
+ */
+declare const Input: ({ label, icon, id, caption, showLabel, errorMessage, classNameContainer, classNameControl, classNameLabel, ...props }: InputTextProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type InputSelectProps = React.SelectHTMLAttributes<HTMLSelectElement> & {
+    defaultOption?: string;
+    options: Array<React.OptionHTMLAttributes<HTMLOptionElement> & {
+        label: string;
+    }>;
+    caption?: string;
+    label: string;
+    showLabel?: boolean;
+    errorMessage?: string;
+    /** @deprecated */
+    classNameContainer?: string;
+    /** @deprecated */
+    classNameControl?: string;
+    /** @deprecated */
+    classNameLabel?: string;
+};
+/**
+ * Input Select Component
+ * @component
+ * @param {string} label - sets the label value
+ * @param {boolean} showLabel - sets whether to hide the label and use aria-label on the input itself
+ * @param {string} defaultOption - sets the first item in the options list with empty value
+ * @param {Array<React.OptionHTMLAttributes<HTMLOptionElement> & { label: string }>} options - sets an array of select options with value and text value
+ * @param {string} caption - sets help text value
+ * @param {string} errorMessage - sets and shows the the error message value
+ * @returns <InputSelect label="my label" options={[{label: "option 1"}, {label: "option 2"}]} />
+ */
+declare const InputSelect: ({ label, defaultOption, options, caption, errorMessage, showLabel, classNameContainer, classNameControl, classNameLabel, ...props }: InputSelectProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type InlineSelectInputOption = {
+    label: string;
+    value: string;
+};
+declare type InlineSelectInputProps = Omit<React$1.HTMLAttributes<HTMLButtonElement>, 'onChange'> & {
+    value: string;
+    options: Array<InlineSelectInputOption>;
+    onChange: (option: InlineSelectInputOption) => void;
+    disabled?: boolean;
+    classNameContainer?: SerializedStyles | string;
+};
+/**
+ * Input Inline Select
+ * @component
+ * @param {string} value - sets the selected value
+ * @param {Array<InlineSelectInputOption>} options - sets the available options within the dropdown
+ * @param {(option: InlineSelectInputOption) => void} onChange - function that takes an option argument and sets the new value
+ * @param {boolean} disabled - sets the disabled state of the button
+ * @param {SerializedStyles | string} classNameContainer - override existing styles by passing new emotion styles or a string of css props
+ * @returns <InlineSelectInput disabled={index > 1} value={currentValue ?? '&'} options={[{ label: 'AND', value: '&' }, { label: 'OR', value: '|' },]} onChange={(s) => {setState(s.value)}} />
+ */
+declare const InputInlineSelect: ({ classNameContainer, options, value, onChange, disabled, ...props }: InlineSelectInputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+interface InputKeywordSearchProps {
+    onSearchTextChanged: (searchText: string) => void;
+    disabled?: boolean;
+    placeholder?: string;
+    inputFieldName?: string;
+    disabledFieldSubmission?: boolean;
+    value?: string;
+}
+declare const InputKeywordSearch: ({ onSearchTextChanged, disabled, placeholder, inputFieldName, disabledFieldSubmission, value, }: InputKeywordSearchProps) => React$1.ReactElement;
+
+declare type InputToggleProps = React$1.HTMLAttributes<HTMLInputElement> & {
+    label: string;
+    type: 'radio' | 'checkbox';
+    name: string;
+    disabled?: boolean;
+    checked?: boolean;
+    caption?: string;
+    errorMessage?: string;
+};
+declare const InputToggle: ({ label, type, disabled, checked, name, caption, errorMessage, ...props }: InputToggleProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+interface MenuProps extends MenuHTMLProps {
+    menuTrigger: React$1.ReactElement & React$1.RefAttributes<any>;
+    menuLabel: string;
+    placement?: MenuProps$1['placement'];
+}
+declare const MenuContext: React$1.Context<MenuStateReturn>;
+declare const useMenuContext: () => MenuStateReturn;
+declare const Menu: React$1.FC<MenuProps>;
+
+declare type MenuItemProps = MenuItemHTMLProps & {
+    focusable?: boolean;
+    children: ChildFunction | React$1.ReactNode;
+    hideMenuOnClick?: boolean;
+    icon?: React$1.ReactElement;
+};
+declare type ChildFunction = (menuItemProps: MenuItemHTMLProps) => React$1.ReactElement | null;
+declare const MenuItem: React$1.FC<MenuItemProps>;
+
+declare type CalloutType = 'caution' | 'danger' | 'info' | 'note' | 'success' | 'tip' | 'error';
+interface CalloutProps {
+    type: CalloutType;
+    title?: React$1.ReactNode;
+    children: React$1.ReactNode;
+    className?: SerializedStyles | string;
+}
+/**
+ * Callout
+ * @component
+ * @param {CalloutType} type - sets the type of callout to be used
+ * @param {React.ReactNode} title - sets the title of the callout
+ * @param {React.ReactNode} children - adds child components to the callout body
+ * @param {SerializedStyles | string} className - sets a string value className or a emotion css style property for custom overrides
+ * @return <Callout title="my title" type="caution"><p>callout body copy</p></Callout>
+ */
+declare const Callout: React$1.FC<CalloutProps>;
+
+/**
+ * Loading Indicator
+ * @component
+ * @returns <LoadingIndicator />
+ */
+declare const LoadingIndicator: () => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+interface LoadingOverlayProps {
+    isActive: boolean;
+    statusMessage?: string | JSX.Element;
+}
+/**
+ * Loading Overlay
+ * @component
+ * @param {boolean} isActive - sets whether to display the loading overlay components
+ * @param {string | JSX.Element} statusMessage - optional type that sets a text value or React component under the loading icon
+ * @returns <LoadingOverlay isActive={true} statusMessage="Loading..." />
+ */
+declare const LoadingOverlay: React__default.FC<LoadingOverlayProps>;
+interface LoadingIconProps {
+    width?: number;
+    height?: number;
+}
+/**
+ * Loading Icon
+ * @component
+ * @param {number} height - option prop that sets a number value for the height of the icon
+ * @param {number} width - option prop that sets a number value for the width of the icon
+ * @returns <LoadingIcon height={128} width={128} />
+ */
+declare const LoadingIcon: React__default.FC<LoadingIconProps>;
+
+declare type LevelProps = 1 | 2 | 3 | 4 | 5 | 6;
+declare type HeadingProps = {
+    level?: LevelProps;
+};
+declare const Heading: React$1.FC<HeadingProps>;
+
+declare type breakpointSizeProps = 'sm' | 'md' | 'lg' | 'xl' | '2xl';
+declare type breakpointsProps = Record<breakpointSizeProps, string>;
+declare const breakpoints: breakpointsProps;
+/**
+ * Media Query Helper Function
+ * @function
+ * @param {string} size - The responsive breakpoint value
+ * @returns {string} - compiled media query e.g. (min-width: 640px)
+ */
+declare const mq: (size: breakpointSizeProps) => string;
+
+export { Button, ButtonProps, ButtonSizeProps, ButtonThemeProps, Callout, CalloutProps, CalloutType, Caption, ChildFunction, ErrorMessage, ErrorMessageProps, Heading, HeadingProps, Icon, IconColorProps, IconProps, IconsProvider, InlineSelectInputOption, InlineSelectInputProps, Input, InputInlineSelect, InputKeywordSearch, InputKeywordSearchProps, InputSelect, InputSelectProps, InputTextProps, InputToggle, InputToggleProps, LevelProps, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, Menu, MenuContext, MenuItem, MenuItemProps, MenuProps, Theme, ThemeProps, breakpointSizeProps, breakpoints, breakpointsProps, input, inputError, inputSelect, mq, scrollbarStyles, useIconContext, useMenuContext };