@uniformdev/design-system 13.0.1-alpha.311 → 16.0.1-alpha.128
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/index.js +267 -101
- package/dist/index.d.ts +268 -149
- package/dist/index.js +288 -122
- package/package.json +15 -14
package/dist/index.d.ts
CHANGED
|
@@ -11,19 +11,29 @@ import InternalSelect from 'react-select/dist/declarations/src/Select';
|
|
|
11
11
|
import { MenuHTMLProps, MenuProps as MenuProps$1, MenuStateReturn } from 'reakit/Menu';
|
|
12
12
|
import { MenuItemHTMLProps, MenuProps as MenuProps$2 } from 'reakit';
|
|
13
13
|
|
|
14
|
+
/** @todo: line 144 onwards will be brought into a title, paragraph, list and link components */
|
|
14
15
|
declare type ThemeProps = {
|
|
16
|
+
/** sets whether to disable a provided reset stylesheet or not
|
|
17
|
+
* @default false
|
|
18
|
+
*/
|
|
15
19
|
disableReset?: boolean;
|
|
16
20
|
};
|
|
21
|
+
/**
|
|
22
|
+
* Uniform CSS Variables, font provider and optional reset stylesheet
|
|
23
|
+
* @example <Theme disableReset={true} /> */
|
|
17
24
|
declare const Theme: React__default.ElementType;
|
|
18
25
|
|
|
26
|
+
/** Breakpoint label values */
|
|
19
27
|
declare type breakpointSizeProps = 'sm' | 'md' | 'lg' | 'xl' | '2xl';
|
|
20
28
|
declare type breakpointsProps = Record<breakpointSizeProps, string>;
|
|
29
|
+
/** Object of breakpoints and the pixel values */
|
|
21
30
|
declare const breakpoints: breakpointsProps;
|
|
22
31
|
/**
|
|
23
32
|
* Media Query Helper Function
|
|
24
33
|
* @function
|
|
25
34
|
* @param {string} size - The responsive breakpoint value
|
|
26
35
|
* @returns {string} - compiled media query e.g. (min-width: 640px)
|
|
36
|
+
* @example `${mq('md')} { background: red; }`
|
|
27
37
|
*/
|
|
28
38
|
declare const mq: (size: breakpointSizeProps) => string;
|
|
29
39
|
|
|
@@ -32,74 +42,75 @@ declare const input: _emotion_react.SerializedStyles;
|
|
|
32
42
|
declare const inputError: _emotion_react.SerializedStyles;
|
|
33
43
|
declare const inputSelect: _emotion_react.SerializedStyles;
|
|
34
44
|
|
|
45
|
+
/** Custom scrollbar styles */
|
|
35
46
|
declare const scrollbarStyles: _emotion_react.SerializedStyles;
|
|
36
47
|
|
|
37
48
|
declare type UniformLogoProps = {
|
|
49
|
+
/** sets a light or dark theme for the uniform badge or logo component
|
|
50
|
+
* @default "light"
|
|
51
|
+
*/
|
|
38
52
|
theme?: 'light' | 'dark';
|
|
39
53
|
};
|
|
40
54
|
|
|
41
55
|
/**
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* @component
|
|
45
|
-
* @param {'light' | 'dark'} theme - sets a light or dark theme for the uniform badge
|
|
46
|
-
* @param {React.SVGAttributes<SVGElement>} props - sets react svg element attribute props
|
|
56
|
+
* Uniform Badge Logo
|
|
57
|
+
* @param props - sets react svg element attribute props
|
|
47
58
|
* @example <UniformBadge theme="dark" />
|
|
48
59
|
*/
|
|
49
60
|
declare const UniformBadge: ({ theme, ...props }: React__default.SVGAttributes<SVGElement> & UniformLogoProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
50
61
|
|
|
51
62
|
/**
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
* @
|
|
55
|
-
|
|
56
|
-
* @example <UniformLogo theme="light" />
|
|
57
|
-
*/
|
|
58
|
-
declare const UniformLogo: ({ theme }: UniformLogoProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
63
|
+
* Uniform Logo
|
|
64
|
+
* @param props - sets react svg element attribute props
|
|
65
|
+
* @example <UniformLogo theme="light" /> */
|
|
66
|
+
declare const UniformLogo: ({ theme, ...props }: UniformLogoProps & React.SVGAttributes<SVGElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
59
67
|
|
|
60
|
-
|
|
68
|
+
/** Button themes that are available to use with our brand */
|
|
69
|
+
declare type ButtonThemeProps$1 = 'primary' | 'secondary' | 'tertiary' | 'unimportant' | 'ghost';
|
|
70
|
+
/** Button sizes that are available to use with our brand */
|
|
61
71
|
declare type ButtonSizeProps = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
|
|
62
72
|
declare type ButtonProps = ButtonProps$1 & {
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
* @deprecated size might no longer be used as we are trying to consolidate button designs
|
|
73
|
+
/** sets the theme of the button
|
|
74
|
+
* @default "primary"
|
|
66
75
|
*/
|
|
67
|
-
|
|
76
|
+
buttonType?: ButtonThemeProps$1;
|
|
77
|
+
/** React child node */
|
|
78
|
+
children?: React$1.ReactNode;
|
|
68
79
|
/**
|
|
69
|
-
* @
|
|
70
|
-
*/
|
|
80
|
+
* @default "md"
|
|
81
|
+
* @deprecated size might no longer be used as we are trying to consolidate button designs */
|
|
82
|
+
size?: ButtonSizeProps;
|
|
83
|
+
/** @deprecated rounded is no longer used */
|
|
71
84
|
rounded?: boolean;
|
|
72
85
|
};
|
|
73
86
|
/**
|
|
74
|
-
* Button
|
|
75
|
-
*
|
|
76
|
-
* @component
|
|
77
|
-
* @param {string} buttonType - sets the theme of the button
|
|
87
|
+
* Uniform Button Component
|
|
78
88
|
* @param {BaseButtonProps} props - object of button props from reakit
|
|
79
|
-
* @param {React.ReactNode} children - react child elements
|
|
80
89
|
* @example <Button buttonType="secondary" size="md" onClick={() => alert('hello world')}>Click me</Button>
|
|
81
90
|
*/
|
|
82
|
-
declare const Button: React$1.
|
|
91
|
+
declare const Button: React$1.ForwardRefExoticComponent<Pick<ButtonProps, "form" | "slot" | "style" | "title" | "className" | "key" | "type" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "name" | "focusable" | "buttonType" | "size" | "unstable_system" | "disabled" | "unstable_clickOnEnter" | "unstable_clickOnSpace" | "wrapElement" | "autoFocus" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "value" | "rounded"> & React$1.RefAttributes<HTMLButtonElement>>;
|
|
83
92
|
|
|
84
93
|
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", "dice-1", "dice-2", "dice-3", "dice-4", "dice-5", "dice-6", "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"];
|
|
94
|
+
/** A list of available icon names that can be used with the Uniform brand */
|
|
85
95
|
declare type IconName = typeof iconNames[number];
|
|
86
96
|
|
|
97
|
+
/** sets fill color of the svg icon */
|
|
87
98
|
declare type IconColor = 'green' | 'red' | 'gray' | 'currentColor';
|
|
99
|
+
/** sets the type of icon to use from the available list */
|
|
88
100
|
declare type IconType = IconName | IconType$1;
|
|
89
101
|
interface IconProps extends IconBaseProps {
|
|
102
|
+
/** sets the icon to be used */
|
|
90
103
|
icon: IconType;
|
|
104
|
+
/** sets the icon color to be used */
|
|
91
105
|
iconColor?: IconColor;
|
|
106
|
+
/** sets additional icon props provided by "react-icons" */
|
|
107
|
+
otherProps?: IconBaseProps;
|
|
92
108
|
}
|
|
93
109
|
/**
|
|
94
110
|
* Component that renders icons
|
|
95
|
-
*
|
|
96
|
-
* @component
|
|
97
|
-
* @param {IconName | IconType} icon - sets the type of icon to use from the available list
|
|
98
|
-
* @param {'green' | 'red' | 'gray' | 'currentColor'} iconColor - sets fill color of the svg icon
|
|
99
|
-
* @param {IconBaseProps} otherProps - sets additional icon props provided by "react-icons"
|
|
100
111
|
* @example <Icon icon="add-r" iconColor="currentColor" />
|
|
101
112
|
*/
|
|
102
|
-
declare const Icon: React__default.
|
|
113
|
+
declare const Icon: React__default.MemoExoticComponent<({ icon, iconColor, size, ...otherProps }: IconProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null>;
|
|
103
114
|
|
|
104
115
|
declare type IconsMap = Record<string, IconType$1>;
|
|
105
116
|
declare function useIconContext(): {
|
|
@@ -108,64 +119,77 @@ declare function useIconContext(): {
|
|
|
108
119
|
};
|
|
109
120
|
/**
|
|
110
121
|
* Provider to the Icon component
|
|
111
|
-
*
|
|
112
122
|
* @example <IconsProvider><Icon icon="add-r" /></IconsProvider>
|
|
113
123
|
*/
|
|
114
124
|
declare function IconsProvider({ children }: {
|
|
115
125
|
children: ReactNode;
|
|
116
126
|
}): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
117
127
|
|
|
128
|
+
declare type CaptionProps = {
|
|
129
|
+
/** allows users to add child elements */
|
|
130
|
+
children: React$1.ReactNode;
|
|
131
|
+
};
|
|
118
132
|
/**
|
|
119
133
|
* Component that provides caption text to input fields
|
|
120
|
-
*
|
|
121
|
-
* @component
|
|
122
|
-
* @param {React.ReactNode} children - allows users to add child elements
|
|
123
134
|
* @example <Caption>some help text here</Caption>
|
|
124
135
|
*/
|
|
125
|
-
declare const Caption:
|
|
136
|
+
declare const Caption: ({ children }: CaptionProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
126
137
|
|
|
127
138
|
declare type ErrorMessageProps = {
|
|
139
|
+
/** sets the error message value */
|
|
128
140
|
message?: string;
|
|
141
|
+
/** sets the test id for test automation (optional) */
|
|
142
|
+
testId?: string;
|
|
129
143
|
};
|
|
130
144
|
/**
|
|
131
145
|
* Component that provides error messaging to input fields
|
|
132
|
-
*
|
|
133
|
-
* @component
|
|
134
|
-
* @param {string} message - sets the error message value
|
|
135
146
|
* @example <ErrorMessage>something went wrong, please try again</ErrorMessage>
|
|
136
147
|
*/
|
|
137
|
-
declare const ErrorMessage: ({ message }: ErrorMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
148
|
+
declare const ErrorMessage: ({ message, testId }: ErrorMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
138
149
|
|
|
139
150
|
declare type InputProps = React$1.InputHTMLAttributes<HTMLInputElement> & {
|
|
151
|
+
/** (optional) sets the label value */
|
|
140
152
|
label?: string;
|
|
153
|
+
/** (optional) sets caption text value */
|
|
141
154
|
caption?: string;
|
|
155
|
+
/** (optional) add an input icon to the input field */
|
|
142
156
|
icon?: React$1.ReactElement;
|
|
157
|
+
/** (optional) sets whether to show the label or hide it and add a aria-label attributes to the input field directly */
|
|
143
158
|
showLabel?: boolean;
|
|
159
|
+
/** (optional) sets and shows the the error message value */
|
|
144
160
|
errorMessage?: string;
|
|
161
|
+
/** (optional) sets the test id for input field container for test automation*/
|
|
162
|
+
containerTestId?: string;
|
|
163
|
+
/** (optional) sets label test id */
|
|
164
|
+
labelTestId?: string;
|
|
165
|
+
/** (optiona) sets validation message test id for test automation */
|
|
166
|
+
errorTestId?: string;
|
|
145
167
|
capture?: boolean | 'user' | 'environment';
|
|
146
|
-
/**
|
|
168
|
+
/**
|
|
169
|
+
* (optional) sets an overriding classname on the container element
|
|
170
|
+
* @deprecated */
|
|
147
171
|
classNameContainer?: string | SerializedStyles;
|
|
148
|
-
/**
|
|
172
|
+
/**
|
|
173
|
+
* (optional) sets an overriding classname on the input element
|
|
174
|
+
* @deprecated */
|
|
149
175
|
classNameControl?: string | SerializedStyles;
|
|
150
|
-
/**
|
|
176
|
+
/**
|
|
177
|
+
* (optional) sets an overriding classname on the label element
|
|
178
|
+
* @deprecated */
|
|
151
179
|
classNameLabel?: string | SerializedStyles;
|
|
152
180
|
};
|
|
153
181
|
/**
|
|
154
182
|
* Input Component
|
|
155
|
-
*
|
|
156
|
-
* @component
|
|
157
|
-
* @param {string} label - sets the label value
|
|
158
|
-
* @param {string} caption - sets help text value
|
|
159
|
-
* @param {boolean} showLabel - sets whether to hide the label and use aria-label on the input itself
|
|
160
|
-
* @param {React.ReactElement} icon - add an input icon to the input field
|
|
161
|
-
* @param {string} errorMessage - sets shows the the error message value
|
|
162
183
|
* @example - <Input label="my label" id="some-id" name="some-name" caption="some help text" errorMessage={hasError ? 'something went wrong' : undefined} />
|
|
163
184
|
*/
|
|
164
|
-
declare const Input: ({ label, icon, id, caption, showLabel, errorMessage, classNameContainer, classNameControl, classNameLabel, ...props }: InputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
185
|
+
declare const Input: ({ label, icon, id, caption, showLabel, errorMessage, containerTestId, labelTestId, errorTestId, classNameContainer, classNameControl, classNameLabel, ...props }: InputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
165
186
|
|
|
166
187
|
declare type InputComboBoxOption = {
|
|
188
|
+
/** sets the label value */
|
|
167
189
|
label: string;
|
|
190
|
+
/** sets the input value */
|
|
168
191
|
value: string;
|
|
192
|
+
/** (optional) sets the disabled value on the input */
|
|
169
193
|
isDisabled?: boolean;
|
|
170
194
|
};
|
|
171
195
|
declare type InputComboBoxProps<TOption, IsMulti extends boolean, TGroup extends GroupBase<TOption> = GroupBase<TOption>> = StateManagerProps<TOption, IsMulti, TGroup> & React$1.RefAttributes<InternalSelect<TOption, IsMulti, TGroup>>;
|
|
@@ -177,139 +201,162 @@ declare type ComboBoxGroupBase<TOption> = GroupBase<TOption>;
|
|
|
177
201
|
declare function InputComboBox<TOption = InputComboBoxOption, IsMulti extends boolean = false, TGroup extends ComboBoxGroupBase<TOption> = ComboBoxGroupBase<TOption>>(props: InputComboBoxProps<TOption, IsMulti, TGroup>): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
178
202
|
|
|
179
203
|
declare type InputInlineSelectOption = {
|
|
204
|
+
/** sets the display name of the option */
|
|
180
205
|
label: string;
|
|
206
|
+
/** sets the option value attribute */
|
|
181
207
|
value: string;
|
|
182
208
|
};
|
|
183
209
|
declare type InputInlineSelectProps = Omit<React$1.HTMLAttributes<HTMLButtonElement>, 'onChange'> & {
|
|
210
|
+
/** sets the selected value */
|
|
184
211
|
value: string;
|
|
212
|
+
/** sets the available options within the dropdown */
|
|
185
213
|
options: Array<InputInlineSelectOption>;
|
|
214
|
+
/** function that takes an option argument and sets the new value */
|
|
186
215
|
onChange: (option: InputInlineSelectOption) => void;
|
|
216
|
+
/** sets the disabled state of the button */
|
|
187
217
|
disabled?: boolean;
|
|
218
|
+
/** override existing styles by passing new emotion styles or a string of css props */
|
|
188
219
|
classNameContainer?: SerializedStyles | string;
|
|
189
220
|
};
|
|
190
221
|
/**
|
|
191
222
|
* Input Inline Select
|
|
192
|
-
* @component
|
|
193
|
-
* @param {string} value - sets the selected value
|
|
194
|
-
* @param {Array<InlineSelectInputOption>} options - sets the available options within the dropdown
|
|
195
|
-
* @param {(option: InlineSelectInputOption) => void} onChange - function that takes an option argument and sets the new value
|
|
196
|
-
* @param {boolean} disabled - sets the disabled state of the button
|
|
197
|
-
* @param {SerializedStyles | string} classNameContainer - override existing styles by passing new emotion styles or a string of css props
|
|
198
223
|
* @example <InputInlineSelect disabled={index > 1} value={currentValue ?? '&'} options={[{ label: 'AND', value: '&' }, { label: 'OR', value: '|' }]} onChange={(s) => {setState(s.value)}} />
|
|
199
224
|
*/
|
|
200
225
|
declare const InputInlineSelect: ({ classNameContainer, options, value, onChange, disabled, ...props }: InputInlineSelectProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
201
226
|
|
|
202
227
|
interface InputKeywordSearchProps {
|
|
228
|
+
/** function that takes a string value */
|
|
203
229
|
onSearchTextChanged: (searchText: string) => void;
|
|
230
|
+
/** (optional) sets the input field disabled state
|
|
231
|
+
* @default false
|
|
232
|
+
*/
|
|
204
233
|
disabled?: boolean;
|
|
234
|
+
/** (optional) props that allows users to set the placeholder text value
|
|
235
|
+
* @default "Keyword search"
|
|
236
|
+
*/
|
|
205
237
|
placeholder?: string;
|
|
238
|
+
/** (optional) allows users to set the "name" attribute value
|
|
239
|
+
* @default "keywordSearch"
|
|
240
|
+
*/
|
|
206
241
|
inputFieldName?: string;
|
|
242
|
+
/** (optional) allows users to prevent default form field submission
|
|
243
|
+
* @default false
|
|
244
|
+
*/
|
|
207
245
|
disabledFieldSubmission?: boolean;
|
|
246
|
+
/** (optional) prop that sets the value of the input field */
|
|
208
247
|
value?: string;
|
|
209
248
|
}
|
|
210
249
|
/**
|
|
211
250
|
* Component used for keyword search functionality
|
|
212
|
-
* @component
|
|
213
|
-
* @param {function} onSearchTextChanged - function that takes a string value
|
|
214
|
-
* @param {boolean} disabled - sets the input field disabled state
|
|
215
|
-
* @param {string} placeholder - optional props that allows users to set the placeholder text value
|
|
216
|
-
* @param {boolean} disabledFieldSubmission - allows users to prevent default form field submission
|
|
217
|
-
* @param {string} value - optional prop that sets the value of the input field
|
|
218
251
|
* @example <InlineSelectInput disabled={index > 1} value={currentValue ?? '&'} options={[{ label: 'AND', value: '&' }, { label: 'OR', value: '|' }]} onChange={(s) => {setState(s.value)}} />
|
|
219
252
|
*/
|
|
220
253
|
declare const InputKeywordSearch: ({ onSearchTextChanged, disabled, placeholder, inputFieldName, disabledFieldSubmission, value, }: InputKeywordSearchProps) => React$1.ReactElement;
|
|
221
254
|
|
|
222
255
|
declare type InputSelectProps = React.SelectHTMLAttributes<HTMLSelectElement> & {
|
|
256
|
+
/** (optional) sets the first item in the options list with empty value */
|
|
223
257
|
defaultOption?: string;
|
|
258
|
+
/** sets an array of select options with value and text value */
|
|
224
259
|
options: Array<React.OptionHTMLAttributes<HTMLOptionElement> & {
|
|
225
260
|
label: string;
|
|
226
261
|
}>;
|
|
262
|
+
/** (optional) sets caption text value */
|
|
227
263
|
caption?: string;
|
|
264
|
+
/** sets the label value */
|
|
228
265
|
label: string;
|
|
266
|
+
/** (optional) sets whether to hide the label and use aria-label on the input field
|
|
267
|
+
* @default false
|
|
268
|
+
*/
|
|
229
269
|
showLabel?: boolean;
|
|
270
|
+
/** (optional) sets and shows the the error message value */
|
|
230
271
|
errorMessage?: string;
|
|
231
|
-
/**
|
|
272
|
+
/** (optional) allows react components to be added inline with the label element */
|
|
232
273
|
labelCta?: JSX.Element;
|
|
233
|
-
/**
|
|
274
|
+
/**
|
|
275
|
+
* (optional) sets an overriding classname on the container element
|
|
276
|
+
* @deprecated */
|
|
234
277
|
classNameContainer?: string;
|
|
235
|
-
/**
|
|
278
|
+
/**
|
|
279
|
+
* (optional) sets an overriding classname on the input element
|
|
280
|
+
* @deprecated */
|
|
236
281
|
classNameControl?: string;
|
|
237
|
-
/**
|
|
282
|
+
/**
|
|
283
|
+
* (optional) sets an overriding classname on the label element
|
|
284
|
+
* @deprecated */
|
|
238
285
|
classNameLabel?: string;
|
|
239
286
|
};
|
|
240
287
|
/**
|
|
241
288
|
* Input Select Component
|
|
242
|
-
* @component
|
|
243
|
-
* @param {string} label - sets the label value
|
|
244
|
-
* @param {boolean} showLabel - sets whether to hide the label and use aria-label on the input itself
|
|
245
|
-
* @param {string} defaultOption - sets the first item in the options list with empty value
|
|
246
|
-
* @param {Array<React.OptionHTMLAttributes<HTMLOptionElement> & { label: string }>} options - sets an array of select options with value and text value
|
|
247
|
-
* @param {string} caption - sets help text value
|
|
248
|
-
* @param {string} errorMessage - sets and shows the the error message value
|
|
249
289
|
* @example <InputSelect label="my label" options={[{label: "option 1"}, {label: "option 2"}]} />
|
|
250
290
|
*/
|
|
251
291
|
declare const InputSelect: ({ label, defaultOption, options, caption, errorMessage, showLabel, labelCta, classNameContainer, classNameControl, classNameLabel, ...props }: InputSelectProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
252
292
|
|
|
253
293
|
declare type InputToggleProps = React$1.HTMLAttributes<HTMLInputElement> & {
|
|
294
|
+
/** sets the label value */
|
|
254
295
|
label: string;
|
|
296
|
+
/** sets the type of input to use, either radio or checkbox */
|
|
255
297
|
type: 'radio' | 'checkbox';
|
|
298
|
+
/** sets the name value of the radio/checkbox input */
|
|
256
299
|
name: string;
|
|
300
|
+
/** (optional) sets the disabled state */
|
|
257
301
|
disabled?: boolean;
|
|
302
|
+
/** (optional) sets the checked state of the input */
|
|
258
303
|
checked?: boolean;
|
|
304
|
+
/** (optional) sets caption text value */
|
|
259
305
|
caption?: string;
|
|
306
|
+
/** (optional) sets shows the the error message value */
|
|
260
307
|
errorMessage?: string;
|
|
261
308
|
};
|
|
262
309
|
/**
|
|
263
310
|
* Component that creates a checkbox or radio input field
|
|
264
|
-
*
|
|
265
|
-
* @component
|
|
266
|
-
* @param {string} label - sets the label value
|
|
267
|
-
* @param {'radio' | 'checkbox'} type - sets the type of input to use, either radio or checkbox
|
|
268
|
-
* @param {string} name - sets the name value of the radio/checkbox input
|
|
269
|
-
* @param {disabled} disabled - (optional) sets the disabled state
|
|
270
|
-
* @param {boolean} checked - (optional) sets the checked state of the input
|
|
271
|
-
* @param {string} caption - (optional) sets help text value
|
|
272
|
-
* @param {string} errorMessage - (optional) sets shows the the error message value
|
|
273
311
|
* @example <InputToggle label="Do you like ice cream?" type="checkbox" name="ice-cream" />
|
|
274
312
|
*/
|
|
275
313
|
declare const InputToggle: ({ label, type, disabled, checked, name, caption, errorMessage, ...props }: InputToggleProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
276
314
|
|
|
277
315
|
declare type TextareaProps = React$1.TextareaHTMLAttributes<HTMLTextAreaElement> & {
|
|
316
|
+
/** (optional) sets the label value */
|
|
278
317
|
label?: string;
|
|
318
|
+
/** (optional) sets caption text value */
|
|
279
319
|
caption?: string;
|
|
320
|
+
/** (optional) add an input icon to the input field */
|
|
280
321
|
icon?: React$1.ReactElement;
|
|
322
|
+
/** (optional) sets whether to hide the label and use aria-label on the input field */
|
|
281
323
|
showLabel?: boolean;
|
|
324
|
+
/** (optional) sets shows the the error message value */
|
|
282
325
|
errorMessage?: string;
|
|
283
326
|
capture?: boolean | 'user' | 'environment';
|
|
284
327
|
};
|
|
285
328
|
/**
|
|
286
329
|
* Textarea Component
|
|
287
|
-
*
|
|
288
|
-
* @component
|
|
289
|
-
* @param {string} label - sets the label value
|
|
290
|
-
* @param {string} caption - sets help text value
|
|
291
|
-
* @param {boolean} showLabel - sets whether to hide the label and use aria-label on the input itself
|
|
292
|
-
* @param {React.ReactElement} icon - add an input icon to the input field
|
|
293
|
-
* @param {string} errorMessage - sets shows the the error message value
|
|
294
330
|
* @example - <Textarea label="my label" id="some-id" name="some-name" caption="some help text" errorMessage={hasError ? 'something went wrong' : undefined} />
|
|
295
331
|
*/
|
|
296
332
|
declare const Textarea: ({ label, icon, id, caption, showLabel, errorMessage, ...props }: TextareaProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
297
333
|
|
|
334
|
+
declare type LabelProps = React$1.LabelHTMLAttributes<HTMLLabelElement> & {
|
|
335
|
+
/** sets child elements within the label tag, normally the default label text */
|
|
336
|
+
children: React$1.ReactNode;
|
|
337
|
+
/** (optional) sets additional css properties */
|
|
338
|
+
className?: SerializedStyles | string;
|
|
339
|
+
/** (optional) test id for test automation*/
|
|
340
|
+
testId?: string;
|
|
341
|
+
};
|
|
342
|
+
declare const Label: ({ children, className, testId, ...props }: LabelProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
343
|
+
|
|
298
344
|
interface MenuProps extends MenuHTMLProps {
|
|
299
|
-
|
|
345
|
+
/** sets aria-label attribute */
|
|
300
346
|
menuLabel: string;
|
|
347
|
+
/** the component that triggers the menu functionality */
|
|
348
|
+
menuTrigger: React$1.ReactElement & React$1.RefAttributes<any>;
|
|
349
|
+
/** (optional) reakit placements options for the expandable menu */
|
|
301
350
|
placement?: MenuProps$1['placement'];
|
|
351
|
+
/** (optional) allows users to set additional class names */
|
|
352
|
+
menuItemsContainerCssClasses?: SerializedStyles | string;
|
|
353
|
+
/** (optional) allows users to add child elements */
|
|
354
|
+
children?: React$1.ReactNode;
|
|
302
355
|
}
|
|
303
356
|
declare const MenuContext: React$1.Context<MenuStateReturn>;
|
|
304
357
|
declare const useMenuContext: () => MenuStateReturn;
|
|
305
358
|
/**
|
|
306
359
|
* Component used for creating clickable menus
|
|
307
|
-
*
|
|
308
|
-
* @component
|
|
309
|
-
* @param {string} menuLabel - sets aria-label attribute
|
|
310
|
-
* @param {React.ReactElement & React.RefAttributes<any>} menuTrigger - the component that triggers the menu functionality
|
|
311
|
-
* @param {BaseMenuProps['placement']} placement - (optional) reakit placements options for the expandable menu
|
|
312
|
-
* @param {React.ReactNode} children - allows users to add child elements
|
|
313
360
|
* @example
|
|
314
361
|
* <Menu
|
|
315
362
|
* menuTrigger={<button type="button">Click me</button>}
|
|
@@ -317,143 +364,158 @@ declare const useMenuContext: () => MenuStateReturn;
|
|
|
317
364
|
* menuLabel="Linked environment management options">
|
|
318
365
|
* </Menu>
|
|
319
366
|
*/
|
|
320
|
-
declare const Menu:
|
|
367
|
+
declare const Menu: ({ menuLabel, menuTrigger, placement, menuItemsContainerCssClasses, children, }: MenuProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
321
368
|
|
|
322
369
|
declare type MenuItemProps = MenuItemHTMLProps & {
|
|
323
|
-
|
|
370
|
+
/** sets child elements within the component */
|
|
324
371
|
children: ChildFunction | React$1.ReactNode;
|
|
372
|
+
/** (optional) set whether to hide the menu after a click action */
|
|
325
373
|
hideMenuOnClick?: boolean;
|
|
374
|
+
/** (optional) set an icon along side the item text */
|
|
326
375
|
icon?: React$1.ReactElement;
|
|
376
|
+
/** When an element is disabled, it may still be focusable. It works similarly to readOnly on form elements. In this case, only aria-disabled will be set. */
|
|
377
|
+
focusable?: boolean;
|
|
327
378
|
};
|
|
328
379
|
declare type ChildFunction = (menuItemProps: MenuItemHTMLProps) => React$1.ReactElement | null;
|
|
329
380
|
/**
|
|
330
381
|
* MenuItem Component used along side <Menu /> component
|
|
331
|
-
*
|
|
332
|
-
* @component
|
|
333
|
-
* @param {ChildFunction | React.ReactNode} children - sets child elements within the component
|
|
334
|
-
* @param {boolean} hideMenuOnClick - (optional) set whether to hide the menu after a click action
|
|
335
|
-
* @param {React.ReactElement} icon - (optional) set an icon along side the item text
|
|
336
382
|
* @example <MenuItem onClick={() => alert('menu item was clicked')} icon={<RedClose />}>Remove Link</MenuItem>
|
|
337
383
|
*/
|
|
338
384
|
declare const MenuItem: React$1.FC<MenuItemProps>;
|
|
339
385
|
|
|
386
|
+
/** Callout button types available to use with our brand */
|
|
340
387
|
declare type CalloutType = 'caution' | 'danger' | 'info' | 'note' | 'success' | 'tip' | 'error';
|
|
341
388
|
interface CalloutProps {
|
|
389
|
+
/** sets the type of callout to use and it's styles
|
|
390
|
+
* @default "info"
|
|
391
|
+
*/
|
|
342
392
|
type: CalloutType;
|
|
393
|
+
/** (optional) sets the title of the callout */
|
|
343
394
|
title?: React$1.ReactNode;
|
|
395
|
+
/** add child elements to the callout */
|
|
344
396
|
children: React$1.ReactNode;
|
|
397
|
+
/** sets additional css classes or emotion styles on the callout */
|
|
345
398
|
className?: SerializedStyles | string;
|
|
346
399
|
}
|
|
347
400
|
/**
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
* @component
|
|
351
|
-
* @param {CalloutType} type - sets the type of callout to be used
|
|
352
|
-
* @param {React.ReactNode} title - sets the title of the callout
|
|
353
|
-
* @param {React.ReactNode} children - adds child components to the callout body
|
|
354
|
-
* @param {SerializedStyles | string} className - sets a string value className or a emotion css style property for custom overrides
|
|
401
|
+
* Uniform Callout Component
|
|
355
402
|
* @example <Callout title="my title" type="caution"><p>callout body copy</p></Callout>
|
|
356
403
|
*/
|
|
357
|
-
declare const Callout:
|
|
404
|
+
declare const Callout: ({ type, title, children, className }: CalloutProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
358
405
|
|
|
359
406
|
/**
|
|
360
407
|
* Loading Indicator
|
|
361
|
-
* @component
|
|
362
408
|
* @example <LoadingIndicator />
|
|
363
409
|
*/
|
|
364
410
|
declare const LoadingIndicator: () => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
365
411
|
|
|
366
412
|
interface LoadingOverlayProps {
|
|
413
|
+
/** sets whether to display the loading overlay components */
|
|
367
414
|
isActive: boolean;
|
|
415
|
+
/** (optional) type that sets a text value or React component under the loading icon */
|
|
368
416
|
statusMessage?: string | JSX.Element;
|
|
369
417
|
}
|
|
370
418
|
/**
|
|
371
419
|
* Loading Overlay
|
|
372
|
-
* @component
|
|
373
|
-
* @param {boolean} isActive - sets whether to display the loading overlay components
|
|
374
|
-
* @param {string | JSX.Element} statusMessage - optional type that sets a text value or React component under the loading icon
|
|
375
420
|
* @example <LoadingOverlay isActive={true} statusMessage="Loading..." />
|
|
376
421
|
*/
|
|
377
|
-
declare const LoadingOverlay:
|
|
422
|
+
declare const LoadingOverlay: ({ isActive, statusMessage }: LoadingOverlayProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
378
423
|
interface LoadingIconProps {
|
|
424
|
+
/** (optional) prop that sets a number value for the height of the icon */
|
|
379
425
|
width?: number;
|
|
426
|
+
/** (optional) prop that sets a number value for the width of the icon */
|
|
380
427
|
height?: number;
|
|
381
428
|
}
|
|
382
429
|
/**
|
|
383
430
|
* Loading Icon
|
|
384
|
-
* @component
|
|
385
|
-
* @param {number} height - option prop that sets a number value for the height of the icon
|
|
386
|
-
* @param {number} width - option prop that sets a number value for the width of the icon
|
|
387
431
|
* @example <LoadingIcon height={128} width={128} />
|
|
388
432
|
*/
|
|
389
|
-
declare const LoadingIcon:
|
|
433
|
+
declare const LoadingIcon: ({ height, width }: LoadingIconProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
390
434
|
|
|
435
|
+
/** Available heading weights e.g. 1 - 6 */
|
|
391
436
|
declare type LevelProps = 1 | 2 | 3 | 4 | 5 | 6;
|
|
392
437
|
declare type HeadingProps = {
|
|
438
|
+
/** sets the type of heading tag between h1 to h6, defaults to <h2>
|
|
439
|
+
* @default 2
|
|
440
|
+
*/
|
|
393
441
|
level?: LevelProps;
|
|
394
|
-
|
|
442
|
+
/** sets the title value */
|
|
443
|
+
children: React$1.ReactNode;
|
|
444
|
+
} & React$1.HTMLAttributes<HTMLHeadingElement>;
|
|
395
445
|
/**
|
|
396
446
|
* Component that sets the heading tag
|
|
397
|
-
* @component
|
|
398
|
-
* @param {number} level - sets the type of heading tag between h1 to h6, defaults to <h2>
|
|
399
|
-
* @param {children} children - adds child elements to the heading tag
|
|
400
447
|
* @example <Heading level={1}>Blog Post Title</Heading>
|
|
401
448
|
*/
|
|
402
|
-
declare const Heading:
|
|
449
|
+
declare const Heading: ({ level, children, ...hAttributes }: HeadingProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
403
450
|
|
|
404
451
|
declare type ParagraphProps = {
|
|
452
|
+
/** adds child elements to the paragraph tag */
|
|
405
453
|
children: React$1.ReactNode;
|
|
454
|
+
/** (optional) allows user to set overriding class names or emotion styles */
|
|
406
455
|
className?: SerializedStyles | string;
|
|
407
|
-
}
|
|
456
|
+
} & React$1.HTMLAttributes<HTMLParagraphElement>;
|
|
408
457
|
/**
|
|
409
458
|
* Component for generic paragraph tags
|
|
410
|
-
* @component
|
|
411
|
-
* @param {number} className - allows user to set overriding class names or emotion styles
|
|
412
|
-
* @param {children} children - adds child elements to the paragraph tag
|
|
413
459
|
* @example <Paragraph>This is the text that was be inside the paragraph tag.</Paragraph>
|
|
414
460
|
*/
|
|
415
|
-
declare const Paragraph: ({ className, children }: ParagraphProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
461
|
+
declare const Paragraph: ({ className, children, ...pAttributes }: ParagraphProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
462
|
+
|
|
463
|
+
declare type LinkColorProps = 'currentColor' | 'red' | 'green';
|
|
464
|
+
declare type LinkProps = React$1.AnchorHTMLAttributes<HTMLAnchorElement> & {
|
|
465
|
+
/** sets the link text and title text */
|
|
466
|
+
text: string;
|
|
467
|
+
/** (optional) sets the link color
|
|
468
|
+
* @default 'currentColor'
|
|
469
|
+
*/
|
|
470
|
+
linkColor?: LinkColorProps;
|
|
471
|
+
/** (optional) sets whether the link is external or not adding an icon to the link */
|
|
472
|
+
external?: boolean;
|
|
473
|
+
};
|
|
474
|
+
declare const Link: ({ external, text, linkColor, ...props }: LinkProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
416
475
|
|
|
417
476
|
declare type ScrollableListProps = {
|
|
477
|
+
/** (optional) sets the label value */
|
|
418
478
|
label?: string;
|
|
479
|
+
/** (optional) allows users to add child components within the container */
|
|
419
480
|
children?: React$1.ReactNode;
|
|
420
481
|
};
|
|
421
482
|
/**
|
|
422
483
|
* Component that sets the base structure for scrollable content in a max height container
|
|
423
|
-
* @componet
|
|
424
|
-
* @param {string} label - sets the label value
|
|
425
|
-
* @param {React.ReactNode} children - allows users to add child components within the container
|
|
426
484
|
* @example <ScrollableList label="allowed content types"><button>say hello</button></ScrollableList>
|
|
427
485
|
*/
|
|
428
486
|
declare const ScrollableList: ({ label, children }: ScrollableListProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
429
487
|
|
|
430
488
|
declare type ScrollableListItemProps = React$1.HTMLAttributes<HTMLButtonElement> & {
|
|
489
|
+
/** sets the button text value */
|
|
431
490
|
buttonText: string;
|
|
491
|
+
/** sets the active style of the button */
|
|
432
492
|
active: boolean;
|
|
433
493
|
};
|
|
434
494
|
/**
|
|
435
495
|
* Component used within <ScrollableList /> for adding interactive button components with predefined styles
|
|
436
|
-
* @componet
|
|
437
|
-
* @param {string} buttonText - sets the button text value
|
|
438
|
-
* @param {boolean} active - sets the active style of the button
|
|
439
496
|
* @example <ScrollableListItem buttontext="my button" active={false} />
|
|
440
497
|
*/
|
|
441
498
|
declare const ScrollableListItem: ({ buttonText, active, ...props }: ScrollableListItemProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
442
499
|
|
|
500
|
+
declare type ButtonThemeProps = 'primary' | 'secondary' | 'unimportant' | 'ghost';
|
|
443
501
|
interface ActionButtonsProps {
|
|
502
|
+
/** Takes a function for the visible button */
|
|
444
503
|
onButtonClick: () => void;
|
|
504
|
+
/** (optional) reakit placements options for the expandable menu */
|
|
445
505
|
placement?: MenuProps$2['placement'];
|
|
506
|
+
/** sets the theme of the button
|
|
507
|
+
* @default "secondary"
|
|
508
|
+
*/
|
|
509
|
+
buttonType?: ButtonThemeProps;
|
|
510
|
+
/** sets the button text value */
|
|
446
511
|
buttonText: string;
|
|
512
|
+
/** adds child components to the ButtonWithMenu component */
|
|
447
513
|
children: React$1.ReactNode;
|
|
448
514
|
}
|
|
515
|
+
/** ButtonWithMenuProps combines the ActionButtonsProps with React HTMLButtonElement attributes */
|
|
449
516
|
declare type ButtonWithMenuProps = ActionButtonsProps & React$1.ButtonHTMLAttributes<HTMLButtonElement>;
|
|
450
517
|
/**
|
|
451
|
-
* ButtonWithMenu
|
|
452
|
-
* @component
|
|
453
|
-
* @param {string} buttonText - sets the button text value
|
|
454
|
-
* @param {() => void} onButtonClick -
|
|
455
|
-
* @param {MenuProps['placement']} placement - (optional) reakit placements options for the expandable menu
|
|
456
|
-
* @param {React.ReactNode} children - adds child components to the ButtonWithMenu component
|
|
518
|
+
* Uniform ButtonWithMenu Component
|
|
457
519
|
* @example
|
|
458
520
|
<ButtonWithMenu
|
|
459
521
|
disabled={isDisabled}
|
|
@@ -468,13 +530,70 @@ declare type ButtonWithMenuProps = ActionButtonsProps & React$1.ButtonHTMLAttrib
|
|
|
468
530
|
className="flex gap-2 items-center"
|
|
469
531
|
data-testid="save-menu-item-button"
|
|
470
532
|
>
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
<ShortcutRevealer shortcut="ctrl+shift+s" className="x" />
|
|
533
|
+
<span className="whitespace-nowrap" data-test-id="save-menu-item">
|
|
534
|
+
Save
|
|
535
|
+
</span>
|
|
475
536
|
</MenuItem>
|
|
476
537
|
</ButtonWithMenu>
|
|
477
538
|
*/
|
|
478
|
-
declare const ButtonWithMenu: ({ onButtonClick, buttonText, disabled, children, placement, ...buttonProps }: ButtonWithMenuProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
539
|
+
declare const ButtonWithMenu: ({ onButtonClick, buttonType, buttonText, disabled, children, placement, ...buttonProps }: ButtonWithMenuProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
540
|
+
|
|
541
|
+
declare type AddButtonProps = Omit<React$1.HTMLAttributes<HTMLButtonElement>, 'onChange'> & {
|
|
542
|
+
/** sets the aria-label for accessibility
|
|
543
|
+
* @default "Add"
|
|
544
|
+
*/
|
|
545
|
+
buttonText?: string;
|
|
546
|
+
onClick: () => void;
|
|
547
|
+
className?: string;
|
|
548
|
+
/** sets keyboard shortcut command for Windows
|
|
549
|
+
* @default "ctrl+alt+n"
|
|
550
|
+
*/
|
|
551
|
+
shortcut?: string | null;
|
|
552
|
+
/** sets keyboard shortcut command for Mac
|
|
553
|
+
* @default "option+n"
|
|
554
|
+
*/
|
|
555
|
+
macShortcut?: string | null;
|
|
556
|
+
};
|
|
557
|
+
/**
|
|
558
|
+
* Add button component
|
|
559
|
+
* @param {Omit<React.HTMLAttributes<HTMLButtonElement>, 'onChange'>} props - object of button props
|
|
560
|
+
* @example <AddButton buttonText="Button Text" />
|
|
561
|
+
*/
|
|
562
|
+
declare const AddButton: ({ buttonText, onClick, shortcut, macShortcut, ...props }: AddButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
563
|
+
|
|
564
|
+
declare function ShortcutContext({ children }: {
|
|
565
|
+
children: React__default.ReactNode;
|
|
566
|
+
}): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
|
|
567
|
+
declare function ShortcutRevealer({ shortcut, macShortcut, className, }: {
|
|
568
|
+
shortcut: string;
|
|
569
|
+
macShortcut?: string;
|
|
570
|
+
className?: SerializedStyles | string;
|
|
571
|
+
}): _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
|
|
572
|
+
|
|
573
|
+
declare type SwitchProps = Omit<React$1.InputHTMLAttributes<HTMLInputElement>, 'type'> & {
|
|
574
|
+
/** sets the label value */
|
|
575
|
+
label: string;
|
|
576
|
+
/** (optional) sets information text */
|
|
577
|
+
infoText?: string;
|
|
578
|
+
/** sets the toggle text value */
|
|
579
|
+
toggleText?: string;
|
|
580
|
+
/** sets child elements */
|
|
581
|
+
children?: React$1.ReactNode;
|
|
582
|
+
};
|
|
583
|
+
/**
|
|
584
|
+
* Uniform Switch Input Component
|
|
585
|
+
* @param {Omit<React.InputHTMLAttributes<HTMLInputElement>, 'type'>} inputProps - props for an input element that can be passed down, "type" is omitted from the prop list
|
|
586
|
+
* @example <Switch label="my switch" name="switch-name" onChange={() => setChecked((prev) => !prev)} checked={checked} infoText="my info text" toggleText="my toggle text" />
|
|
587
|
+
*/
|
|
588
|
+
declare const Switch: React$1.ForwardRefExoticComponent<Omit<React$1.InputHTMLAttributes<HTMLInputElement>, "type"> & {
|
|
589
|
+
/** sets the label value */
|
|
590
|
+
label: string;
|
|
591
|
+
/** (optional) sets information text */
|
|
592
|
+
infoText?: string | undefined;
|
|
593
|
+
/** sets the toggle text value */
|
|
594
|
+
toggleText?: string | undefined;
|
|
595
|
+
/** sets child elements */
|
|
596
|
+
children?: React$1.ReactNode;
|
|
597
|
+
} & React$1.RefAttributes<HTMLInputElement>>;
|
|
479
598
|
|
|
480
|
-
export { ActionButtonsProps, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, ChildFunction, ComboBoxGroupBase, ErrorMessage, ErrorMessageProps, Heading, HeadingProps, Icon, IconColor, IconProps, IconType, IconsProvider, Input, InputComboBox, InputComboBoxOption, InputComboBoxProps, InputInlineSelect, InputInlineSelectOption, InputInlineSelectProps, InputKeywordSearch, InputKeywordSearchProps, InputProps, InputSelect, InputSelectProps, InputToggle, InputToggleProps, LevelProps, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, Menu, MenuContext, MenuItem, MenuItemProps, MenuProps, Paragraph, ParagraphProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, Textarea, TextareaProps, Theme, ThemeProps, UniformBadge, UniformLogo, UniformLogoProps, breakpointSizeProps, breakpoints, breakpointsProps, input, inputError, inputSelect, labelText, mq, scrollbarStyles, useIconContext, useMenuContext };
|
|
599
|
+
export { ActionButtonsProps, AddButton, AddButtonProps, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, CaptionProps, ChildFunction, ComboBoxGroupBase, ErrorMessage, ErrorMessageProps, Heading, HeadingProps, Icon, IconColor, IconProps, IconType, IconsProvider, Input, InputComboBox, InputComboBoxOption, InputComboBoxProps, InputInlineSelect, InputInlineSelectOption, InputInlineSelectProps, InputKeywordSearch, InputKeywordSearchProps, InputProps, InputSelect, InputSelectProps, InputToggle, InputToggleProps, Label, LabelProps, LevelProps, Link, LinkColorProps, LinkProps, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, Menu, MenuContext, MenuItem, MenuItemProps, MenuProps, Paragraph, ParagraphProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, ShortcutContext, ShortcutRevealer, Switch, SwitchProps, Textarea, TextareaProps, Theme, ThemeProps, UniformBadge, UniformLogo, UniformLogoProps, breakpointSizeProps, breakpoints, breakpointsProps, input, inputError, inputSelect, labelText, mq, scrollbarStyles, useIconContext, useMenuContext };
|