@kentico/xperience-admin-base 29.2.2 → 29.3.0

package/dist/entry.d.ts

@@ -7,6 +7,61 @@ import { default as React_2 } from 'react';
 import { RefObject } from 'react';
 import { RegisterCommandParameters } from 'froala-editor';
 
+declare interface Action {
+    /**
+     * Type of the action.
+     */
+    readonly type: ActionType;
+    /**
+     * Action parameter.
+     */
+    readonly parameter: string;
+    /**
+     * Display name of the action.
+     */
+    readonly label: string;
+    /**
+     * Icon of the action.
+     */
+    readonly icon?: IconName;
+    /**
+     * Indicates whether action is disabled.
+     */
+    readonly disabled: boolean;
+    /**
+     * Gets or sets the tooltip of a button.
+     */
+    readonly title?: string;
+    /**
+     * Indicates whether action is destructive.
+     */
+    readonly destructive: boolean;
+    /**
+     * Gets or sets the confirmation dialog configuration.
+     */
+    readonly confirmationDialog?: ConfirmationConfiguration;
+    /**
+     * Identifier of the action.
+     */
+    readonly identifier: string;
+    /**
+     * Fires on click handler.
+     */
+    readonly onClick?: () => Promise<void>;
+    /**
+     * Link parameters.
+     */
+    readonly linkParameters?: LinkParameters;
+    /**
+     * Action button color.
+     */
+    readonly buttonColor: ButtonColor.Primary | ButtonColor.Secondary;
+    /**
+     * Component properties to be used for the action.
+     */
+    readonly componentProperties?: ActionComponentProps;
+}
+
 /**
  * Configuration representing props of the component.
  */
@@ -27,6 +82,32 @@ export declare interface ActionComponentProps {
      * Notifies that the action has been executed.
      */
     readonly onActionExecuted: () => void;
+    /**
+     * Rest of action data.
+     */
+    readonly action?: Omit<Action, 'componentProperties'>;
+}
+
+/**
+ * Type of an action.
+ */
+declare enum ActionType {
+    /**
+     * Action which redirects to a link.
+     */
+    Link = "link",
+    /**
+     * Action which executes a page command.
+     */
+    Command = "command",
+    /**
+     * Action which executes onClick function.
+     */
+    Client = "client",
+    /**
+     * Action which renders a custom component.
+     */
+    CustomComponent = "customComponent"
 }
 
 /**
@@ -127,6 +208,48 @@ declare interface CommandContextType {
  */
 export declare type CommandExecutor<TData, TResponse> = (data?: TData, files?: FileList, abortController?: AbortController) => Promise<TResponse>;
 
+declare interface ComponentContent {
+    /**
+     * Name of the rendered component.
+     */
+    readonly componentName: string;
+    /**
+     * Configuration representing props of the component.
+     */
+    readonly componentConfiguration: object;
+}
+
+declare interface ConfirmationConfiguration {
+    /**
+     * Confirmation title shown in prompt dialog.
+     */
+    readonly title?: string;
+    /**
+     * Confirmation text shown in prompt dialog.
+     */
+    readonly detail?: string | null;
+    /**
+     * Confirmation content shown in prompt dialog.
+     */
+    readonly content?: ComponentContent;
+    /**
+     * Text of the confirmation button on the prompt dialog.
+     */
+    readonly button: string;
+    /**
+     * Form items representing confirmation form.
+     */
+    readonly formItems?: FormItems;
+    /**
+     * Indicates whether the confirmation button of the dialog is shown as destructive.
+     */
+    readonly destructive?: boolean;
+    /**
+     * Represents a customized form name for the dialog.
+     */
+    readonly formName?: string;
+}
+
 declare interface DialogAction extends Omit<DialogFooterActionProps, 'color'> {}
 
 declare interface DialogFooterActionProps
@@ -156,6 +279,14 @@ export declare interface FieldInfo {
  */
 export declare type FieldInfoValueType = Record<string, any>;
 
+declare interface FormCategoryProps {
+    readonly title: string;
+    readonly collapsible?: boolean;
+    readonly isCollapsed?: boolean;
+    readonly tooltip?: string;
+    readonly componentName: string;
+}
+
 /**
  * Represents basic set of form component properties.
  */
@@ -187,6 +318,11 @@ export declare interface FormComponentProps extends FieldInfo {
     readonly explanationTextAsHtml?: boolean;
 }
 
+/**
+ * Array of form components and their categories.
+ */
+declare type FormItems = Array<FormComponentProps | FormCategoryProps>;
+
 /** Configurator enables custom Froala Typescript plugins to use global Froala configuration methods, which would be unavailable due to different module context. */
 declare interface FroalaEditorConfigurator {
     readonly defineIcon: (iconName: string, parameters: Partial<DefineIconParameters>) => void;
@@ -641,6 +777,21 @@ declare interface InjectedProps {
     readonly children: React.ReactNode;
 }
 
+declare interface LinkParameters {
+    /**
+     * Opens a link using window.open().
+     */
+    readonly useWindowOpen?: boolean;
+    /**
+     *  Name of the browsing context the resource is being loaded into.
+     */
+    readonly target: string;
+    /**
+     * Parameters used when link is opened using window.open().
+     */
+    readonly windowOpenLinkParameters: WindowOpenLinkParameters;
+}
+
 /**
  * Describes options and configuration of a link plugin added to Rich text editor.
  */
@@ -998,4 +1149,11 @@ export declare interface ValidationRuleProps {
     readonly errorMessage: string | null;
 }
 
+declare interface WindowOpenLinkParameters {
+    /**
+     * Target window features.
+     */
+    readonly features: string;
+}
+
 export { }