@pexip/components 19.1.3 → 19.3.0

package/api-docs/type-aliases/MenuItem.mdx

@@ -0,0 +1,31 @@
+```ts
+type MenuItem<T> = object;
+```
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `string` | `string` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="clickaction"></a> `clickAction?` | `React.MouseEventHandler`\<`HTMLElement`\> |
+| <a id="colorscheme"></a> `colorScheme?` | [`ColorScheme`](ColorScheme.mdx) |
+| <a id="icon"></a> `icon?` | [`IconSource`](../interfaces/IconSource.mdx) |
+| <a id="iconcolor"></a> `iconColor?` | `string` |
+| <a id="iconalignedstart"></a> `iconAlignedStart?` | `boolean` |
+| <a id="isariachecked"></a> `isAriaChecked?` | `boolean` |
+| <a id="isariaselected"></a> `isAriaSelected?` | `boolean` |
+| <a id="isdisabled"></a> `isDisabled?` | `boolean` |
+| <a id="isfixedicon"></a> `isFixedIcon?` | `boolean` |
+| <a id="label"></a> `label` | `React.ReactNode` |
+| <a id="linkwrapper"></a> `linkWrapper?` | (`{ children, }`) => `React.ReactElement` |
+| <a id="role"></a> `role?` | `React.AriaRole` |
+| <a id="target"></a> `target?` | [`LinkTarget`](LinkTarget.mdx) |
+| <a id="testid"></a> `testId?` | `string` |
+| <a id="url"></a> `url?` | `string` |
+| <a id="value"></a> `value?` | `T` |
+| <a id="variant"></a> `variant?` | [`TextVariant`](TextVariant.mdx) |

package/api-docs/type-aliases/ModalProps.mdx

@@ -0,0 +1,3 @@
+```ts
+type ModalProps = React.ComponentProps<typeof Modal>;
+```

package/api-docs/type-aliases/ModalSizeModifier.mdx

@@ -0,0 +1,3 @@
+```ts
+type ModalSizeModifier = typeof modalSizeModifiersValues[number];
+```

package/api-docs/type-aliases/MultiselectOption.mdx

@@ -0,0 +1,16 @@
+```ts
+type MultiselectOption<T> = Option<T> & object;
+```
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| `isHidden?` | `boolean` |
+| `description?` | `string` |
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `string` | `string` |

package/api-docs/type-aliases/MultistepIndicatorProps.mdx

@@ -0,0 +1,3 @@
+```ts
+type MultistepIndicatorProps = React.ComponentProps<typeof MultistepIndicator>;
+```

package/api-docs/type-aliases/NotificationToastMessage.mdx

@@ -0,0 +1,18 @@
+```ts
+type NotificationToastMessage = object;
+```
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="colorscheme"></a> `colorScheme?` | [`ColorScheme`](ColorScheme.mdx) | - |
+| <a id="enhancestart"></a> `enhanceStart?` | `React.ReactNode` | - |
+| <a id="isclickable"></a> `isClickable?` | `boolean` | - |
+| <a id="isdanger"></a> `isDanger?` | `boolean` | - |
+| <a id="isinterrupt"></a> `isInterrupt?` | `boolean` | A toast that can interrupt will jump the queue and remove the currently rendering toast and be rendered instead of it. Currently rendering toasts that have a timeout of 0 cannot be interrupted, the toast that tries to interrupt it is discarded and not queued. An example when this can be useful: if many toasts are sent rapidly in response to UI state changes; User mutes, unmute & mutes again and toasts are displayed to reflect these states, the toasts will display without a long timeout between each. |
+| <a id="message"></a> `message` | `ReactNode` | - |
+| <a id="position"></a> `position?` | [`ToastPosition`](ToastPosition.mdx) | - |
+| <a id="testid"></a> `testid?` | `string` | - |
+| <a id="timeout"></a> `timeout?` | `number` | - |
+| <a id="ondismiss"></a> `onDismiss?` | () => `void` | - |

package/api-docs/type-aliases/NotificationToastSignal.mdx

@@ -0,0 +1,3 @@
+```ts
+type NotificationToastSignal = NotificationToastMessageSignal | NotificationToastCloseSignal;
+```

package/api-docs/type-aliases/NotificationTooltipPosition.mdx

@@ -0,0 +1,13 @@
+```ts
+type NotificationTooltipPosition = 
+  | "topRight"
+  | "topCenter"
+  | "topLeft"
+  | "topStart"
+  | "topEnd"
+  | "bottomRight"
+  | "bottomCenter"
+  | "bottomLeft"
+  | "bottomStart"
+  | "bottomEnd";
+```

package/api-docs/type-aliases/Option.mdx

@@ -0,0 +1,17 @@
+```ts
+type Option<T> = object;
+```
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `string` | `string` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="id"></a> `id` | `T` |
+| <a id="isdisabled"></a> `isDisabled?` | `boolean` |
+| <a id="label"></a> `label` | `string` |

package/api-docs/type-aliases/OverlayOpacity.mdx

@@ -0,0 +1,3 @@
+```ts
+type OverlayOpacity = 0 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1;
+```

package/api-docs/type-aliases/PanelProps.mdx

@@ -0,0 +1,3 @@
+```ts
+type PanelProps = React.ComponentProps<typeof Panel>;
+```

package/api-docs/type-aliases/SelectProps.mdx

@@ -0,0 +1,29 @@
+```ts
+type SelectProps<T> = Omit<React.ComponentPropsWithRef<"select">, "disabled"> & object;
+```
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| `colorScheme?` | [`ColorScheme`](ColorScheme.mdx) |
+| `errorText?` | `string` |
+| `errorTextTestId?` | `string` |
+| `hasError?` | `boolean` |
+| `iconType?` | [`IconSource`](../interfaces/IconSource.mdx) |
+| `id?` | `string` |
+| `isDisabled?` | `boolean` |
+| `isFullWidth?` | `boolean` |
+| `label` | `string` |
+| `labelModifier?` | [`LabelModifier`](LabelModifier.mdx) |
+| `onValueChange()` | (`id`) => `void` |
+| `options` | [`Option`](Option.mdx)\<`T`\>[] |
+| `sizeModifier?` | [`SizeModifier`](SizeModifier.mdx) |
+| `value` | `string` |
+| `wrapContent?` | `boolean` |
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `string` | `string` |

package/api-docs/type-aliases/ShadowModifier.mdx

@@ -0,0 +1,3 @@
+```ts
+type ShadowModifier = typeof shadowModifierValues[number];
+```

package/api-docs/type-aliases/SimpleButtonProps.mdx

@@ -0,0 +1,3 @@
+```ts
+type SimpleButtonProps = React.ComponentProps<typeof SimpleButton>;
+```

package/api-docs/type-aliases/SizeModifier.mdx

@@ -0,0 +1,3 @@
+```ts
+type SizeModifier = typeof sizeModifiersValues[number];
+```

package/api-docs/type-aliases/StandardSizeModifier.mdx

@@ -0,0 +1,3 @@
+```ts
+type StandardSizeModifier = typeof standardSizeModifiersValues[number];
+```

package/api-docs/type-aliases/StatIndicatorVariant.mdx

@@ -0,0 +1,3 @@
+```ts
+type StatIndicatorVariant = typeof statIndicatorVariantValues[number];
+```

package/api-docs/type-aliases/StatusItem.mdx

@@ -0,0 +1,10 @@
+```ts
+type StatusItem = object;
+```
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="label"></a> `label` | `string` |
+| <a id="content"></a> `content` | `string` |

package/api-docs/type-aliases/TableResultsCountProps.mdx

@@ -0,0 +1,12 @@
+```ts
+type TableResultsCountProps = object;
+```
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="endcount"></a> `endCount` | `number` |
+| <a id="isdisabled"></a> `isDisabled?` | `boolean` |
+| <a id="startcount"></a> `startCount` | `number` |
+| <a id="totalcount"></a> `totalCount` | `number` |

package/api-docs/type-aliases/TagItem.mdx

@@ -0,0 +1,17 @@
+```ts
+type TagItem = object;
+```
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="classname"></a> `className?` | `string` | - |
+| <a id="isinteractive"></a> `isInteractive?` | `boolean` | isInteractive decides whether hover effect will be on or off |
+| <a id="istruncated"></a> `isTruncated?` | `boolean` | - |
+| <a id="label"></a> `label?` | `string` | - |
+| <a id="onclick"></a> `onClick?` | (`label?`) => `void` | - |
+| <a id="onremove"></a> `onRemove?` | () => `void` | - |
+| <a id="removelabel"></a> `removeLabel?` | `string` | - |
+| <a id="title"></a> `title?` | `string` | - |
+| <a id="variant"></a> `variant?` | [`TextVariant`](TextVariant.mdx) | - |

package/api-docs/type-aliases/TextLinkProps.mdx

@@ -0,0 +1,3 @@
+```ts
+type TextLinkProps = React.ComponentProps<typeof TextLink>;
+```

package/api-docs/type-aliases/TextProps.mdx

@@ -0,0 +1,3 @@
+```ts
+type TextProps = React.ComponentProps<typeof Text>;
+```

package/api-docs/type-aliases/TextVariant.mdx

@@ -0,0 +1,3 @@
+```ts
+type TextVariant = typeof textVariantsValues[number];
+```

package/api-docs/type-aliases/Theme.mdx

@@ -0,0 +1,3 @@
+```ts
+type Theme = typeof themeValues[number];
+```

package/api-docs/type-aliases/ToastPosition.mdx

@@ -0,0 +1,3 @@
+```ts
+type ToastPosition = typeof toastPositionValues[number];
+```

package/api-docs/type-aliases/TooltipPosition.mdx

@@ -0,0 +1,3 @@
+```ts
+type TooltipPosition = typeof TooltipPositionValue[number];
+```

package/api-docs/type-aliases/VideoWrapperSizeModifier.mdx

@@ -0,0 +1,3 @@
+```ts
+type VideoWrapperSizeModifier = typeof videoWrapperSizeModifiersValues[number];
+```

package/api-docs/type-aliases/VideoWrapperVariant.mdx

@@ -0,0 +1,3 @@
+```ts
+type VideoWrapperVariant = typeof videoWrapperVariantsValues[number];
+```

package/api-docs/variables/AboutModal.mdx

@@ -0,0 +1,3 @@
+```ts
+const AboutModal: React.FC<ModalProps & object>;
+```

package/api-docs/variables/AboutText.mdx

@@ -0,0 +1,3 @@
+```ts
+const AboutText: React.FC<object & ListProps>;
+```

package/api-docs/variables/Accordion.mdx

@@ -0,0 +1,16 @@
+```ts
+const Accordion: React.FC<{
+  buttonClassName?: string;
+  canOnlyToggleWithTitle?: boolean;
+  children: React.ReactNode;
+  className?: string;
+  colorScheme?: ColorScheme;
+  contentClassName?: string;
+  dataTestId?: string;
+  enhancerEnd?: React.ReactNode;
+  isExpanded?: boolean;
+  meta?: string | React.ReactNode;
+  onToggle?: (isOpen) => void;
+  title: string | React.ReactNode;
+}>;
+```

package/api-docs/variables/ActionsRow.mdx

@@ -0,0 +1,3 @@
+```ts
+const ActionsRow: React.FC<Omit<React.ComponentProps<"div">, "title"> & object>;
+```

package/api-docs/variables/ActivityCard.mdx

@@ -0,0 +1,11 @@
+```ts
+const ActivityCard: React.FC<{
+  actionButton: ActivityCardAction;
+  disabled?: boolean;
+  eventsItems: ActivityCardAction[];
+  eventsTitle: string;
+  statusItems: StatusItem[];
+  title: string;
+  titleEnhancerStart?: React.ReactElement;
+}>;
+```

package/api-docs/variables/Announcer.mdx

@@ -0,0 +1,12 @@
+```ts
+const Announcer: React.FC<{
+  testId?: string;
+}>;
+```
+
+Announcer component that announces messages to screen readers via aria-live region.
+This component should be placed at the top of the application.
+
+## Returns
+
+The announcer component.

package/api-docs/variables/AriaMenu.mdx

@@ -0,0 +1,5 @@
+```ts
+const AriaMenu: React.FC<AriaMenuProps>;
+```
+
+AriaMenu component represents a dropdown menu.

package/api-docs/variables/AspectRatio.mdx

@@ -0,0 +1,6 @@
+```ts
+const AspectRatio: React.FC<React.ComponentProps<"div"> & object>;
+```
+
+A wrapper that makes its children element bound to an aspect ratio.
+Default ration is 16:9, `{width: 16, height: 9}`

package/api-docs/variables/Audio.mdx

@@ -0,0 +1,3 @@
+```ts
+const Audio: React.FC<React.ComponentProps<"audio"> & object>;
+```

package/api-docs/variables/Avatar.mdx

@@ -0,0 +1,3 @@
+```ts
+const Avatar: React.FC<RoundIndicatorBaseProps & object>;
+```

package/api-docs/variables/BadgeCounter.mdx

@@ -0,0 +1,3 @@
+```ts
+const BadgeCounter: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/Bar.mdx

@@ -0,0 +1,3 @@
+```ts
+const Bar: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/Box.mdx

@@ -0,0 +1,3 @@
+```ts
+const Box: ForwardRefExoticComponent<Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object & Pick<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object, "hasFooterShadow">, "ref"> & RefAttributes<HTMLDivElement>>;
+```

package/api-docs/variables/BoxHeader.mdx

@@ -0,0 +1,3 @@
+```ts
+const BoxHeader: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/Breadcrumbs.mdx

@@ -0,0 +1,9 @@
+```ts
+const Breadcrumbs: React.FC<{
+  className?: string;
+  crumbs: BreadcrumbItem[];
+  enhancerEnd?: React.ReactNode;
+  enhancerStart?: React.ReactNode;
+  handleNavigate: (url?) => void;
+}>;
+```

package/api-docs/variables/Button.mdx

@@ -0,0 +1,3 @@
+```ts
+const Button: React.FC<SimpleButtonProps & EnhancerProps & LoadingBoxProps & Pick<ButtonTextProps, "colorScheme" | "fontVariant"> & object>;
+```

package/api-docs/variables/ButtonText.mdx

@@ -0,0 +1,3 @@
+```ts
+const ButtonText: typeof Text;
+```

package/api-docs/variables/CakeTimer.mdx

@@ -0,0 +1,3 @@
+```ts
+const CakeTimer: React.FC<React.ComponentProps<"svg"> & object>;
+```

package/api-docs/variables/CallToAction.mdx

@@ -0,0 +1,3 @@
+```ts
+const CallToAction: React.FC<InteractiveElementProps & object>;
+```

package/api-docs/variables/Captions.mdx

@@ -0,0 +1,3 @@
+```ts
+const Captions: React.FC<CaptionsProps & TextProps>;
+```

package/api-docs/variables/CardLayout.mdx

@@ -0,0 +1,10 @@
+```ts
+const CardLayout: React.FC<React.PropsWithChildren<{
+  colorScheme?: ColorScheme;
+  title: string;
+  titleHtmlTag?: HeadingElement;
+  titleEnhancerStart?: React.ReactElement;
+  subtitle?: string | React.ReactElement;
+  secondaryComponent: React.ReactElement;
+}>>;
+```

package/api-docs/variables/Cell.mdx

@@ -0,0 +1,3 @@
+```ts
+const Cell: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/CenterLayout.mdx

@@ -0,0 +1,3 @@
+```ts
+const CenterLayout: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/Checkbox.mdx

@@ -0,0 +1,3 @@
+```ts
+const Checkbox: ForwardRefExoticComponent<Omit<CheckboxProps, "ref"> & RefAttributes<HTMLInputElement>>;
+```

package/api-docs/variables/CircleCountDown.mdx

@@ -0,0 +1,7 @@
+```ts
+const CircleCountDown: React.FC<{
+  startCountFrom?: number;
+  msInterval?: number;
+  shouldStartCountDown?: boolean;
+}>;
+```

package/api-docs/variables/CollapsableContainer.mdx

@@ -0,0 +1,15 @@
+```ts
+const CollapsableContainer: React.FC<React.PropsWithChildren<{
+  isOpen: boolean;
+  badgeCount?: number;
+  openStyling?: string;
+  headerEndContent?: React.ReactElement;
+  footerContent?: React.ReactElement;
+  collapseToggleAriaLabel?: string;
+  icon: IconSource;
+  title: string;
+  testId?: string;
+  onToggle: (currentOpenState) => void;
+  scrollElementRef?: React.RefObject<HTMLDivElement>;
+}>>;
+```

package/api-docs/variables/ColorPickerPreviewButton.mdx

@@ -0,0 +1,3 @@
+```ts
+const ColorPickerPreviewButton: React.FC<Omit<React.ComponentProps<"input">, "onChange" | "type"> & object>;
+```

package/api-docs/variables/ColorPreviewButton.mdx

@@ -0,0 +1,3 @@
+```ts
+const ColorPreviewButton: React.FC<React.PropsWithChildren<ButtonProps & object>>;
+```

package/api-docs/variables/CondensedTabs.mdx

@@ -0,0 +1,3 @@
+```ts
+const CondensedTabs: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/ConfirmableMultiselect.mdx

@@ -0,0 +1,3 @@
+```ts
+const ConfirmableMultiselect: React.FC<Omit<MultiselectCoreProps, "menuComponent"> & object>;
+```

package/api-docs/variables/ConfirmationModal.mdx

@@ -0,0 +1,3 @@
+```ts
+const ConfirmationModal: React.FC<ModalProps & object>;
+```

package/api-docs/variables/ContextMenu.mdx

@@ -0,0 +1,12 @@
+```ts
+const ContextMenu: React.FC<{
+  children: React.ReactElement;
+  menu: React.ReactElement | (props) => React.ReactElement;
+}>;
+```
+
+ContextMenu will the show the "menu" component as a context menu when the
+user right clicks on the given child element.
+
+Right or left-clicking outside the child element will close the context
+menu.

package/api-docs/variables/CoreHeader.mdx

@@ -0,0 +1,3 @@
+```ts
+const CoreHeader: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/CustomTooltip.mdx

@@ -0,0 +1,3 @@
+```ts
+const CustomTooltip: React.FC<Omit<React.ComponentProps<"div">, "content"> & ControlledTooltip & object>;
+```

package/api-docs/variables/Details.mdx

@@ -0,0 +1,3 @@
+```ts
+const Details: React.FC<Omit<React.ComponentProps<typeof Summary>, "content" | "isOpen" | "onToggle"> & object>;
+```

package/api-docs/variables/Divider.mdx

@@ -0,0 +1,3 @@
+```ts
+const Divider: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/DragAndDrop.mdx

@@ -0,0 +1,10 @@
+```ts
+const DragAndDrop: React.FC<React.PropsWithChildren<{
+  className?: string;
+  colorScheme: ColorScheme;
+  isDisabled?: boolean;
+  hasError?: boolean;
+  onDrop?: (e, files?, items?) => void;
+  onDragOver?: (e) => void;
+}>>;
+```

package/api-docs/variables/DragAndUploadFiles.mdx

@@ -0,0 +1,3 @@
+```ts
+const DragAndUploadFiles: ForwardRefExoticComponent<object & RefAttributes<HTMLInputElement>>;
+```

package/api-docs/variables/Draggable.mdx

@@ -0,0 +1,3 @@
+```ts
+const Draggable: ForwardRefExoticComponent<Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object, "ref"> & RefAttributes<HTMLDivElement>>;
+```

package/api-docs/variables/DropContent.mdx

@@ -0,0 +1,3 @@
+```ts
+const DropContent: React.FC<Omit<React.ComponentProps<"button">, "children" | "content"> & object>;
+```

package/api-docs/variables/Enhancers.mdx

@@ -0,0 +1,3 @@
+```ts
+const Enhancers: React.FC<React.PropsWithChildren<EnhancerProps>>;
+```

package/api-docs/variables/ExpanderCell.mdx

@@ -0,0 +1,3 @@
+```ts
+const ExpanderCell: React.FC<InteractiveElementProps & object>;
+```

package/api-docs/variables/FileUpload.mdx

@@ -0,0 +1,3 @@
+```ts
+const FileUpload: ForwardRefExoticComponent<object & RefAttributes<HTMLInputElement>>;
+```

package/api-docs/variables/Form.mdx

@@ -0,0 +1,3 @@
+```ts
+const Form: React.FC<React.ComponentProps<"form">>;
+```

package/api-docs/variables/FullSizeWindow.mdx

@@ -0,0 +1,5 @@
+```ts
+const FullSizeWindow: ForwardRefExoticComponent<
+  | Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & FullSizeWindowCommonProps & FullSizeWindowColorBackgroundProps, "ref">
+| Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & FullSizeWindowCommonProps & FullSizeWindowImageBackgroundProps, "ref"> & RefAttributes<HTMLDivElement>>;
+```

package/api-docs/variables/FullscreenLayout.mdx

@@ -0,0 +1,3 @@
+```ts
+const FullscreenLayout: React.FC<React.PropsWithChildren>;
+```

package/api-docs/variables/FullscreenOverlay.mdx

@@ -0,0 +1,3 @@
+```ts
+const FullscreenOverlay: React.FC<React.PropsWithChildren>;
+```

package/api-docs/variables/FullscreenSpinner.mdx

@@ -0,0 +1,3 @@
+```ts
+const FullscreenSpinner: React.FC;
+```

package/api-docs/variables/Grid.mdx

@@ -0,0 +1,3 @@
+```ts
+const Grid: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/Group.mdx

@@ -0,0 +1,3 @@
+```ts
+const Group: React.FC<React.ComponentProps<"div"> & object>;
+```

package/api-docs/variables/Heading.mdx

@@ -0,0 +1,11 @@
+```ts
+const Heading: React.FC<{
+  className?: string;
+  padding?: BaseSizeModifier;
+  subtitle?: string;
+  title: string;
+  titleFontVariant?: HeadingFontVariant;
+  titleHtmlTag?: HeadingElement;
+  colorScheme?: ColorScheme;
+}>;
+```

package/api-docs/variables/HotKey.mdx

@@ -0,0 +1,6 @@
+```ts
+const HotKey: React.FC<{
+  label: string;
+  keyCap: string;
+}>;
+```