@plesk/ui-library 3.35.0 → 3.35.2

package/types/src/components/ProgressDialog/ProgressDialog.d.ts

@@ -0,0 +1,125 @@
+import { Component, ReactNode } from 'react';
+import { ImageType } from '../Dialog';
+import { ProgressProps } from '../Progress';
+import '../../helpers/base.less';
+import './ProgressDialog.less';
+export interface ProgressDialogProps {
+    /**
+     * Toggles visibility.
+     * @since 1.2.0
+     */
+    isOpen?: boolean;
+    /**
+     * Banner. Renders in front of content as wide as dialog.
+     * @since 1.2.0
+     */
+    banner?: ImageType;
+    /**
+     * Image. Renders into content.
+     * @since 1.2.0
+     */
+    image?: ImageType;
+    /**
+     * Title
+     * @since 1.2.0
+     */
+    title?: ReactNode;
+    /**
+     * Description of the `ProgressDialog`.
+     * @since 1.2.0
+     */
+    description?: ReactNode;
+    /**
+     * Actions which will be shown in Dialog header.
+     * @since 1.2.0
+     */
+    actions?: ReactNode;
+    /**
+     * Whether the dialog should be canceled with the cancel button.
+     * @since 1.2.0
+     */
+    cancelable?: boolean;
+    /**
+     * The interval of time to auto close dialog when it successfully finished.
+     * Set `null` for disable auto close.
+     * @since 1.2.0
+     */
+    autoCloseTimeout?: number | null;
+    /**
+     * On cancel event handler.
+     * @since 1.2.0
+     */
+    onCancel?: () => void;
+    /**
+     * On close event handler.
+     * @since 1.2.0
+     */
+    onClose?: () => void;
+    /**
+     * On finish event handler.
+     * @since 1.2.0
+     */
+    onFinish?: () => void;
+    /**
+     * On fail event handler.
+     * @since 1.2.0
+     */
+    onFail?: () => void;
+    /**
+     * Content of the `ProgressDialog`.
+     * @since 1.2.0
+     */
+    children?: ReactNode;
+    /**
+     * @ignore
+     */
+    className?: string;
+    /**
+     * @ignore
+     */
+    baseClassName?: string;
+}
+declare type ProgressDialogState = {
+    isOpen: boolean;
+    isFinished: boolean;
+    isFailed: boolean;
+};
+/**
+ * `ProgressDialog` is a [Dialog](#!/Dialog) combined with of [Progress](#!/Progress) component.
+ * @since 1.2.0
+ */
+declare class ProgressDialog extends Component<ProgressDialogProps, ProgressDialogState> {
+    static defaultProps: {
+        isOpen: boolean;
+        banner: null;
+        image: null;
+        title: null;
+        description: null;
+        actions: null;
+        cancelable: boolean;
+        autoCloseTimeout: number;
+        onCancel: null;
+        onClose: null;
+        onFinish: null;
+        onFail: null;
+        children: null;
+        className: null;
+        baseClassName: string;
+    };
+    static getDerivedStateFromProps({ isOpen }: ProgressDialogState): {
+        isOpen: boolean;
+    };
+    state: {
+        isOpen: boolean;
+        isFinished: boolean;
+        isFailed: boolean;
+    };
+    componentDidUpdate(_: ProgressDialogProps, prevState: ProgressDialogState): void;
+    componentWillUnmount(): void;
+    private closeTimeout;
+    clearCloseTimeout(): void;
+    handleStatusChange: ProgressProps['onStatusChange'];
+    handleClose: () => void;
+    render(): JSX.Element;
+}
+export default ProgressDialog;

package/types/src/components/ProgressDialog/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './ProgressDialog';
+export type { ProgressDialogProps } from './ProgressDialog';

package/types/src/components/ProgressStep/ProgressStep.d.ts

@@ -0,0 +1,69 @@
+import { ReactNode } from 'react';
+import { IconName, IconProps } from '../Icon';
+import '../../helpers/base.less';
+import './ProgressStep.less';
+export declare const STATUS_NOT_STARTED = "not_started";
+export declare const STATUS_RUNNING = "running";
+export declare const STATUS_DONE = "done";
+export declare const STATUS_WARNING = "warning";
+export declare const STATUS_ERROR = "error";
+export declare const STATUS_CANCELED = "canceled";
+export declare type Status = typeof STATUS_NOT_STARTED | typeof STATUS_RUNNING | typeof STATUS_DONE | typeof STATUS_ERROR | typeof STATUS_CANCELED | typeof STATUS_WARNING;
+export interface ProgressStepProps {
+    /**
+     * Title of the step
+     * @since 1.10.0
+     */
+    title?: ReactNode;
+    /**
+     * Status for the step
+     * @since 1.10.0
+     */
+    status?: Status;
+    /**
+     * Name of icon or [Icon](#!/Icon) component
+     * @ignore
+     */
+    icon?: ReactNode | IconName | IconProps;
+    /**
+     * Text description for the status of the step
+     * @since 1.10.0
+     */
+    statusText?: ReactNode;
+    /**
+     * Progress indication in numbers
+     * @since 1.10.0
+     */
+    progress?: number;
+    /**
+     * Content of the `ProgressStep`.
+     * @since 1.10.0
+     */
+    children?: ReactNode;
+    /**
+     * @ignore
+     */
+    className?: string;
+    /**
+     * @ignore
+     */
+    baseClassName?: string;
+}
+/**
+ * `ProgressStep` is a part of the [Progress](#!/Progress) component.
+ * @since 1.10.0
+ */
+declare const ProgressStep: {
+    ({ className, children, icon, title, statusText, progress, status, baseClassName, ...props }: ProgressStepProps): JSX.Element;
+    defaultProps: {
+        icon: null;
+        title: null;
+        status: string;
+        statusText: null;
+        progress: number;
+        children: null;
+        className: null;
+        baseClassName: string;
+    };
+};
+export default ProgressStep;

package/types/src/components/ProgressStep/index.d.ts

@@ -0,0 +1,2 @@
+export type { Status, ProgressStepProps } from './ProgressStep';
+export { default, STATUS_RUNNING, STATUS_DONE, STATUS_ERROR, STATUS_WARNING, STATUS_CANCELED, STATUS_NOT_STARTED, } from './ProgressStep';

package/types/src/components/Rating/Rating.d.ts

@@ -0,0 +1,27 @@
+import './Rating.less';
+export interface RatingProps {
+    /**
+     * Rating value from 0 to 5.
+     * @since 0.0.42
+     */
+    value?: number;
+    /**
+     * Small variant.
+     * @since 0.0.42
+     */
+    small?: boolean;
+    /**
+     * @ignore
+     */
+    className?: string;
+    /**
+     * @ignore
+     */
+    baseClassName?: string;
+}
+/**
+ * `Rating` component is used for showing and collecting feedback of users' opinion in 0-5 grade scale.
+ * @since 0.0.42
+ */
+declare const Rating: ({ baseClassName, className, value, small, ...props }: RatingProps) => JSX.Element;
+export default Rating;

package/types/src/components/Rating/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './Rating';
+export type { RatingProps } from './Rating';

package/types/src/components/Skeleton/Skeleton.d.ts

@@ -1,4 +1,4 @@
-import { ComponentType, FC, JSX } from 'react';
+import { ComponentType, FC, JSX, CSSProperties } from 'react';
 import './Skeleton.less';
 export declare type SkeletonProps = {
     /**
@@ -20,12 +20,10 @@ export declare type SkeletonProps = {
      */
     height?: number | string;
     /**
-     * custom styles for skeleton
+     * Custom styles for skeleton
      * @since 3.28.0
      */
-    style?: {
-        [key: string]: string;
-    };
+    style?: CSSProperties;
     /**
      * Component to render as the root element.
      * @since 3.28.0

package/types/src/components/Skeleton/SkeletonTabs.d.ts

@@ -1,6 +1,6 @@
 import { FC } from 'react';
 import './SkeletonTabs.less';
-declare type SkeletonTabsProps = {
+export interface SkeletonTabsProps {
     /**
      * Number of tabs
      * @since 3.28.0
@@ -9,12 +9,12 @@ declare type SkeletonTabsProps = {
     /**
      * @ignore
      */
-    className: string;
+    className?: string;
     /**
      * @ignore
      */
-    baseClassName: string;
-};
+    baseClassName?: string;
+}
 /**
  * Skeleton for tabs component
  * @since `3.28.0

package/types/src/components/Skeleton/SkeletonText.d.ts

@@ -1,7 +1,7 @@
 import { FC, ComponentType, JSX } from 'react';
 import { SkeletonProps } from './Skeleton';
 import './SkeletonText.less';
-declare type SkeletonTextProps = {
+export interface SkeletonTextProps {
     /**
      * Number of rows
      * @since 3.28.0
@@ -25,7 +25,7 @@ declare type SkeletonTextProps = {
      * @ignore
      */
     className?: string;
-};
+}
 /**
  * Skeleton for text-containing components. Is can be used inside Paragraph, as title, or single text
  * @since 3.28.0

package/types/src/components/Skeleton/index.d.ts

@@ -1,3 +1,6 @@
 export { default } from './Skeleton';
-export { default as SkeletonText } from './SkeletonText';
+export type { SkeletonProps } from './Skeleton';
 export { default as SkeletonTabs } from './SkeletonTabs';
+export type { SkeletonTabsProps } from './SkeletonTabs';
+export { default as SkeletonText } from './SkeletonText';
+export type { SkeletonTextProps } from './SkeletonText';

package/types/src/components/SplitButton/SplitButton.d.ts

@@ -46,8 +46,7 @@ export interface SplitButtonProps {
  * `Split Button` is a combination of a standard [Button](#!/Button) with a [Dropdown](#!/Dropdown) menu.
  * It is used for grouping several related actions when one of the actions should be accessible immediately
  * because it is used more often than others.
- *
- * Since: 0.0.40
+ * @since 0.0.40
  */
 declare const SplitButton: ({ baseClassName, className, menu, children, onClick, onKeyDown, icon, size, ...props }: SplitButtonProps) => JSX.Element;
 export default SplitButton;

package/types/src/components/Switch/Switch.d.ts

@@ -0,0 +1,58 @@
+import { ReactNode } from 'react';
+import './Switch.less';
+export interface SwitchProps {
+    /**
+     * Determine whether the `Switch` is checked.
+     * @since 0.0.42
+     */
+    checked?: boolean;
+    /**
+     * A callback function, can be executed when the checked state is changing.
+     * @since 0.0.42
+     */
+    onChange?: (checked: boolean) => void;
+    /**
+     * Tooltip for component
+     * @since 0.0.42
+     */
+    tooltip?: ReactNode;
+    /**
+     * Visual intent color to apply to component.
+     * @since 0.3.0
+     */
+    intent?: 'warning' | 'danger';
+    /**
+     * Is `Switch` disabled?
+     * @since 0.0.42
+     */
+    disabled?: boolean;
+    /**
+     * Loading indication
+     * @since 0.3.0
+     */
+    loading?: boolean;
+    /**
+     * Label of the `Switch`
+     * @since 0.0.42
+     */
+    children?: ReactNode;
+    /**
+     * @ignore
+     */
+    defaultChecked?: boolean;
+    /**
+     * @ignore
+     */
+    className?: string;
+    /**
+     * @ignore
+     */
+    baseClassName?: string;
+}
+/**
+ * `Switch` component is used for changing the state of an object or system preferences.
+ * It provides immediate results that is why it should not be used in Form.
+ * @since 0.0.42
+ */
+declare const Switch: ({ className, children, onChange, tooltip, intent, checked, defaultChecked, baseClassName, disabled, loading, ...props }: SwitchProps) => JSX.Element;
+export default Switch;

package/types/src/components/Switch/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './Switch';
+export type { SwitchProps } from './Switch';

package/types/src/components/SwitchesPanel/SwitchesPanel.d.ts

@@ -0,0 +1,24 @@
+import { ReactElement } from 'react';
+import '../../helpers/base.less';
+import './SwitchesPanel.less';
+export interface SwitchesPanelProps {
+    /**
+     * Content of the `SwitchesPanel`. Recommended to use [SwitchesPanelItem](#!/SwitchesPanelItem) components.
+     * @since 0.3.0
+     */
+    children?: ReactElement[] | ReactElement;
+    /**
+     * @ignore
+     */
+    className?: string;
+    /**
+     * @ignore
+     */
+    baseClassName?: string;
+}
+/**
+ * `SwitchesPanel` component is used for grouping several [SwitchesPanelItems](#!/SwitchesPanelItem) into one set.
+ * @since 0.3.0
+ */
+declare const SwitchesPanel: ({ baseClassName, className, children, ...props }: SwitchesPanelProps) => JSX.Element;
+export default SwitchesPanel;

package/types/src/components/SwitchesPanel/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './SwitchesPanel';
+export type { SwitchesPanelProps } from './SwitchesPanel';

package/types/src/components/SwitchesPanelItem/SwitchesPanelItem.d.ts

@@ -0,0 +1,78 @@
+import { Component, ReactNode } from 'react';
+import { SwitchProps } from '../Switch';
+import '../../helpers/base.less';
+import './SwitchesPanelItem.less';
+export interface SwitchesPanelItemProps {
+    /**
+     * A callback function, can be executed when the checked state is changing.
+     * @since 0.3.0
+     */
+    onChange: (checked: boolean) => void;
+    /**
+     * Title of the `SwitchesPanelItem`. Must be no longer than two lines.
+     * @since 0.3.0
+     */
+    title: ReactNode;
+    /**
+     * @ignore
+     */
+    defaultChecked?: boolean;
+    /**
+     * Visual intent color to apply to component.
+     * @since 0.3.0
+     */
+    intent?: 'warning' | 'danger';
+    /**
+     * `SwitchesPanelItem` description. Must be no longer than three lines.
+     * @since 0.3.0
+     */
+    description?: ReactNode;
+    /**
+     * Rich full description of the `SwitchesPanelItem`.
+     * Adds control button with question mark that shows `Popover` on click.
+     * @since 0.3.0
+     */
+    fullDescription?: ReactNode;
+    /**
+     * Props of underlying [Switch](#!/Switch) component.
+     * @since 0.5.0
+     */
+    switchProps?: SwitchProps;
+    /**
+     * Content of the control actions.
+     * Don't place here more than three buttons (with the one from 'fullDescription' property) or one link and one button.
+     * @since 0.3.0
+     */
+    children: ReactNode;
+    /**
+     * @ignore
+     */
+    className?: string;
+    /**
+     * @ignore
+     */
+    baseClassName?: string;
+}
+/**
+ * `SwitchesPanelItem` component is used for combining [Switch](#!/Switch) component with text title and description.
+ * Used in [SwitchesPanel](#!/SwitchesPanel).
+ * @since 0.3.0
+ */
+declare class SwitchesPanelItem extends Component<SwitchesPanelItemProps> {
+    static defaultProps: {
+        defaultChecked: boolean;
+        intent: null;
+        description: null;
+        fullDescription: null;
+        switchProps: {};
+        children: null;
+        className: null;
+        baseClassName: string;
+    };
+    state: {
+        checked: boolean | undefined;
+    };
+    handleChange: (checked: boolean) => void;
+    render(): JSX.Element;
+}
+export default SwitchesPanelItem;

package/types/src/components/SwitchesPanelItem/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './SwitchesPanelItem';
+export type { SwitchesPanelItemProps } from './SwitchesPanelItem';

package/types/src/components/TextArea/index.d.ts

@@ -0,0 +1 @@
+export { default } from './TextArea';

package/types/src/components/Tooltip/Tooltip.d.ts

@@ -0,0 +1,61 @@
+import { Component, CSSProperties, MouseEvent, ReactElement, ReactNode } from 'react';
+import './Tooltip.less';
+export interface TooltipProps {
+    /**
+     * Content of the tooltip
+     * @since 0.0.42
+     */
+    title: ReactNode;
+    /**
+     * Element with tooltip
+     * @since 0.0.42
+     */
+    children: ReactElement;
+    /**
+     * Show delay (ms)
+     * @since 0.0.50
+     */
+    delay?: number;
+    /**
+     * @ignore
+     */
+    style?: CSSProperties;
+    /**
+     * @ignore
+     */
+    className?: string;
+    /**
+     * @ignore
+     */
+    baseClassName?: string;
+}
+/**
+ * `Tooltip` component is used for providing information about an interface element
+ * while user hovers the pointer over the element.
+ * @since 0.0.35
+ */
+declare class Tooltip extends Component<TooltipProps> {
+    static defaultProps: {
+        delay: number;
+        style: undefined;
+        className: undefined;
+        baseClassName: string;
+    };
+    state: {
+        left: number;
+        top: number;
+        ready: boolean;
+        visible: boolean;
+    };
+    componentWillUnmount(): void;
+    private timer;
+    private tooltipRef;
+    clearTimer: () => void;
+    handleShow: () => void;
+    handleHide: () => void;
+    handleMouseEnter: () => void;
+    handleMouseMove: (e: MouseEvent) => void;
+    renderTooltip(): JSX.Element;
+    render(): JSX.Element;
+}
+export default Tooltip;

package/types/src/components/Tooltip/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './Tooltip';
+export type { TooltipProps } from './Tooltip';

package/types/src/components/Translate/Translate.d.ts

@@ -0,0 +1,56 @@
+import { ElementType, ReactNode } from 'react';
+import { PolymorphicComponentProps } from '../../utils/types';
+interface BaseTranslateProps {
+    /**
+     * A some prefix for the message key.
+     * @since 2.6.0
+     */
+    namespace?: string;
+    /**
+     * Translatable content or message key.
+     * @since 0.0.42
+     */
+    content?: string;
+    /**
+     * Message params
+     * @since 0.0.42
+     */
+    params?: {
+        [key: string]: ReactNode;
+    };
+    /**
+     * Fallback translation value.
+     * @since 0.0.47
+     */
+    fallback?: string;
+    /**
+     * A set of translation messages. If the set contains a message key, the component uses an item from the set for rendering.
+     * @ignore
+     */
+    translators?: {
+        [key: string]: ReactNode;
+    };
+    /**
+     * @ignore
+     */
+    unsafe?: boolean;
+    /**
+     * @ignore
+     */
+    children?: string;
+}
+export declare type TranslateProps<Component extends ElementType = 'span'> = {
+    /**
+     * Component to render as the root element. Useful when rendering a `Translate` as `<option>`.
+     * @since 0.0.42
+     * @type ElementType
+     * @default span
+     */
+    component?: Component;
+} & PolymorphicComponentProps<Component, BaseTranslateProps>;
+/**
+ * `Translate` component.
+ * @since 0.0.42
+ */
+declare const Translate: <Component extends ElementType<any> = "span">({ component, content, children, params, unsafe, fallback, namespace, translators, ...props }: TranslateProps<Component>) => any;
+export default Translate;

package/types/src/components/Translate/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './Translate';
+export { isLikeText } from './isLikeText';
+export type { TranslateProps } from './Translate';

package/types/src/components/Translate/isLikeText.d.ts

@@ -0,0 +1,2 @@
+import { ReactNode } from 'react';
+export declare const isLikeText: (node: ReactNode) => boolean;