@kentico/xperience-admin-components 23.0.9 → 24.0.1

package/dist/entry.d.ts

@@ -149,60 +149,7 @@ export declare enum ApplicationTileState {
 export declare interface AssetTileActionProps extends Omit<ButtonProps, 'type' | 'size'> {
 }
 
-declare interface AssetTileBaseProps {
-    /**
-     * Tile width and height.
-     */
-    readonly dimensions?: {
-        readonly width: number;
-        readonly height: number;
-    };
-    /**
-     * AssetTile image size (required).
-     */
-    readonly size: number;
-    /**
-     * AssetTile image name (required).
-     */
-    readonly name: string;
-    /**
-     * AssetTile image url.
-     */
-    readonly url?: string;
-    /**
-     * Error state when uploading file.
-     */
-    readonly errorState?: {
-        /**
-         * Error message tooltip location (if the error message is longer than tile).
-         */
-        readonly tooltipPlacement?: TooltipPlacement;
-        /**
-         * Explains why the error occurred.
-         */
-        readonly errorMessage: string;
-        /**
-         * Function to close AssetTile with error.
-         */
-        readonly onErrorClose: () => void;
-    };
-    /**
-     * Indicates uploading a file.
-     */
-    readonly uploadState?: {
-        /**
-         * Indicates the percentage of loading progress.
-         */
-        readonly uploadProgress?: number;
-        /**
-         * Function to close uploading AssetTile.
-         */
-        readonly onUploadCancel?: () => void;
-    };
-    /***
-     * Disabled Asset tile. Tile is not clickable, it has disabled styles (required).
-     */
-    readonly disabled: boolean;
+declare interface AssetTileBaseProps extends Omit<BaseTileBaseProps, 'type'> {
 }
 
 /**
@@ -263,7 +210,7 @@ export declare interface AssetTileSelectableProps extends AssetTileBaseProps, Pi
  */
 export declare const AssetTileSkeleton: React_2.ForwardRefExoticComponent<React_2.RefAttributes<HTMLDivElement>>;
 
-declare enum AssetTileType {
+export declare enum AssetTileType {
     /**
      * Specifies the AssetTile type (Skeleton, Preview, Selectable).
      */
@@ -353,14 +300,20 @@ declare interface BaseButtonProps extends UITestProps {
     readonly destructive?: boolean;
     readonly inProgress?: boolean;
     readonly disabled?: boolean;
+    readonly borderless?: boolean;
     readonly tabIndex?: number;
     readonly dragHandleProps?: DraggableProvidedDragHandleProps;
+    readonly className?: string;
 }
 
 declare interface BaseNotificationBarProps extends UITestProps {
     readonly type: NotificationBarType;
     readonly children: string;
     readonly onDismiss?: () => void;
+    /**
+     * Dangerously sets notification content as inner HTML.
+     */
+    readonly childrenAsHtml?: boolean;
 }
 
 declare interface BaseSimpleStatusProps {
@@ -369,6 +322,144 @@ declare interface BaseSimpleStatusProps {
     readonly labelColor?: Colors;
     readonly iconColor?: Colors;
     readonly content: Content;
+    readonly size?: SimpleStatusSize;
+}
+
+/**
+ * Action button props.
+ */
+declare interface BaseTileActionProps extends Omit<ButtonProps, 'type' | 'size'> {
+}
+
+/**
+ * Base props that should be available in all tile types and info bar, toolbar, image preview
+ */
+declare interface BaseTileBaseProps {
+    /**
+     * Tile image name (required).
+     */
+    readonly name: string;
+    /**
+     * Tile image url.
+     */
+    readonly url?: string;
+    /**
+     * Error state when uploading file.
+     */
+    readonly errorState?: {
+        /**
+         * Error message tooltip location (if the error message is longer than tile).
+         */
+        readonly tooltipPlacement?: TooltipPlacement;
+        /**
+         * Explains why the error occurred.
+         */
+        readonly errorMessage: string;
+        /**
+         * Function to close tile with error.
+         */
+        readonly onErrorClose: () => void;
+    };
+    /**
+     * Indicates uploading a file.
+     */
+    readonly uploadState?: {
+        /**
+         * Indicates the percentage of loading progress.
+         */
+        readonly uploadProgress?: number;
+        /**
+         * Function to close uploading tile.
+         */
+        readonly onUploadCancel?: () => void;
+    };
+    /***
+     * Disabled tile. Tile is not clickable, it has disabled styles (required).
+     */
+    readonly disabled: boolean;
+    /**
+     * Tile width and height.
+     */
+    readonly dimensions?: {
+        readonly width: number;
+        readonly height: number;
+    };
+    /**
+     * AssetTile image size.
+     */
+    readonly size?: number;
+}
+
+declare enum BaseTilePreviewIconSize {
+    XXL = "XXL",
+    L = "L"
+}
+
+declare interface BaseTileProps extends BaseTileBaseProps, UITestProps {
+    /**
+     * Tile width and height.
+     */
+    readonly dimensions?: {
+        readonly width: number;
+        readonly height: number;
+    };
+    /**
+     * Specifies the tile type: Skeleton, Preview, Selectable (required).
+     */
+    readonly type: BaseTileType;
+    /**
+     * Function called when checkbox is clicked.
+     */
+    readonly onChange?: (isSelected: boolean) => void;
+    /**
+     * Function called when tile is clicked.
+     */
+    readonly onClick?: () => void;
+    /**
+     * Specifies if checkbox in tile info bar is visible.
+     */
+    readonly isCheckboxVisible?: boolean;
+    /**
+     *  Specifies if checkbox in tile info bar is checked.
+     */
+    readonly isSelected?: boolean;
+    /**
+     *  Specifies if tile is dragging.
+     */
+    readonly isDragging?: boolean;
+    /**
+     * Actions button in tile tool bar.
+     */
+    readonly actions?: Array<BaseTileActionProps>;
+    /**
+     * Tile image size.
+     */
+    readonly size?: number;
+    /**
+     * Tile node ahead of name.
+     */
+    readonly nameLeadingNode?: React.ReactNode;
+    /**
+     * Tile content type.
+     */
+    readonly contentType?: string;
+    /**
+     * Size of tile preview icon.
+     */
+    readonly previewIconSize?: BaseTilePreviewIconSize;
+    /**
+     * Tile icon in preview.
+     */
+    readonly previewIcon?: IconName;
+}
+
+declare enum BaseTileType {
+    /**
+     * Specifies the BaseTile type (Skeleton, Preview, Selectable).
+     */
+    Preview = "Preview",
+    Selectable = "Selectable",
+    Skeleton = "Skeleton"
 }
 
 declare interface BaseTreeNodeProps {
@@ -477,10 +568,30 @@ export declare interface BreadcrumbsProps {
 export declare const BrowseButton: React_2.ForwardRefExoticComponent<BrowseButtonProps & React_2.RefAttributes<HTMLButtonElement>>;
 
 export declare interface BrowseButtonProps {
+    /**
+     * File types which file input should accept.
+     */
     readonly accept?: string;
+    /**
+     * Indicates if the browse button is disabled. Defaults to `false`.
+     */
     readonly disabled?: boolean;
+    /**
+     * Text displayed in button label.
+     */
     readonly label: string;
+    /**
+     * The tooltip message displayed when the browse button is disabled.
+     */
     readonly inactiveMessage?: string;
+    /**
+     * Indicates if the file input allows multiple files to be uploaded. Defaults to `true`.
+     */
+    readonly allowMultipleFiles?: boolean;
+    /**
+     * Event handler fired when file is being uploaded.
+     * @param files list of uploaded files.
+     */
     readonly onUpload: (files: FileList) => void;
 }
 
@@ -542,6 +653,10 @@ export declare interface CardProps extends UITestProps {
     readonly children: React.ReactNode;
     readonly footer?: React.ReactNode;
     readonly headline?: string;
+    /**
+     * Indicates if the card should fill full height of the parent.
+     */
+    readonly fullHeight?: boolean;
 }
 
 declare type CategoryId = string;
@@ -553,6 +668,12 @@ export declare enum CellType {
     NamedComponent = "namedComponent"
 }
 
+export declare const ChartLicense: ({ children }: ChartLicenseProps) => JSX.Element;
+
+declare interface ChartLicenseProps {
+    readonly children: React_2.ReactNode;
+}
+
 export declare const Checkbox: React_2.ForwardRefExoticComponent<CheckboxProps & React_2.RefAttributes<HTMLDivElement>>;
 
 declare type CheckboxBaseProps = Pick<React.InputHTMLAttributes<HTMLInputElement>, 'name' | 'onClick' | 'disabled' | 'tabIndex'>;
@@ -672,6 +793,7 @@ export declare enum Colors {
     BackgroundSelected = "var(--color-background-selected)",
     BackgroundSelectedHover = "var(--color-background-selected-hover)",
     BackgroundSideMenu = "var(--color-background-side-menu)",
+    BackgroundButtonOnDarkHover = "var(--color-background-button-on-dark-hover)",
     BackgroundTagDefault = "var(--color-background-tag-default)",
     BackgroundTagGrey = "var(--color-background-tag-grey)",
     BackgroundTagKenticoOrange = "var(--color-background-tag-kentico-orange)",
@@ -893,6 +1015,67 @@ declare type Content = {
     readonly tooltipAppendTo?: Element;
 };
 
+/**
+ * Props specific for content item tile.
+ */
+declare interface ContentItemTileExtendedProps {
+    /**
+     * Tile node ahead of name.
+     */
+    readonly nameLeadingNode?: React.ReactNode;
+    /**
+     * Tile content type.
+     */
+    readonly contentType: string;
+    /**
+     * Tile icon in preview.
+     */
+    readonly previewIcon?: IconName;
+}
+
+/**
+ * Component for displaying ContentItemTile Preview type.
+ */
+export declare const ContentItemTilePreview: React_2.ForwardRefExoticComponent<ContentItemTilePreviewProps & React_2.RefAttributes<HTMLDivElement>>;
+
+/**
+ * Selected props from ContentItemTileProps for Preview tile.
+ */
+declare interface ContentItemTilePreviewProps extends ContentItemTileExtendedProps, BaseTileBaseProps, Pick<ContentItemTileProps, 'onClick' | 'isSelected' | 'onChange' | 'isCheckboxVisible' | 'actions' | 'dataTestId'> {
+}
+
+declare interface ContentItemTileProps extends ContentItemTileExtendedProps, Pick<BaseTileProps, 'errorState' | 'url' | 'uploadState' | 'name' | 'disabled' | 'isCheckboxVisible' | 'isSelected' | 'isDragging' | 'onChange' | 'onClick' | 'dataTestId' | 'actions'> {
+    /**
+     * Type of content item.
+     */
+    readonly type: ContentItemTileType;
+}
+
+/**
+ * Component for displaying ContentItemTile Selectable type.
+ */
+export declare const ContentItemTileSelectable: React_2.ForwardRefExoticComponent<ContentItemTileSelectableProps & React_2.RefAttributes<HTMLDivElement>>;
+
+/**
+ * Selected props from ContentItemTileProps for Selectable tile.
+ */
+declare interface ContentItemTileSelectableProps extends ContentItemTileExtendedProps, BaseTileBaseProps, Pick<ContentItemTileProps, 'onClick' | 'isSelected' | 'onChange' | 'isDragging' | 'dataTestId'> {
+}
+
+/**
+ * Component for displaying ContentItemTile Skeleton type.
+ */
+export declare const ContentItemTileSkeleton: React_2.ForwardRefExoticComponent<React_2.RefAttributes<HTMLDivElement>>;
+
+declare enum ContentItemTileType {
+    /**
+     * Specifies the ContentItemTile type (Skeleton, Preview, Selectable).
+     */
+    Preview = "Preview",
+    Selectable = "Selectable",
+    Skeleton = "Skeleton"
+}
+
 export declare function createSelectGroup<Group>(): React_2.FC<SelectGroupProps<Group>>;
 
 export declare const DateTimePicker: React_2.ForwardRefExoticComponent<DateTimePickerProps & React_2.RefAttributes<HTMLDivElement>>;
@@ -952,6 +1135,8 @@ export declare const dialogConfig: {
     dialogContainerId: string;
 };
 
+export declare const dialogContentClass = "dialog_content";
+
 declare interface DialogContentProps extends DialogFooterProps {
     /**
      * Modal's headline.
@@ -1004,10 +1189,6 @@ declare interface DialogFooterProps {
      * Placeholder for the notification bar.
      */
     readonly notificationBar?: React.ReactNode;
-    /**
-     * Boolean that determines if the cancel button will be focused on dialog open.
-     */
-    readonly autofocusCancel?: boolean;
 }
 
 export declare interface DialogProps extends DialogContentProps, UITestProps {
@@ -1066,9 +1247,7 @@ export declare interface DialogProps extends DialogContentProps, UITestProps {
 }
 
 export declare enum Dimensions {
-    GridUnit = "8px",
-    SelectableAssetTileMaxWidth = "218px",
-    PreviewAssetTileMaxWidth = "323px"
+    GridUnit = "8px"
 }
 
 declare type DivBaseProps = Pick<React.HTMLProps<HTMLDivElement>, 'children'>;
@@ -1185,12 +1364,64 @@ export declare enum DropPlacement {
 export declare const Dropzone: React_2.ForwardRefExoticComponent<DropzoneProps & React_2.RefAttributes<HTMLDivElement>>;
 
 export declare interface DropzoneProps {
+    /**
+     * Callback method called when files are selected.
+     */
     readonly onUpload: (files: FileList) => void;
+    /**
+     * Callback method for when an item is dragged over the dropzone.
+     */
     readonly onActiveChange: (isActive: boolean) => void;
+    /**
+     * Callback method for checking current data transfer.
+     * If null, everything is permitted.
+     * If true, drag will be permitted. Otherwise false.
+     */
+    readonly onCurrentTransfer?: (dataTransfer: DataTransfer) => boolean;
+    /**
+     * If true, the dropzone is disabled.
+     */
     readonly disabled?: boolean;
+    /**
+     * Children of the node
+     */
     readonly children: React.ReactNode;
 }
 
+/**
+ * The component wraps HTML file input and allows to open file selection dialog and handle uploaded files programmatically. The inner file input is hidden by CSS.
+ */
+export declare const FileInput: {
+    ({ isOpen, accept, allowMultiple, dataTestId, onFileChange, onClose }: FileInputProps): JSX.Element;
+    displayName: string;
+};
+
+export declare interface FileInputProps extends UITestProps {
+    /**
+     * Indicates if the file dialog should be opened.
+     */
+    readonly isOpen: boolean;
+    /**
+     * Indicates if the file input allows multiple files to be uploaded. Defaults to `true`.
+     */
+    readonly allowMultiple: boolean;
+    /**
+     * File types which file input should accept.
+     */
+    readonly accept?: string;
+    /**
+     * Callback called when the file dialog closes.
+     */
+    readonly onClose: () => void;
+    /**
+     * Event handler fired when files are selected.
+     * @param files list of selected files.
+     */
+    readonly onFileChange: (files: FileList) => void;
+}
+
+export declare function forceClickOutside(e?: MouseEvent): void;
+
 export declare const FormItemWrapper: React_2.ForwardRefExoticComponent<FormItemWrapperProps & React_2.RefAttributes<HTMLDivElement>>;
 
 declare interface FormItemWrapperProps extends UITestProps {
@@ -1231,6 +1462,46 @@ declare interface FroalaEditorConfigurator {
     readonly enableButton: (buttonName: string, buttonTitle?: string) => void;
 }
 
+export declare const FunnelChart: React_2.ForwardRefExoticComponent<FunnelChartProps & React_2.RefAttributes<HTMLDivElement>>;
+
+export declare interface FunnelChartData {
+    /**
+     * Stage of the funnel to be displayed in its label.
+     */
+    readonly stage: string;
+    /**
+     * Number to be visualized for particular stage.
+     */
+    readonly interactions: number;
+}
+
+export declare interface FunnelChartProps extends UITestProps {
+    /**
+     * Data to be displayed in the chart.
+     */
+    readonly data: FunnelChartData[];
+    /**
+     * ID unique for a chart displayed on the page.
+     */
+    readonly chartId: string;
+    /**
+     * Orientation of the funnel.
+     */
+    readonly orientation: FunnelOrientation;
+    /**
+     * Locale which to use for displaying numbers, e.g. 'en_US'.
+     */
+    readonly locale: string;
+}
+
+/**
+ * Enum selecting the orientation of funnel chart.
+ */
+export declare enum FunnelOrientation {
+    Horizontal = "horizontal",
+    Vertical = "vertical"
+}
+
 declare interface GeneratedIconProps {
 }
 
@@ -1274,6 +1545,12 @@ export declare interface GridProps extends LayoutComponentProps, UITestProps {
 export declare interface HeaderCloseButton extends Pick<TooltipProps, 'tooltipText' | 'shortcuts'> {
 }
 
+export declare enum HeaderSelection {
+    None = "None",
+    Some = "Some",
+    All = "All"
+}
+
 export declare const Headline: React_2.ForwardRefExoticComponent<HeadlineProps & React_2.RefAttributes<HTMLDivElement>>;
 
 export declare interface HeadlineProps extends Pick<BoxProps, 'spacingTop' | 'spacingBottom' | 'spacingY'> {
@@ -1480,6 +1757,7 @@ export declare const KXIcons: {
     'xp-binder': ForwardRefExoticComponent<GeneratedIconProps & RefAttributes<SVGSVGElement>>;
     'xp-book-opened': ForwardRefExoticComponent<GeneratedIconProps & RefAttributes<SVGSVGElement>>;
     'xp-box-cart': ForwardRefExoticComponent<GeneratedIconProps & RefAttributes<SVGSVGElement>>;
+    'xp-box-cogwheel': ForwardRefExoticComponent<GeneratedIconProps & RefAttributes<SVGSVGElement>>;
     'xp-box': ForwardRefExoticComponent<GeneratedIconProps & RefAttributes<SVGSVGElement>>;
     'xp-boxes': ForwardRefExoticComponent<GeneratedIconProps & RefAttributes<SVGSVGElement>>;
     'xp-braces-octothorpe': ForwardRefExoticComponent<GeneratedIconProps & RefAttributes<SVGSVGElement>>;
@@ -1975,12 +2253,19 @@ declare type NativeInputProps = Pick<React.InputHTMLAttributes<HTMLInputElement>
 
 export declare const NotificationBarAlert: ForwardRefExoticComponent<NotificationBarAlertProps & RefAttributes<HTMLDivElement>>;
 
-export declare interface NotificationBarAlertProps extends Pick<BaseNotificationBarProps, 'children' | 'dataTestId'> {
+export declare interface NotificationBarAlertProps extends Pick<BaseNotificationBarProps, 'children' | 'childrenAsHtml' | 'dataTestId'> {
     readonly onDismiss: () => void;
 }
 
+export declare const NotificationBarInfo: ForwardRefExoticComponent<NotificationBarInfoProps & RefAttributes<HTMLDivElement>>;
+
+export declare interface NotificationBarInfoProps extends Pick<BaseNotificationBarProps, 'children' | 'childrenAsHtml' | 'dataTestId'> {
+    readonly onDismiss?: () => void;
+}
+
 declare enum NotificationBarType {
-    Alert = "alert"
+    Alert = "alert",
+    Info = "info"
 }
 
 export declare const OptionalTooltip: {
@@ -2410,12 +2695,34 @@ export declare interface SideMenuProps extends UITestProps {
 export declare const SidePanel: React_2.ForwardRefExoticComponent<SidePanelProps & React_2.RefAttributes<HTMLDivElement>>;
 
 declare interface SidePanelContextType {
+    /**
+     * Gets the current side panel id.
+     */
     readonly getCurrentSidePanel: () => string | null;
+    /**
+     * Adds the side panel under the sidePanelId.
+     */
     readonly addSidePanel: (sidePanelId: string, ref: RefObject<HTMLDivElement>) => void;
+    /**
+     * Removes the side panel from the provider.
+     */
     readonly removeSidePanel: (sidePanelId: string) => void;
+    /**
+     * Gets the level of nesting of the sidePanelId panel.
+     */
     readonly getSidePanelLevel: (sidePanelId: string) => number;
+    /**
+     * Gets the current side panel level of nesting.
+     */
     readonly getOpenedSidePanelLevel: () => number;
+    /**
+     * Gets the side panel offset of the sidePanelId.
+     */
     readonly getSidePanelOffset: (sidePanelId: string) => number;
+    /**
+     * Gets the current side panel ref.
+     */
+    readonly getCurrentSidePanelRef: () => RefObject<HTMLDivElement> | null;
 }
 
 export declare interface SidePanelProps extends UITestProps {
@@ -2497,6 +2804,11 @@ export declare interface SimpleStatusErrorProps extends Omit<BaseSimpleStatusPro
     };
 }
 
+export declare enum SimpleStatusSize {
+    S = "S",
+    XS = "XS"
+}
+
 export declare const SimpleStatusSuccess: React_2.ForwardRefExoticComponent<SimpleStatusSuccessProps & React_2.RefAttributes<HTMLDivElement>>;
 
 export declare interface SimpleStatusSuccessProps extends Omit<BaseSimpleStatusProps, 'type' | 'labelColor' | 'iconColor'> {
@@ -2718,6 +3030,18 @@ export declare interface TableColumn {
     searchable: boolean;
 }
 
+export declare const TableHeader: React_2.ForwardRefExoticComponent<TableHeaderProps & React_2.RefAttributes<HTMLDivElement>>;
+
+export declare interface TableHeaderProps extends UITestProps {
+    readonly columns: TableColumn[];
+    readonly selectable?: boolean;
+    readonly selection?: HeaderSelection;
+    readonly sortModel?: SortModel;
+    readonly selectLabel?: string;
+    readonly onSortChange?: (sort: SortModel) => void;
+    readonly onSelectAll?: (selected: boolean) => void;
+}
+
 export declare interface TableProps extends UITestProps {
     readonly columns: TableColumn[];
     readonly rows: TableRow[] | undefined;
@@ -2740,10 +3064,20 @@ export declare interface TableRow {
 }
 
 export declare const TableRowComponent: {
-    ({ cells, columns, disabled, selectable, selected, skeleton, selectLabel, maxVisibleRowActions, inactiveMessage, dataTestId, onRowSelect: onSelect, onRowClick }: TableRowProps): JSX.Element;
+    ({ cells, columns, disabled, selectable, selected, skeleton, selectLabel, maxVisibleRowActions, inactiveMessage, dataTestId, elevation, onRowSelect: onSelect, onRowClick }: TableRowProps): JSX.Element;
     displayName: string;
 };
 
+/**
+ * Elevation for the table row.
+ */
+export declare enum TableRowElevation {
+    XS = "XS",
+    S = "S",
+    M = "M",
+    L = "L"
+}
+
 /**
  * Represents properties of the TableRow component.
  */
@@ -2784,6 +3118,10 @@ declare interface TableRowProps extends UITestProps {
      * Tooltip message displayed on disabled row.
      */
     readonly inactiveMessage?: string;
+    /**
+     * Elevation of the table row.
+     */
+    readonly elevation?: TableRowElevation;
     /**
      * Callback when selectable row is selected.
      */
@@ -2818,6 +3156,7 @@ export declare interface TagProps {
     readonly isDragging?: boolean;
     readonly leadingButton?: React_2.ReactElement<HTMLButtonElement>;
     readonly mode?: TagMode;
+    readonly dataTestId?: string;
     readonly dataTestIdTagButton?: string;
     readonly dataTestIdRemoveButton?: string;
 }
@@ -3285,7 +3624,7 @@ export declare enum UploadTileSize {
     Compact = "Compact"
 }
 
-export declare const useHandleClickOutside: (ref: React.RefObject<HTMLElement>, onClickOutside: (event: MouseEvent) => void) => void;
+export declare const useHandleClickOutside: (ref: React.RefObject<HTMLElement>, onClickOutside: (event: Event) => void) => void;
 
 export declare const useMediaBreakpoints: () => {
     mobile: boolean;
@@ -3366,9 +3705,9 @@ export declare enum Zindex {
     DropDown = "100",
     Statusbar = "1000",
     StickyHeader = "200",
-    Sidepanel = "4000",
-    AppMenu = "2000",
-    Dialog = "3000",
+    Sidepanel = "3000",
+    AppMenu = "4000",
+    Dialog = "2000",
     Snackbar = "6000",
     Tooltip = "5000",
     Prompt = "10000"