@uniformdev/design-system 18.22.0 → 18.24.0

package/dist/index.d.ts

@@ -12,6 +12,7 @@ import { IconType as IconType$1, IconBaseProps } from 'react-icons';
 import InternalSelect from 'react-select/dist/declarations/src/Select';
 import { StateManagerProps } from 'react-select/dist/declarations/src/useStateManager';
 import { MenuHTMLProps, MenuProps as MenuProps$2, MenuStateReturn } from 'reakit/Menu';
+import { PopoverProps as PopoverProps$1, PopoverInitialState } from 'reakit/Popover';
 import { TabState, TabListProps, TabProps, TabPanelProps } from 'reakit/Tab';
 import { TooltipOptions, TooltipInitialState } from 'reakit/Tooltip';
 
@@ -436,6 +437,7 @@ type DrawerContextValue = {
  */
 declare const DrawerProvider: ({ children }: React__default.PropsWithChildren) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 declare const useDrawer: () => DrawerContextValue;
+declare const useCloseCurrentDrawer: () => (() => void) | undefined;
 
 interface DrawerProps extends Omit<DrawerItem, 'component'> {
     header?: React__default.ReactNode;
@@ -852,6 +854,42 @@ type WarningMessageProps = React.HTMLAttributes<HTMLSpanElement> & {
  */
 declare const WarningMessage: ({ message, testId, ...props }: WarningMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
 
+type SpacingProp = '0' | '2xs' | 'xs' | 'sm' | 'base' | 'md' | 'lg' | 'xl' | '2xl';
+type BackgroundColorProp = 'white' | 'gray-50' | 'gray-100' | 'gray-200' | 'gray-300' | 'gray-400' | 'gray-500' | 'gray-600' | 'gray-700' | 'gray-800' | 'gray-900';
+type HtmlTagProps = 'div' | 'section' | 'article' | 'aside';
+type BorderRadiusProps = 'rounded-sm' | '--rounded-base' | 'rounded-md';
+type CommonContainerProps = {
+    /** sets the background color of the element */
+    backgroundColor?: BackgroundColorProp;
+    /** sets border: 1px solid var(--gray-300)*/
+    border?: boolean;
+    /** sets the border radius of the element */
+    rounded?: BorderRadiusProps;
+    /** sets the padding of the element */
+    padding?: string;
+    /** sets the margin of the element */
+    margin?: string;
+};
+
+type ContainerProps = CommonContainerProps & React$1.HTMLAttributes<HTMLDivElement> & {
+    tag?: HtmlTagProps;
+    children: React$1.ReactNode;
+};
+declare const Container: ({ tag, backgroundColor, border, rounded, padding, margin, children, ...props }: ContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+type VerticalRhythmProps = React$1.HTMLAttributes<HTMLDivElement | HTMLFieldSetElement> & {
+    /** sets the wrapping html tag
+     * @default 'div'
+     */
+    tag?: HtmlTagProps | 'fieldset';
+    /** sets the vertical spacing between each element
+     * @default 'base'
+     */
+    gap?: SpacingProp;
+    children: React$1.ReactNode;
+};
+declare const VerticalRhythm: ({ tag, gap, children, ...props }: VerticalRhythmProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
 type LimitsBarProps = {
     /** The current value of used limits */
     current: number;
@@ -1045,6 +1083,10 @@ type CommonParameterProps = {
     errorMessage?: string;
     /** (optional) allows users to manually set the error message state */
     onManuallySetErrorMessage?: (message: string | undefined) => void;
+    /** sets whether to show the override UI */
+    hasOverriddenValue?: boolean;
+    /** sets the function call of the overriding parameters button */
+    onResetOverriddenValue?: () => void;
 };
 type CommonParameterInputProps = CommonParameterProps & {
     /** (optional) sets caption text value */
@@ -1059,8 +1101,6 @@ type CommonParameterInputProps = CommonParameterProps & {
      *  recommended to be used with radio and checkbox inputs
      */
     title?: string;
-    /** sets whether to show the override UI */
-    hasOverridingParams?: boolean;
 };
 type CommonOptionProps = Array<React.OptionHTMLAttributes<HTMLOptionElement> & {
     label: string;
@@ -1109,7 +1149,7 @@ declare const ParameterDrawerHeader: ({ title, iconBeforeTitle, children }: Para
 
 type ParameterGroupProps = React.HTMLAttributes<HTMLFieldSetElement> & {
     /** sets the legend value */
-    legend: string;
+    legend: string | JSX.Element;
     /** (optional) - sets a disabled attribute at the field level disabling all child input fields and buttons */
     isDisabled?: boolean;
     children: ReactNode;
@@ -1117,7 +1157,7 @@ type ParameterGroupProps = React.HTMLAttributes<HTMLFieldSetElement> & {
 /** @example <ParameterGroup legend="legend name">{...some form input elements}</ParameterGroup> */
 declare const ParameterGroup: React$1.ForwardRefExoticComponent<React$1.HTMLAttributes<HTMLFieldSetElement> & {
     /** sets the legend value */
-    legend: string;
+    legend: string | JSX.Element;
     /** (optional) - sets a disabled attribute at the field level disabling all child input fields and buttons */
     isDisabled?: boolean | undefined;
     children: ReactNode;
@@ -1136,7 +1176,6 @@ declare const ParameterInput: React$1.ForwardRefExoticComponent<CommonParameterP
     errorTestId?: string | undefined;
     captionTestId?: string | undefined;
     title?: string | undefined;
-    hasOverridingParams?: boolean | undefined;
 } & React$1.InputHTMLAttributes<HTMLInputElement> & React$1.RefAttributes<HTMLInputElement>>;
 declare const ParameterInputInner: React$1.ForwardRefExoticComponent<React$1.InputHTMLAttributes<HTMLInputElement> & React$1.RefAttributes<HTMLInputElement>>;
 
@@ -1242,7 +1281,6 @@ declare const ParameterRichText: React$1.ForwardRefExoticComponent<React$1.Input
     errorTestId?: string | undefined;
     captionTestId?: string | undefined;
     title?: string | undefined;
-    hasOverridingParams?: boolean | undefined;
 } & React$1.RefAttributes<HTMLTextAreaElement>>;
 declare const ParameterRichTextInner: React$1.ForwardRefExoticComponent<React$1.InputHTMLAttributes<HTMLTextAreaElement> & React$1.RefAttributes<HTMLTextAreaElement>>;
 
@@ -1254,7 +1292,6 @@ declare const ParameterSelect: React$1.ForwardRefExoticComponent<CommonParameter
     errorTestId?: string | undefined;
     captionTestId?: string | undefined;
     title?: string | undefined;
-    hasOverridingParams?: boolean | undefined;
 } & CommonParameterSelectProps & React$1.InputHTMLAttributes<HTMLSelectElement> & React$1.RefAttributes<HTMLSelectElement>>;
 /** @example  <ParameterSelectInner options={[{ label: 'option label', value: 0}]} />*/
 declare const ParameterSelectInner: React$1.ForwardRefExoticComponent<Omit<ParameterSelectProps, "label" | "id"> & React$1.RefAttributes<HTMLSelectElement>>;
@@ -1263,11 +1300,10 @@ declare const ParameterSelectInner: React$1.ForwardRefExoticComponent<Omit<Param
  * @example const { shellProps, innerProps } = extractParameterProps(props) */
 declare const extractParameterProps: <T>(props: T & CommonParameterProps & {
     caption?: string | undefined;
-    menuItems?: React$1.ReactNode;
+    menuItems?: ReactNode;
     errorTestId?: string | undefined;
     captionTestId?: string | undefined;
     title?: string | undefined;
-    hasOverridingParams?: boolean | undefined;
 }) => {
     shellProps: {
         id: string;
@@ -1277,33 +1313,37 @@ declare const extractParameterProps: <T>(props: T & CommonParameterProps & {
         errorMessage: string | undefined;
         errorTestId: string | undefined;
         hiddenLabel: boolean | undefined;
-        labelLeadingIcon: React$1.ReactNode;
-        menuItems: React$1.ReactNode;
+        labelLeadingIcon: ReactNode;
+        menuItems: ReactNode;
         onManuallySetErrorMessage: ((message: string | undefined) => void) | undefined;
         title: string | undefined;
-        hasOverridingParams: boolean | undefined;
+        hasOverriddenValue: boolean | undefined;
+        onResetOverriddenValue: (() => void) | undefined;
     };
     innerProps: Omit<T & CommonParameterProps & {
         caption?: string | undefined;
-        menuItems?: React$1.ReactNode;
+        menuItems?: ReactNode;
         errorTestId?: string | undefined;
         captionTestId?: string | undefined;
         title?: string | undefined;
-        hasOverridingParams?: boolean | undefined;
-    }, "caption" | "label" | "title" | "id" | "menuItems" | "errorMessage" | "errorTestId" | "captionTestId" | "hiddenLabel" | "onManuallySetErrorMessage" | "labelLeadingIcon" | "hasOverridingParams">;
+    }, "caption" | "label" | "title" | "id" | "menuItems" | "errorMessage" | "errorTestId" | "captionTestId" | "hiddenLabel" | "onManuallySetErrorMessage" | "labelLeadingIcon" | "hasOverriddenValue" | "onResetOverriddenValue">;
 };
 type ParameterShellOverrideProps = {
     /** sets overriding parameters indicator */
-    hasOverridingParams?: boolean;
+    hasOverriddenValue?: boolean;
+    /** sets the function call of the overriding parameters button */
+    onResetOverriddenValue?: () => void;
 };
 type ParameterShellProps = React.InputHTMLAttributes<HTMLDivElement> & CommonParameterInputProps & ParameterShellOverrideProps;
 /**
  * Uniform Parameter shell component
  * @example <ParameterShell label="my label" id="my-id"><ParameterInput onChange={() => {}} /></ParameterShell>
  */
-declare const ParameterShell: ({ label, labelLeadingIcon, hiddenLabel, id, errorMessage, caption, errorTestId, captionTestId, menuItems, hasOverridingParams, title, children, ...props }: ParameterShellProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
-declare const ParameterShellPlaceholder: ({ hasOverridingParams }: ParameterShellOverrideProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
-declare const ParameterOverrideMarker: () => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const ParameterShell: ({ label, labelLeadingIcon, hiddenLabel, id, errorMessage, caption, errorTestId, captionTestId, menuItems, hasOverriddenValue, onResetOverriddenValue, title, children, ...props }: ParameterShellProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const ParameterShellPlaceholder: ({ children }: {
+    children?: ReactNode;
+}) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const ParameterOverrideMarker: (props: HTMLAttributes<HTMLButtonElement>) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type ParameterTextareaProps = CommonParameterInputProps & React.TextareaHTMLAttributes<HTMLTextAreaElement>;
 /** @example <ParameterTextarea label="label value" id="my-textarea" /> */
@@ -1313,7 +1353,6 @@ declare const ParameterTextarea: React$1.ForwardRefExoticComponent<CommonParamet
     errorTestId?: string | undefined;
     captionTestId?: string | undefined;
     title?: string | undefined;
-    hasOverridingParams?: boolean | undefined;
 } & React$1.TextareaHTMLAttributes<HTMLTextAreaElement> & React$1.RefAttributes<HTMLTextAreaElement>>;
 /** @example <ParameterTextareaInner /> */
 declare const ParameterTextareaInner: React$1.ForwardRefExoticComponent<React$1.HTMLAttributes<HTMLTextAreaElement> & React$1.RefAttributes<HTMLTextAreaElement>>;
@@ -1327,6 +1366,24 @@ declare const ParameterToggle: React$1.ForwardRefExoticComponent<React$1.InputHT
 } & React$1.RefAttributes<HTMLInputElement>>;
 declare const ParameterToggleInner: React$1.ForwardRefExoticComponent<React$1.InputHTMLAttributes<HTMLInputElement> & React$1.RefAttributes<HTMLInputElement>>;
 
+type PopoverProps = PopoverProps$1 & {
+    /** sets the aria-controls and id value of the matching popover set */
+    /** sets the icon color
+     * @default 'green'
+     */
+    iconColor?: IconColor;
+    /** sets the aria label attribute on the popover */
+    ariaLabel?: string;
+    /** sets the title attr and text of the button */
+    buttonText: string;
+    /** sets the placement of the popover
+     * @default 'bottom'
+     */
+    placement?: PopoverInitialState['placement'];
+    children: ReactNode;
+};
+declare const Popover: ({ iconColor, buttonText, ariaLabel, placement, children, }: PopoverProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
 declare function ShortcutContext({ children }: {
     children: React__default.ReactNode;
 }): _emotion_react_types_jsx_namespace.EmotionJSX.Element;
@@ -1698,10 +1755,19 @@ declare const Paragraph: ({ className, htmlContent, children, ...pAttributes }:
 
 type StatusTypeProps = 'Modified' | 'Unsaved' | 'Error' | 'Draft' | 'Published' | 'Orphan';
 type StatusBulletProps = React$1.HTMLAttributes<HTMLSpanElement> & {
+    /** sets the current status */
     status: StatusTypeProps;
+    /** sets an overriding message */
     message?: string;
+    /** sets whether to show or hide the status text
+     * @default false
+     */
     hideText?: boolean;
+    /** sets the size of the status message and icon
+     * @default 'base'
+     */
+    size?: 'sm' | 'base';
 };
-declare const StatusBullet: ({ status, hideText, message, ...props }: StatusBulletProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const StatusBullet: ({ status, hideText, size, message, ...props }: StatusBulletProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
-export { ActionButtonsProps, AddButton, AddButtonProps, AddListButton, AddListButtonProps, AddListButtonThemeProps, AnimationFile, AnimationFileProps, ArrowPositionProps, Badge, BadgeProps, BoxHeightProps, BreakpointSize, BreakpointsMap, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, CaptionProps, Card, CardContainer, CardContainerBgColorProps, CardContainerProps, CardProps, CheckboxWithInfo, CheckboxWithInforProps, ChildFunction, ComboBoxGroupBase, ConnectToDataElementButton, ConnectToDataElementButtonProps, Counter, CounterProps, CreateTeamIntegrationTile, CreateTeamIntegrationTileProps, DashedBox, DashedBoxProps, Details, DetailsProps, Drawer, DrawerContextValue, DrawerItem, DrawerProps, DrawerProvider, DrawerRenderer, DrawerRendererItemProps, DrawerRendererProps, EditTeamIntegrationTile, EditTeamIntegrationTileProps, ErrorMessage, ErrorMessageProps, Fieldset, FieldsetProps, 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, Legend, LegendProps, LevelProps, LimitsBar, LimitsBarProps, Link, LinkColorProps, LinkList, LinkListProps, LinkManagerWithRefType, LinkProps, LinkWithRef, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, LottieFile, LottieFileKeyProps, LottieFileProps, Menu, MenuContext, MenuItem, MenuItemProps, MenuItemSeparator, MenuItemTextThemeProps, MenuProps, PageHeaderSection, PageHeaderSectionProps, Paragraph, ParagraphProps, ParameterDataConnectButtonProps, ParameterDataResource, ParameterDrawerHeader, ParameterDrawerHeaderProps, ParameterGroup, ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImageProps, ParameterInput, ParameterInputInner, ParameterInputProps, ParameterLabel, ParameterLabelProps, ParameterLink, ParameterLinkInner, ParameterLinkProps, ParameterMenuButton, ParameterMenuButtonProps, ParameterNameAndPublicIdInput, ParameterNameAndPublicIdInputProps, ParameterOverrideMarker, ParameterRichText, ParameterRichTextInner, ParameterRichTextProps, ParameterSelect, ParameterSelectInner, ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellPlaceholder, ParameterShellProps, ParameterTextarea, ParameterTextareaInner, ParameterTextareaProps, ParameterToggle, ParameterToggleInner, ParameterToggleProps, RegisterDrawerProps, ResolveIcon, ResolveIconProps, ScrollableItemProps, ScrollableList, ScrollableListInputItem, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, ShortcutContext, ShortcutRevealer, Skeleton, SkeletonProps, StatusBullet, StatusBulletProps, StatusTypeProps, Switch, SwitchProps, TabButton, TabButtonGroup, TabButtonProps, TabContent, TabContentProps, Table, TableBody, TableBodyProps, TableCellData, TableCellDataProps, TableCellHead, TableCellHeadProps, TableFoot, TableFootProps, TableHead, TableHeadProps, TableProps, TableRow, TableRowProps, Tabs, TabsProps, TextAlignProps, Textarea, TextareaProps, Theme, ThemeProps, TileContainer, TileContainerProps, Tooltip, TooltipProps, UniformBadge, UniformLogo, UniformLogoProps, UseShortcutOptions, WarningMessage, WarningMessageProps, breakpoints, button, buttonGhost, buttonGhostDestructive, buttonPrimary, buttonRippleEffect, buttonSecondary, buttonSecondaryInvert, buttonTertiary, buttonUnimportant, extractParameterProps, fadeIn, fadeInBottom, fadeInLtr, fadeInRtl, fadeInTop, fadeOutBottom, growSubtle, input, inputError, inputSelect, isMacLike, labelText, macifyShortcut, mq, ripple, scrollbarStyles, skeletonLoading, supports, useBreakpoint, useCurrentDrawerRenderer, useCurrentTab, useDrawer, useIconContext, useMenuContext, useOutsideClick, useParameterShell, useShortcut };
+export { ActionButtonsProps, AddButton, AddButtonProps, AddListButton, AddListButtonProps, AddListButtonThemeProps, AnimationFile, AnimationFileProps, ArrowPositionProps, Badge, BadgeProps, BoxHeightProps, BreakpointSize, BreakpointsMap, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, CaptionProps, Card, CardContainer, CardContainerBgColorProps, CardContainerProps, CardProps, CheckboxWithInfo, CheckboxWithInforProps, ChildFunction, ComboBoxGroupBase, ConnectToDataElementButton, ConnectToDataElementButtonProps, Container, ContainerProps, Counter, CounterProps, CreateTeamIntegrationTile, CreateTeamIntegrationTileProps, DashedBox, DashedBoxProps, Details, DetailsProps, Drawer, DrawerContextValue, DrawerItem, DrawerProps, DrawerProvider, DrawerRenderer, DrawerRendererItemProps, DrawerRendererProps, EditTeamIntegrationTile, EditTeamIntegrationTileProps, ErrorMessage, ErrorMessageProps, Fieldset, FieldsetProps, 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, Legend, LegendProps, LevelProps, LimitsBar, LimitsBarProps, Link, LinkColorProps, LinkList, LinkListProps, LinkManagerWithRefType, LinkProps, LinkWithRef, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, LottieFile, LottieFileKeyProps, LottieFileProps, Menu, MenuContext, MenuItem, MenuItemProps, MenuItemSeparator, MenuItemTextThemeProps, MenuProps, PageHeaderSection, PageHeaderSectionProps, Paragraph, ParagraphProps, ParameterDataConnectButtonProps, ParameterDataResource, ParameterDrawerHeader, ParameterDrawerHeaderProps, ParameterGroup, ParameterGroupProps, ParameterImage, ParameterImageInner, ParameterImageProps, ParameterInput, ParameterInputInner, ParameterInputProps, ParameterLabel, ParameterLabelProps, ParameterLink, ParameterLinkInner, ParameterLinkProps, ParameterMenuButton, ParameterMenuButtonProps, ParameterNameAndPublicIdInput, ParameterNameAndPublicIdInputProps, ParameterOverrideMarker, ParameterRichText, ParameterRichTextInner, ParameterRichTextProps, ParameterSelect, ParameterSelectInner, ParameterSelectProps, ParameterShell, ParameterShellContext, ParameterShellPlaceholder, ParameterShellProps, ParameterTextarea, ParameterTextareaInner, ParameterTextareaProps, ParameterToggle, ParameterToggleInner, ParameterToggleProps, Popover, PopoverProps, RegisterDrawerProps, ResolveIcon, ResolveIconProps, ScrollableItemProps, ScrollableList, ScrollableListInputItem, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, ShortcutContext, ShortcutRevealer, Skeleton, SkeletonProps, StatusBullet, StatusBulletProps, StatusTypeProps, Switch, SwitchProps, TabButton, TabButtonGroup, TabButtonProps, TabContent, TabContentProps, Table, TableBody, TableBodyProps, TableCellData, TableCellDataProps, TableCellHead, TableCellHeadProps, TableFoot, TableFootProps, TableHead, TableHeadProps, TableProps, TableRow, TableRowProps, Tabs, TabsProps, TextAlignProps, Textarea, TextareaProps, Theme, ThemeProps, TileContainer, TileContainerProps, Tooltip, TooltipProps, UniformBadge, UniformLogo, UniformLogoProps, UseShortcutOptions, VerticalRhythm, VerticalRhythmProps, WarningMessage, WarningMessageProps, breakpoints, button, buttonGhost, buttonGhostDestructive, buttonPrimary, buttonRippleEffect, buttonSecondary, buttonSecondaryInvert, buttonTertiary, buttonUnimportant, extractParameterProps, fadeIn, fadeInBottom, fadeInLtr, fadeInRtl, fadeInTop, fadeOutBottom, growSubtle, input, inputError, inputSelect, isMacLike, labelText, macifyShortcut, mq, ripple, scrollbarStyles, skeletonLoading, supports, useBreakpoint, useCloseCurrentDrawer, useCurrentDrawerRenderer, useCurrentTab, useDrawer, useIconContext, useMenuContext, useOutsideClick, useParameterShell, useShortcut };