@up42/up-components 0.3.5 → 0.3.8

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 export { default as tokens } from '@up42/design-system-tokens/dist/json/tokens.json';
 import * as _mui_material from '@mui/material';
-import { BoxProps as BoxProps$1, TextFieldProps, ChipProps as ChipProps$1, AvatarProps as AvatarProps$1, ContainerProps as ContainerProps$1, CheckboxProps as CheckboxProps$1, RadioProps as RadioProps$1, RadioGroupProps, SwitchProps as SwitchProps$1, SelectProps as SelectProps$1, LinkProps as LinkProps$1, TabsProps as TabsProps$1, TabProps as TabProps$1, ModalProps as ModalProps$1, AlertProps as AlertProps$1, TooltipProps as TooltipProps$1 } from '@mui/material';
+import { BoxProps as BoxProps$1, TextFieldProps, ChipProps as ChipProps$1, AvatarProps as AvatarProps$1, ContainerProps as ContainerProps$1, CheckboxProps as CheckboxProps$1, RadioProps as RadioProps$1, RadioGroupProps, SwitchProps as SwitchProps$1, SelectProps as SelectProps$1, LinkProps as LinkProps$1, TabsProps as TabsProps$1, TabProps as TabProps$1, ModalProps as ModalProps$1, CardProps, AlertProps as AlertProps$1, TooltipProps as TooltipProps$1, IconButtonProps, PopoverProps as PopoverProps$1 } from '@mui/material';
 export * from '@mui/material';
 import { ThemeProviderProps } from '@mui/material/styles/ThemeProvider';
 import React, { ReactNode, ElementType } from 'react';
@@ -296,16 +296,58 @@ declare type EmptyStateProps<C extends React.ElementType = 'div'> = BaseProps<C,
 }>;
 declare const EmptyState: <C extends React.ElementType<any>>({ icon: Icon, title, subTitle, action, ...props }: EmptyStateProps<C>) => JSX.Element;
 
-declare type ModalProps = MUIGlobalOmit<Omit<ModalProps$1, 'BackdropProps' | 'BackdropComponent' | 'onBackdropClick'>, {
+declare type ModalProps = MUIGlobalOmit<ModalProps$1>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/feedback-modal
+ */
+declare const Modal: ({ children, ...props }: ModalProps) => JSX.Element;
+
+declare type InfoCardProps = {
     title: string;
     subtitle?: string;
-    actions?: ReactNode;
+    /**
+     * The content action section aka. card footer.
+     */
+    actions?: React.ReactNode;
+    /**
+     * The content of the header action, usually an icon with a close event.
+     */
+    headerAction?: React.ReactNode;
+    /**
+     * The Card's title  typography variant.
+     */
+    titleVariant?: 'h2' | 'h3' | 'overline';
+} & Omit<CardProps, 'variant' | 'square' | 'raised'>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-infocard
+ */
+declare const InfoCard: React.ForwardRefExoticComponent<Pick<{
+    title: string;
+    subtitle?: string | undefined;
+    /**
+     * The content action section aka. card footer.
+     */
+    actions?: React.ReactNode;
+    /**
+     * The content of the header action, usually an icon with a close event.
+     */
+    headerAction?: React.ReactNode;
+    /**
+     * The Card's title  typography variant.
+     */
+    titleVariant?: "h2" | "h3" | "overline" | undefined;
+} & Omit<CardProps<"div", {}>, "variant" | "square" | "raised">, "color" | "translate" | keyof _mui_material_OverridableComponent.CommonProps | "slot" | "title" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "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" | "css" | "sx" | "key" | "elevation" | "titleVariant" | "subtitle" | "actions" | "headerAction"> & React.RefAttributes<unknown>>;
+
+declare type InfoModalProps = MUIGlobalOmit<Omit<ModalProps, 'BackdropProps' | 'BackdropComponent' | 'onBackdropClick'>, Omit<InfoCardProps, 'headerAction'> & {
+    /**
+     * Maximun width of the modal, in pixels.
+     */
     maxWidth?: number;
 }>;
 /**
- * Documentation: https://up-components.up42.dev/?path=/docs/feedback-modal
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-infomodal
  */
-declare const Modal: ({ title, subtitle, children, actions, open, maxWidth, onClose, ...props }: ModalProps) => JSX.Element;
+declare const InfoModal: ({ title, subtitle, children, actions, open, maxWidth, onClose, ...props }: InfoModalProps) => JSX.Element;
 
 declare type AlertColor = 'info' | 'error' | 'success';
 declare type AlertProps = Omit<AlertProps$1, 'color' | 'elevation' | 'iconMapping' | 'severity' | 'square' | 'variant' | 'action'> & {
@@ -350,6 +392,63 @@ declare type TooltipProps = Omit<TooltipProps$1, 'TransitionComponent' | 'Transi
  */
 declare const Tooltip: ({ children, ...props }: TooltipProps) => JSX.Element;
 
+declare type ControlButtonProps = MUIGlobalOmit<IconButtonProps, {
+    size?: 'medium' | 'small';
+    /**
+     * Remove default padding when using icons with built-in padding (Like MUI icons)
+     */
+    removePadding?: boolean;
+}>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/data-entry-controlbutton--default
+ */
+declare const ControlButton: ({ size, removePadding, children, ...props }: ControlButtonProps) => JSX.Element;
+
+declare type PopoverProps = MUIGlobalOmit<PopoverProps$1>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-display-popover
+ */
+declare const Popover: ({ children, ...props }: PopoverProps) => JSX.Element;
+
+declare type InfoPopoverProps = InfoCardProps & {
+    icon?: React.ElementType;
+};
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-popovers-infopopover
+ */
+declare const InfoPopover: ({ id, icon: Icon, actions, title, children, sx, ...props }: InfoPopoverProps) => JSX.Element;
+
+declare type DocumentationPopoverProps = {
+    heading: string;
+    /**
+     * The main content of the Popover.
+     */
+    content: string;
+    /**
+     * The label of the CTA button, usually *View Documentation*.
+     */
+    linkText?: string;
+    /**
+     * The link of the CTA button. A pathname relative to the documentation base URL.
+     * i.e: `/getting-started/workflows/catalog`
+     */
+    linkPath?: string;
+    /**
+     * Contentful entry ID.
+     */
+    contentfulId: string;
+};
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-popovers-documentationpopover
+ */
+declare const DocumentationPopover: ({ content, linkPath, linkText, heading, contentfulId, }: DocumentationPopoverProps) => JSX.Element;
+
+interface CodeBoxProps {
+    text: string;
+    label?: string;
+}
+declare const CodeBox: ({ label, text }: CodeBoxProps) => JSX.Element;
+
 declare type TableProps = MUIGlobalOmit<TableProps$1>;
 declare const Table: ({ children, ...props }: TableProps) => JSX.Element;
 declare type TableBodyProps = MUIGlobalOmit<TableBodyProps$1>;
@@ -369,4 +468,4 @@ declare const TableSortLabel: ({ children, ...props }: TableSortLabelProps) => J
 declare type TableFooterProps = MUIGlobalOmit<TableFooterProps$1>;
 declare const TableFooter: ({ children, ...props }: TableFooterProps) => JSX.Element;
 
-export { Alert, AlertProps, Avatar, AvatarProps, Banner, BannerProps, Box, BoxProps, Button, ButtonProps, Checkbox, CheckboxProps, Chip, ChipProps, Container, ContainerProps, EmptyState, EmptyStateProps, FormCheckbox, FormCheckboxProps, FormInput, FormInputProps, FormRadio, FormRadioProps, FormSelect, FormSelectProps, FormSwitch, FormSwitchProps, Input, InputProps, Link, LinkProps, Modal, ModalProps, Radio, RadioProps, Select, SelectProps, Switch, SwitchProps, Tab, TabGroup, TabGroupProps, TabProps, Table, TableBody, TableBodyProps, TableCell, TableCellProps, TableContainer, TableContainerProps, TableFooter, TableFooterProps, TableHead, TableHeadProps, TablePagination, TablePaginationProps, TableProps, TableRow, TableRowProps, TableSortLabel, TableSortLabelProps, Tabs, TabsProps, Tooltip, TooltipProps, Typography, TypographyProps, UpComponentsProvider, theme };
+export { Alert, AlertProps, Avatar, AvatarProps, Banner, BannerProps, Box, BoxProps, Button, ButtonProps, Checkbox, CheckboxProps, Chip, ChipProps, CodeBox, CodeBoxProps, Container, ContainerProps, ControlButton, ControlButtonProps, DocumentationPopover, DocumentationPopoverProps, EmptyState, EmptyStateProps, FormCheckbox, FormCheckboxProps, FormInput, FormInputProps, FormRadio, FormRadioProps, FormSelect, FormSelectProps, FormSwitch, FormSwitchProps, InfoCard, InfoCardProps, InfoModal, InfoModalProps, InfoPopover, InfoPopoverProps, Input, InputProps, Link, LinkProps, Modal, ModalProps, Popover, PopoverProps, Radio, RadioProps, Select, SelectProps, Switch, SwitchProps, Tab, TabGroup, TabGroupProps, TabProps, Table, TableBody, TableBodyProps, TableCell, TableCellProps, TableContainer, TableContainerProps, TableFooter, TableFooterProps, TableHead, TableHeadProps, TablePagination, TablePaginationProps, TableProps, TableRow, TableRowProps, TableSortLabel, TableSortLabelProps, Tabs, TabsProps, Tooltip, TooltipProps, Typography, TypographyProps, UpComponentsProvider, theme };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@up42/up-components",
-  "version": "0.3.5",
+  "version": "0.3.8",
   "description": "UP42 Component Library",
   "author": "Axel Fuhrmann axel.fuhrmann@up42.com",
   "license": "ISC",
@@ -24,7 +24,8 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@up42/design-system-tokens": "^3.0.0"
+    "@up42/design-system-tokens": "^3.0.0",
+    "react-markdown": "^8.0.3"
   },
   "devDependencies": {
     "@babel/core": "^7.16.10",