@uniformdev/design-system 19.10.0 → 19.12.0

package/dist/index.d.ts

@@ -20321,12 +20321,14 @@ interface CalloutProps {
     children?: React$1.ReactNode;
     /** sets additional css classes or emotion styles on the callout */
     className?: SerializedStyles | string;
+    /** sets the data-test-id on the callout element */
+    testId?: string;
 }
 /**
  * Uniform Callout Component
  * @example <Callout title="my title" type="caution"><p>callout body copy</p></Callout>
  */
-declare const Callout: ({ type, compact, title, children, className }: CalloutProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
+declare const Callout: ({ type, compact, title, children, className, testId, }: CalloutProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
 
 type CardProps = React$1.HTMLAttributes<HTMLDivElement> & {
     /** (optional) sets the title value of the card */
@@ -20932,6 +20934,18 @@ type LegendProps = {
 };
 declare const Legend: ({ children }: LegendProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
+type SuccessMessageProps = React.HTMLAttributes<HTMLSpanElement> & {
+    /** sets the error message value */
+    message?: string;
+    /** sets the test id for test automation (optional) */
+    testId?: string;
+};
+/**
+ * Component that provides success messaging to input fields
+ * @example <SuccessMessage>something went wrong, please try again</SuccessMessage>
+ */
+declare const SuccessMessage: ({ message, testId, ...props }: SuccessMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
+
 type TextareaProps = React$1.TextareaHTMLAttributes<HTMLTextAreaElement> & {
     /** (optional) sets the label value */
     label?: string;
@@ -21004,25 +21018,30 @@ type CommonContainerProps = {
     /** 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 HorizontalRhythmProps = React$1.HTMLAttributes<HTMLDivElement | HTMLFieldSetElement> & {
+type AlignmentProps = 'baseline' | 'center' | 'end' | 'flex-end' | 'flex-start' | 'inherit' | 'initial' | 'normal' | 'revert' | 'self-end' | 'self-start' | 'start' | 'stretch' | 'unset';
+type RhythmProps = React.HTMLAttributes<HTMLDivElement | HTMLFieldSetElement> & {
     /** sets the wrapping html tag
      * @default 'div'
      */
     tag?: HtmlTagProps | 'fieldset';
-    /** sets the vertical spacing between each element
+    /** sets the spacing between each element
      * @default 'div'
      */
     gap?: SpacingProp;
+    /** sets the alignment of elements
+     * @default normal browser behaviour
+     */
+    align?: AlignmentProps;
+    children: React.ReactNode;
+};
+
+type ContainerProps = CommonContainerProps & React$1.HTMLAttributes<HTMLDivElement> & {
+    tag?: HtmlTagProps;
     children: React$1.ReactNode;
 };
-declare const HorizontalRhythm: ({ tag, gap, children, ...props }: HorizontalRhythmProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const Container: ({ tag, backgroundColor, border, rounded, padding, margin, children, ...props }: ContainerProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+
+declare const HorizontalRhythm: ({ align, tag, gap, children, ...props }: RhythmProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type TwoColumnLayoutProps = {
     /** sets the full bleed background colour
@@ -21041,18 +21060,7 @@ type TwoColumnLayoutProps = {
 /** @example <TwoColumnLayout supportingContent={<div>supporting content</div>}><h1>title</h1></TwoColumnLayout> */
 declare const TwoColumnLayout: ({ bgColor, invertLayout, supportingContent, children, }: TwoColumnLayoutProps) => _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 'div'
-     */
-    gap?: SpacingProp;
-    children: React$1.ReactNode;
-};
-declare const VerticalRhythm: ({ tag, gap, children, ...props }: VerticalRhythmProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
+declare const VerticalRhythm: ({ align, tag, gap, children, ...props }: RhythmProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
 
 type LimitsBarProps = {
     /** The current value of used limits */
@@ -21279,7 +21287,7 @@ type CommonParameterProps = {
     /** (optional) sets and shows the the info message value */
     infoMessage?: string;
     /** (optional) allows users to manually set the error message state */
-    onManuallySetErrorMessage?: (message: string | undefined) => void;
+    handleManuallySetErrorMessage?: (message: string | undefined) => void;
     /** sets whether to show the override UI */
     hasOverriddenValue?: boolean;
     /** sets the function call of the overriding parameters button */
@@ -21315,7 +21323,7 @@ declare const useParameterShell: () => {
     label: string;
     hiddenLabel: boolean | undefined;
     errorMessage: string | undefined;
-    onManuallySetErrorMessage: ((message: string | undefined) => void) | undefined;
+    handleManuallySetErrorMessage: ((message: string | undefined) => void) | undefined;
 };
 
 type ParameterDataConnectButtonProps = {
@@ -21520,7 +21528,7 @@ declare const extractParameterProps: <T>(props: T & CommonParameterProps & {
         hiddenLabel: boolean | undefined;
         labelLeadingIcon: ReactNode;
         menuItems: ReactNode;
-        onManuallySetErrorMessage: ((message: string | undefined) => void) | undefined;
+        handleManuallySetErrorMessage: ((message: string | undefined) => void) | undefined;
         title: string | undefined;
         hasOverriddenValue: boolean | undefined;
         onResetOverriddenValue: (() => void) | undefined;
@@ -21531,7 +21539,7 @@ declare const extractParameterProps: <T>(props: T & CommonParameterProps & {
         errorTestId?: string | undefined;
         captionTestId?: string | undefined;
         title?: string | undefined;
-    }, "caption" | "label" | "title" | "id" | "menuItems" | "errorMessage" | "warningMessage" | "errorTestId" | "captionTestId" | "hiddenLabel" | "onManuallySetErrorMessage" | "labelLeadingIcon" | "infoMessage" | "hasOverriddenValue" | "onResetOverriddenValue">;
+    }, "caption" | "label" | "title" | "id" | "menuItems" | "errorMessage" | "warningMessage" | "errorTestId" | "captionTestId" | "hiddenLabel" | "handleManuallySetErrorMessage" | "labelLeadingIcon" | "infoMessage" | "hasOverriddenValue" | "onResetOverriddenValue">;
 };
 type ParameterShellOverrideProps = {
     /** sets overriding parameters indicator */
@@ -22014,7 +22022,7 @@ declare const LinkWithRef: React$1.ForwardRefExoticComponent<Omit<React$1.Anchor
 }, "ref"> & React$1.RefAttributes<HTMLAnchorElement>>;
 
 interface RouteProps {
-    as: string;
+    as?: string;
     href: string;
 }
 type PageHeaderSectionProps = React$1.HTMLAttributes<HTMLElement> & {
@@ -22059,4 +22067,4 @@ type StatusBulletProps = React$1.HTMLAttributes<HTMLSpanElement> & {
 };
 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, BadgeSizeProps, BadgeThemeProps, BadgeThemeStyleProps, Banner, BannerProps, BannerType, BoxHeightProps, BreakpointSize, BreakpointsMap, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, CaptionProps, Card, CardContainer, CardContainerBgColorProps, CardContainerProps, CardProps, CardTitle, CardTitleProps, CheckboxWithInfo, CheckboxWithInforProps, ChildFunction, Chip, ChipProps, ComboBoxGroupBase, ConnectToDataElementButton, ConnectToDataElementButtonProps, Container, ContainerProps, Counter, CounterProps, CreateTeamIntegrationTile, CreateTeamIntegrationTileProps, DashedBox, DashedBoxProps, Details, DetailsProps, DismissibleChipAction, Drawer, DrawerContextValue, DrawerItem, DrawerProps, DrawerProvider, DrawerRenderer, DrawerRendererItemProps, DrawerRendererProps, EditTeamIntegrationTile, EditTeamIntegrationTileProps, ErrorMessage, ErrorMessageProps, Fieldset, FieldsetProps, Heading, HeadingProps, HexModalBackground, HorizontalRhythm, HorizontalRhythmProps, Icon, IconColor, IconName, IconProps, IconType, IconsProvider, InfoMessage, InfoMessageProps, 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, JsonEditor, JsonEditorProps, Label, LabelProps, Legend, LegendProps, LevelProps, LimitsBar, LimitsBarProps, Link, LinkColorProps, LinkList, LinkListProps, LinkManagerWithRefType, LinkProps, LinkWithRef, LoadingCardSkeleton, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, Menu, MenuContext, MenuGroup, MenuGroupProps, 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, ProgressList, ProgressListItem, ProgressListItemProps, ProgressListProps, RegisterDrawerProps, ResolveIcon, ResolveIconProps, ScrollableItemProps, ScrollableList, ScrollableListContainerProps, ScrollableListInputItem, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, SegmentedControl, SegmentedControlOption, SegmentedControlProps, 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, TwoColumnLayout, TwoColumnLayoutProps, UniformBadge, UniformLogo, UniformLogoLarge, UniformLogoProps, UseShortcutOptions, VerticalRhythm, VerticalRhythmProps, WarningMessage, WarningMessageProps, accessibleHidden, borderTopIcon, breakpoints, button, buttonDestructive, buttonGhost, buttonGhostDestructive, buttonGhostUnimportant, buttonPrimary, buttonPrimaryInvert, buttonRippleEffect, buttonSecondary, buttonSecondaryInvert, buttonTertiary, buttonUnimportant, canvasAlertIcon, cardIcon, cq, customIcons, extractParameterProps, fadeIn, fadeInBottom, fadeInLtr, fadeInRtl, fadeInTop, fadeOutBottom, fullWidthScreenIcon, growSubtle, imageTextIcon, infoFilledIcon, input, inputError, inputSelect, isMacLike, labelText, loader as loaderAnimationData, macifyShortcut, mq, numberInput, queryStringIcon, rectangleRoundedIcon, replaceUnderscoreInString, ripple, scrollbarStyles, settings, skeletonLoading, slideInTtb, spinner as spinnerAnimationData, supports, textInput, useBreakpoint, useCloseCurrentDrawer, useCurrentDrawerRenderer, useCurrentTab, useDrawer, useIconContext, useMenuContext, useOutsideClick, useParameterShell, useShortcut, warningIcon };
+export { ActionButtonsProps, AddButton, AddButtonProps, AddListButton, AddListButtonProps, AddListButtonThemeProps, AnimationFile, AnimationFileProps, ArrowPositionProps, Badge, BadgeProps, BadgeSizeProps, BadgeThemeProps, BadgeThemeStyleProps, Banner, BannerProps, BannerType, BoxHeightProps, BreakpointSize, BreakpointsMap, Button, ButtonProps, ButtonSizeProps, ButtonThemeProps$1 as ButtonThemeProps, ButtonWithMenu, ButtonWithMenuProps, Callout, CalloutProps, CalloutType, Caption, CaptionProps, Card, CardContainer, CardContainerBgColorProps, CardContainerProps, CardProps, CardTitle, CardTitleProps, CheckboxWithInfo, CheckboxWithInforProps, ChildFunction, Chip, ChipProps, ComboBoxGroupBase, ConnectToDataElementButton, ConnectToDataElementButtonProps, Container, ContainerProps, Counter, CounterProps, CreateTeamIntegrationTile, CreateTeamIntegrationTileProps, DashedBox, DashedBoxProps, Details, DetailsProps, DismissibleChipAction, Drawer, DrawerContextValue, DrawerItem, DrawerProps, DrawerProvider, DrawerRenderer, DrawerRendererItemProps, DrawerRendererProps, EditTeamIntegrationTile, EditTeamIntegrationTileProps, ErrorMessage, ErrorMessageProps, Fieldset, FieldsetProps, Heading, HeadingProps, HexModalBackground, HorizontalRhythm, Icon, IconColor, IconName, IconProps, IconType, IconsProvider, InfoMessage, InfoMessageProps, 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, JsonEditor, JsonEditorProps, Label, LabelProps, Legend, LegendProps, LevelProps, LimitsBar, LimitsBarProps, Link, LinkColorProps, LinkList, LinkListProps, LinkManagerWithRefType, LinkProps, LinkWithRef, LoadingCardSkeleton, LoadingIcon, LoadingIconProps, LoadingIndicator, LoadingOverlay, LoadingOverlayProps, Menu, MenuContext, MenuGroup, MenuGroupProps, 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, ProgressList, ProgressListItem, ProgressListItemProps, ProgressListProps, RegisterDrawerProps, ResolveIcon, ResolveIconProps, ScrollableItemProps, ScrollableList, ScrollableListContainerProps, ScrollableListInputItem, ScrollableListItem, ScrollableListItemProps, ScrollableListProps, SegmentedControl, SegmentedControlOption, SegmentedControlProps, ShortcutContext, ShortcutRevealer, Skeleton, SkeletonProps, StatusBullet, StatusBulletProps, StatusTypeProps, SuccessMessage, SuccessMessageProps, 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, TwoColumnLayout, TwoColumnLayoutProps, UniformBadge, UniformLogo, UniformLogoLarge, UniformLogoProps, UseShortcutOptions, VerticalRhythm, WarningMessage, WarningMessageProps, accessibleHidden, borderTopIcon, breakpoints, button, buttonDestructive, buttonGhost, buttonGhostDestructive, buttonGhostUnimportant, buttonPrimary, buttonPrimaryInvert, buttonRippleEffect, buttonSecondary, buttonSecondaryInvert, buttonTertiary, buttonUnimportant, canvasAlertIcon, cardIcon, cq, customIcons, extractParameterProps, fadeIn, fadeInBottom, fadeInLtr, fadeInRtl, fadeInTop, fadeOutBottom, fullWidthScreenIcon, growSubtle, imageTextIcon, infoFilledIcon, input, inputError, inputSelect, isMacLike, labelText, loader as loaderAnimationData, macifyShortcut, mq, numberInput, queryStringIcon, rectangleRoundedIcon, replaceUnderscoreInString, ripple, scrollbarStyles, settings, skeletonLoading, slideInTtb, spinner as spinnerAnimationData, supports, textInput, useBreakpoint, useCloseCurrentDrawer, useCurrentDrawerRenderer, useCurrentTab, useDrawer, useIconContext, useMenuContext, useOutsideClick, useParameterShell, useShortcut, warningIcon };