@uniformdev/design-system 16.1.0 → 16.1.1-alpha.169

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/index.d.ts CHANGED
@@ -128,22 +128,26 @@ declare function IconsProvider({ children }: {
128
128
  declare type CaptionProps = {
129
129
  /** allows users to add child elements */
130
130
  children: React$1.ReactNode;
131
+ /** sets data-test-id attribute for test automation*/
132
+ testId?: string;
131
133
  };
132
134
  /**
133
135
  * Component that provides caption text to input fields
134
136
  * @example <Caption>some help text here</Caption>
135
137
  */
136
- declare const Caption: ({ children }: CaptionProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
138
+ declare const Caption: ({ children, testId }: CaptionProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
137
139
 
138
140
  declare type ErrorMessageProps = {
139
141
  /** sets the error message value */
140
142
  message?: string;
143
+ /** sets the test id for test automation (optional) */
144
+ testId?: string;
141
145
  };
142
146
  /**
143
147
  * Component that provides error messaging to input fields
144
148
  * @example <ErrorMessage>something went wrong, please try again</ErrorMessage>
145
149
  */
146
- declare const ErrorMessage: ({ message }: ErrorMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
150
+ declare const ErrorMessage: ({ message, testId }: ErrorMessageProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element | null;
147
151
 
148
152
  declare type InputProps = React$1.InputHTMLAttributes<HTMLInputElement> & {
149
153
  /** (optional) sets the label value */
@@ -156,6 +160,14 @@ declare type InputProps = React$1.InputHTMLAttributes<HTMLInputElement> & {
156
160
  showLabel?: boolean;
157
161
  /** (optional) sets and shows the the error message value */
158
162
  errorMessage?: string;
163
+ /** (optional) sets the test id for input field container for test automation*/
164
+ containerTestId?: string;
165
+ /** (optional) sets label test id */
166
+ labelTestId?: string;
167
+ /** (option) sets validation message test id for test automation */
168
+ errorTestId?: string;
169
+ /** (option) sets caption message test id for test automation */
170
+ captionTestId?: string;
159
171
  capture?: boolean | 'user' | 'environment';
160
172
  /**
161
173
  * (optional) sets an overriding classname on the container element
@@ -174,7 +186,7 @@ declare type InputProps = React$1.InputHTMLAttributes<HTMLInputElement> & {
174
186
  * Input Component
175
187
  * @example - <Input label="my label" id="some-id" name="some-name" caption="some help text" errorMessage={hasError ? 'something went wrong' : undefined} />
176
188
  */
177
- declare const Input: ({ label, icon, id, caption, showLabel, errorMessage, classNameContainer, classNameControl, classNameLabel, ...props }: InputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
189
+ declare const Input: ({ label, icon, id, caption, showLabel, errorMessage, containerTestId, labelTestId, errorTestId, captionTestId, classNameContainer, classNameControl, classNameLabel, ...props }: InputProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
178
190
 
179
191
  declare type InputComboBoxOption = {
180
192
  /** sets the label value */
@@ -328,8 +340,10 @@ declare type LabelProps = React$1.LabelHTMLAttributes<HTMLLabelElement> & {
328
340
  children: React$1.ReactNode;
329
341
  /** (optional) sets additional css properties */
330
342
  className?: SerializedStyles | string;
343
+ /** (optional) test id for test automation*/
344
+ testId?: string;
331
345
  };
332
- declare const Label: ({ children, className, ...props }: LabelProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
346
+ declare const Label: ({ children, className, testId, ...props }: LabelProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
333
347
 
334
348
  interface MenuProps extends MenuHTMLProps {
335
349
  /** sets aria-label attribute */
@@ -586,4 +600,64 @@ declare const Switch: React$1.ForwardRefExoticComponent<Omit<React$1.InputHTMLAt
586
600
  children?: React$1.ReactNode;
587
601
  } & React$1.RefAttributes<HTMLInputElement>>;
588
602
 
589
- 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 };
603
+ declare type TableProps = React$1.ComponentPropsWithoutRef<'table'>;
604
+ declare type TableHeadProps = React$1.ComponentPropsWithoutRef<'thead'>;
605
+ declare type TableBodyProps = React$1.ComponentPropsWithoutRef<'tbody'>;
606
+ declare type TableFootProps = React$1.ComponentPropsWithoutRef<'tfoot'>;
607
+ declare type TableRowProps = React$1.ComponentPropsWithoutRef<'tr'>;
608
+ declare type TableCellHeadProps = React$1.ComponentPropsWithoutRef<'th'>;
609
+ declare type TableCellDataProps = React$1.ComponentPropsWithoutRef<'td'>;
610
+ /**
611
+ * Uniform's Table component
612
+ * @example
613
+ * <Table>
614
+ <TableHead>
615
+ <TableRow>
616
+ <TableCellHead>head 1</TableCellHead>
617
+ <TableCellHead>head 2</TableCellHead>
618
+ </TableRow>
619
+ </TableHead>
620
+ <TableBody>
621
+ <TableRow>
622
+ <TableCellData>value 1</TableCellData>
623
+ <TableCellData>value 2</TableCellData>
624
+ </TableRow>
625
+ </TableBody>
626
+ <TableFoot>
627
+ <TableRow>
628
+ <TableCellData>footer</TableCellData>
629
+ </TableRow>
630
+ </TableFoot>
631
+ </Table>
632
+ */
633
+ declare const Table: React$1.ForwardRefExoticComponent<Pick<React$1.DetailedHTMLProps<React$1.TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>, "key" | keyof React$1.TableHTMLAttributes<HTMLTableElement>> & React$1.RefAttributes<HTMLTableElement>>;
634
+ declare const TableHead: React$1.ForwardRefExoticComponent<Pick<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLTableSectionElement>, HTMLTableSectionElement>, "key" | keyof React$1.HTMLAttributes<HTMLTableSectionElement>> & React$1.RefAttributes<HTMLTableSectionElement>>;
635
+ declare const TableBody: React$1.ForwardRefExoticComponent<Pick<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLTableSectionElement>, HTMLTableSectionElement>, "key" | keyof React$1.HTMLAttributes<HTMLTableSectionElement>> & React$1.RefAttributes<HTMLTableSectionElement>>;
636
+ declare const TableFoot: React$1.ForwardRefExoticComponent<Pick<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLTableSectionElement>, HTMLTableSectionElement>, "key" | keyof React$1.HTMLAttributes<HTMLTableSectionElement>> & React$1.RefAttributes<HTMLTableSectionElement>>;
637
+ declare const TableRow: React$1.ForwardRefExoticComponent<Pick<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLTableRowElement>, HTMLTableRowElement>, "key" | keyof React$1.HTMLAttributes<HTMLTableRowElement>> & React$1.RefAttributes<HTMLTableRowElement>>;
638
+ declare const TableCellHead: React$1.ForwardRefExoticComponent<Pick<React$1.DetailedHTMLProps<React$1.ThHTMLAttributes<HTMLTableHeaderCellElement>, HTMLTableHeaderCellElement>, "key" | keyof React$1.ThHTMLAttributes<HTMLTableHeaderCellElement>> & React$1.RefAttributes<HTMLTableCellElement>>;
639
+ declare const TableCellData: React$1.ForwardRefExoticComponent<Pick<React$1.DetailedHTMLProps<React$1.TdHTMLAttributes<HTMLTableDataCellElement>, HTMLTableDataCellElement>, "key" | keyof React$1.TdHTMLAttributes<HTMLTableDataCellElement>> & React$1.RefAttributes<HTMLTableCellElement>>;
640
+
641
+ declare type AddListButtonProps = React$1.ButtonHTMLAttributes<HTMLButtonElement> & {
642
+ /** (optional) - sets the button text and title value
643
+ * @default 'Add Item'
644
+ */
645
+ buttonText?: string;
646
+ /** sets the function action of the button */
647
+ onButtonClick: () => void;
648
+ /** (optional) - sets whether the button is disabled or not
649
+ * @default undefined
650
+ */
651
+ disabled?: boolean;
652
+ /** (optional) - sets the icon within the button, requires the icon provider to work
653
+ * @default 'add'
654
+ */
655
+ icon?: 'math-plus' | 'add' | 'add-r';
656
+ };
657
+ /**
658
+ * Uniform Add List Button Component
659
+ * @example <AddListButton buttonText="my text" onButtonClick={() => console.log('button clicked')} icon="add" />
660
+ */
661
+ declare const AddListButton: ({ buttonText, onButtonClick, disabled, icon, ...buttonProps }: AddListButtonProps) => _emotion_react_types_jsx_namespace.EmotionJSX.Element;
662
+
663
+ export { ActionButtonsProps, AddButton, AddButtonProps, AddListButton, AddListButtonProps, 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, Table, TableBody, TableBodyProps, TableCellData, TableCellDataProps, TableCellHead, TableCellHeadProps, TableFoot, TableFootProps, TableHead, TableHeadProps, TableProps, TableRow, TableRowProps, Textarea, TextareaProps, Theme, ThemeProps, UniformBadge, UniformLogo, UniformLogoProps, breakpointSizeProps, breakpoints, breakpointsProps, input, inputError, inputSelect, labelText, mq, scrollbarStyles, useIconContext, useMenuContext };