@uniformdev/design-system 17.0.0 → 17.1.0

package/dist/index.d.ts

@@ -10,6 +10,7 @@ import { StateManagerProps } from 'react-select/dist/declarations/src/useStateMa
 import InternalSelect from 'react-select/dist/declarations/src/Select';
 import { MenuHTMLProps, MenuProps as MenuProps$1, MenuStateReturn } from 'reakit/Menu';
 import { MenuItemHTMLProps, MenuProps as MenuProps$2 } from 'reakit';
+import * as url from 'url';
 
 /** @todo: line 144 onwards will be brought into a title, paragraph, list and link components */
 declare type ThemeProps = {
@@ -47,7 +48,7 @@ declare const mq: (size: breakpointSizeProps) => string;
 declare const supports: (cssProp: string) => string;
 
 declare const labelText: _emotion_react.SerializedStyles;
-declare const input: _emotion_react.SerializedStyles;
+declare const input: (whiteSpaceWrap: 'wrap' | 'nowrap') => _emotion_react.SerializedStyles;
 declare const inputError: _emotion_react.SerializedStyles;
 declare const inputSelect: _emotion_react.SerializedStyles;
 
@@ -500,12 +501,16 @@ declare type HeadingProps = {
     level?: LevelProps;
     /** sets the title value */
     children: React$1.ReactNode;
+    /** (optional) sets whether to use the default margin for the heading element
+     * @default true
+     */
+    withMarginBottom?: boolean;
 } & React$1.HTMLAttributes<HTMLHeadingElement>;
 /**
  * Component that sets the heading tag
  * @example <Heading level={1}>Blog Post Title</Heading>
  */
-declare const Heading: ({ level, children, ...hAttributes }: HeadingProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const Heading: ({ level, withMarginBottom, children, ...hAttributes }: HeadingProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 declare type ParagraphProps = {
     /** (optional) adds child elements to the paragraph tag */
@@ -531,8 +536,9 @@ declare type PageHeaderSectionProps = React$1.HTMLAttributes<HTMLElement> & {
     children?: React$1.ReactNode;
     linkProps?: RouteProps;
     linkText?: string;
+    level?: LevelProps;
 };
-declare const PageHeaderSection: ({ title, desc, children, linkText, linkProps, ...htmlProps }: PageHeaderSectionProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const PageHeaderSection: ({ title, desc, children, linkText, level, linkProps, ...htmlProps }: PageHeaderSectionProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 declare type LinkColorProps = 'currentColor' | 'red' | 'green';
 declare type LinkProps = React$1.AnchorHTMLAttributes<HTMLAnchorElement> & {
@@ -546,9 +552,45 @@ declare type LinkProps = React$1.AnchorHTMLAttributes<HTMLAnchorElement> & {
     external?: boolean;
     /** (optional) For supporting inside next/link component */
     ref?: React$1.ForwardedRef<HTMLAnchorElement>;
+    /** (optional) sets react child elements */
+    children?: React$1.ReactNode;
 };
-declare const Link: ({ external, text, linkColor, ...props }: LinkProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
-declare const LinkWithRef: React$1.ForwardRefExoticComponent<Pick<LinkProps, "text" | "external" | keyof React$1.AnchorHTMLAttributes<HTMLAnchorElement> | "linkColor"> & React$1.RefAttributes<HTMLAnchorElement>>;
+/** Uniform Link Component
+ * @example <Link text="my link" href="#" />
+ */
+declare const Link: ({ external, text, linkColor, children, ...props }: LinkProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+/** Uniform LinkWithRef Component
+ * We recommend using this link `next/link`
+ * @example <NextLink {...someProps} passHref><LinkWithRef text="my link" /></NextLink>
+ */
+declare const LinkWithRef: React$1.ForwardRefExoticComponent<Pick<{
+    href: string | url.UrlObject;
+    as?: (string | url.UrlObject) | undefined;
+    replace?: boolean | undefined;
+    soft?: boolean | undefined;
+    scroll?: boolean | undefined;
+    shallow?: boolean | undefined;
+    passHref?: boolean | undefined;
+    prefetch?: boolean | undefined;
+    locale?: string | false | undefined;
+    legacyBehavior?: boolean | undefined;
+    onMouseEnter?: ((e: any) => void) | undefined;
+    onTouchStart?: ((e: any) => void) | undefined;
+    onClick?: ((e: any) => void) | undefined;
+} & React$1.AnchorHTMLAttributes<HTMLAnchorElement> & {
+    /** sets the link text and title text */
+    text: string;
+    /** (optional) sets the link color
+     * @default 'currentColor'
+     */
+    linkColor?: LinkColorProps | undefined;
+    /** (optional) sets whether the link is external or not adding an icon to the link */
+    external?: boolean | undefined;
+    /** (optional) For supporting inside next/link component */
+    ref?: React$1.ForwardedRef<HTMLAnchorElement> | undefined;
+    /** (optional) sets react child elements */
+    children?: React$1.ReactNode;
+}, "slot" | "style" | "title" | "text" | "className" | "as" | "href" | "hrefLang" | "media" | "referrerPolicy" | "rel" | "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" | "replace" | "target" | "external" | "scroll" | "soft" | "shallow" | "passHref" | "prefetch" | "locale" | "legacyBehavior" | "download" | "ping" | "linkColor"> & React$1.RefAttributes<HTMLAnchorElement>>;
 
 declare type IntegrationHeaderSectionProps = React$1.HtmlHTMLAttributes<HTMLDivElement> & {
     /** sets the title text of the integration */
@@ -956,4 +998,54 @@ declare const HexModalBackground: ({ ...props }: HexModalBackgroundProps) => _em
  */
 declare const IntegrationModalHeader: ({ icon, name, menu, children }: IntegrationModalHeaderProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
-export { ActionButtonsProps, AddButton, AddButtonProps, AddListButton, AddListButtonProps, ArrowPositionProps, Badge, BadgeProps, BoxHeightProps, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, CaptionProps, ChildFunction, ComboBoxGroupBase, CreateTeamIntegrationTile, CreateTeamIntegrationTileProps, DashedBox, DashedBoxProps, EditTeamIntegrationTile, EditTeamIntegrationTileProps, ErrorMessage, ErrorMessageProps, Heading, HeadingProps, HexModalBackground, Icon, IconColor, IconName, IconProps, IconType, IconsProvider, InlineAlert, InlineAlertProps, Input, InputComboBox, InputComboBoxOption, InputComboBoxProps, InputInlineSelect, InputInlineSelectOption, InputInlineSelectProps, InputKeywordSearch, InputKeywordSearchProps, InputProps, InputSelect, InputSelectProps, InputToggle, InputToggleProps, IntegrationComingSoon, IntegrationComingSoonProps, IntegrationHeaderSection, IntegrationHeaderSectionProps, IntegrationLoadingTile, IntegrationLoadingTileProps, IntegrationModalHeader, IntegrationModalHeaderProps, IntegrationModalIcon, IntegrationModalIconProps, IntegrationTile, IntegrationTileProps, Label, LabelProps, LevelProps, LimitsBar, LimitsBarProps, Link, LinkColorProps, LinkProps, LinkWithRef, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, Menu, MenuContext, MenuItem, MenuItemProps, MenuItemTextThemeProps, MenuProps, PageHeaderSection, PageHeaderSectionProps, Paragraph, ParagraphProps, ResolveIcon, ResolveIconProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, ShortcutContext, ShortcutRevealer, Switch, SwitchProps, Table, TableBody, TableBodyProps, TableCellData, TableCellDataProps, TableCellHead, TableCellHeadProps, TableFoot, TableFootProps, TableHead, TableHeadProps, TableProps, TableRow, TableRowProps, TextAlignProps, Textarea, TextareaProps, Theme, ThemeProps, TileContainer, TileContainerProps, UniformBadge, UniformLogo, UniformLogoProps, breakpointSizeProps, breakpoints, breakpointsProps, button, buttonGhost, buttonPrimary, buttonRippleEffect, buttonSecondary, buttonTertiary, buttonUnimportant, fadeIn, fadeInBottom, fadeInLtr, fadeOutBottom, growSubtle, input, inputError, inputSelect, labelText, mq, ripple, scrollbarStyles, skeletonLoading, supports, useIconContext, useMenuContext };
+declare type CardProps = React$1.HTMLAttributes<HTMLDivElement> & {
+    /** (optional) sets the title value of the card */
+    title?: string;
+    /** (optional) sets react child components */
+    children?: React$1.ReactNode;
+    /** (optional) sets options for a dropdown menu */
+    menuItems?: JSX.Element;
+    /** (optional) sets the data-test-id attribute on the button element
+     * @default 'list-card-menu'
+     */
+    menuButtonTestId?: string;
+    /** (optional) sets the menu button disabled state */
+    disabled?: boolean;
+};
+declare const Card: ({ title, menuItems, children, disabled, menuButtonTestId, ...props }: CardProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type CardContainerBgColorProps = 'gray' | 'white';
+declare type CardContainerProps = React$1.HTMLAttributes<HTMLDivElement> & {
+    /** (optional): sets the background colour of the wrapping element
+     * @default 'white'
+     */
+    bgColor?: CardContainerBgColorProps;
+    /** (optional): sets react child components */
+    children?: React$1.ReactNode;
+    /** (optional): sets the padding values of the inner container
+     * @example 'when set to true padding: var(--spacing-2xl) var(--spacing-lg)'
+     * @default true
+     */
+    padding?: boolean;
+    /** (optional): sets the padding values of the inner container
+     * @example `when set to true`
+     * grid-template-columns: repeat(auto-fit, minmax(300px, 1fr)) [last-col] minmax(300px, 1fr);
+     * grid-template-rows: auto [last-line];
+     * @default false
+     */
+    withLastColumn?: boolean;
+};
+/** Uniform Card Container
+ * @example <CardContainer><Card title="card title" /></CardContainer>
+ */
+declare const CardContainer: ({ bgColor, padding, withLastColumn, children, ...props }: CardContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare type LinkListProps = React$1.HTMLAttributes<HTMLDivElement> & {
+    /** sets the title field */
+    title: string;
+    /** (optional) sets react child component */
+    children?: React$1.ReactNode;
+};
+declare const LinkList: ({ title, children, ...props }: LinkListProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+export { ActionButtonsProps, AddButton, AddButtonProps, AddListButton, AddListButtonProps, ArrowPositionProps, Badge, BadgeProps, BoxHeightProps, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, CaptionProps, Card, CardContainer, CardContainerBgColorProps, CardContainerProps, CardProps, ChildFunction, ComboBoxGroupBase, CreateTeamIntegrationTile, CreateTeamIntegrationTileProps, DashedBox, DashedBoxProps, EditTeamIntegrationTile, EditTeamIntegrationTileProps, ErrorMessage, ErrorMessageProps, Heading, HeadingProps, HexModalBackground, Icon, IconColor, IconName, IconProps, IconType, IconsProvider, InlineAlert, InlineAlertProps, Input, InputComboBox, InputComboBoxOption, InputComboBoxProps, InputInlineSelect, InputInlineSelectOption, InputInlineSelectProps, InputKeywordSearch, InputKeywordSearchProps, InputProps, InputSelect, InputSelectProps, InputToggle, InputToggleProps, IntegrationComingSoon, IntegrationComingSoonProps, IntegrationHeaderSection, IntegrationHeaderSectionProps, IntegrationLoadingTile, IntegrationLoadingTileProps, IntegrationModalHeader, IntegrationModalHeaderProps, IntegrationModalIcon, IntegrationModalIconProps, IntegrationTile, IntegrationTileProps, Label, LabelProps, LevelProps, LimitsBar, LimitsBarProps, Link, LinkColorProps, LinkList, LinkListProps, LinkProps, LinkWithRef, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, Menu, MenuContext, MenuItem, MenuItemProps, MenuItemTextThemeProps, MenuProps, PageHeaderSection, PageHeaderSectionProps, Paragraph, ParagraphProps, ResolveIcon, ResolveIconProps, ScrollableList, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, ShortcutContext, ShortcutRevealer, Switch, SwitchProps, Table, TableBody, TableBodyProps, TableCellData, TableCellDataProps, TableCellHead, TableCellHeadProps, TableFoot, TableFootProps, TableHead, TableHeadProps, TableProps, TableRow, TableRowProps, TextAlignProps, Textarea, TextareaProps, Theme, ThemeProps, TileContainer, TileContainerProps, UniformBadge, UniformLogo, UniformLogoProps, breakpointSizeProps, breakpoints, breakpointsProps, button, buttonGhost, buttonPrimary, buttonRippleEffect, buttonSecondary, buttonTertiary, buttonUnimportant, fadeIn, fadeInBottom, fadeInLtr, fadeOutBottom, growSubtle, input, inputError, inputSelect, labelText, mq, ripple, scrollbarStyles, skeletonLoading, supports, useIconContext, useMenuContext };