@kentico/xperience-admin-base 26.6.0 → 27.0.0

package/dist/entry.d.ts

@@ -1,8 +1,11 @@
 /// <reference types="react" />
 
+import { DefineIconParameters } from 'froala-editor';
 import { DraggableProvidedDragHandleProps } from 'react-beautiful-dnd';
+import { MutableRefObject } from 'react';
 import { default as React_2 } from 'react';
 import { RefObject } from 'react';
+import { RegisterCommandParameters } from 'froala-editor';
 
 /**
  * Represents basic set of additional action properties.
@@ -12,6 +15,16 @@ declare interface AdditionalActionProps {
     readonly componentName: string;
 }
 
+/**
+ * Represents RTE dropdown option component for inserting assets.
+ */
+export declare const AssetPanelRichTextEditorNestedComponent: React_2.ForwardRefExoticComponent<RichTextEditorNestedComponentProps & React_2.RefAttributes<RichTextEditorNestedComponentRef>>;
+
+export declare const AssetRichTextEditorPlugin: ({ inputRef, froalaEditorConfigurator, froalaEditorRef }: AssetRichTextEditorPluginProps) => JSX.Element;
+
+export declare interface AssetRichTextEditorPluginProps extends RichTextEditorPluginProps {
+}
+
 declare interface BaseButtonProps extends UITestProps {
     readonly renderComponent: (props: InjectedProps) => React.ReactNode;
     readonly size?: ButtonSize;
@@ -27,7 +40,7 @@ declare interface BaseButtonProps extends UITestProps {
     readonly disabled?: boolean;
     readonly borderless?: boolean;
     readonly tabIndex?: number;
-    readonly dragHandleProps?: DraggableProvidedDragHandleProps;
+    readonly dragHandleProps?: DraggableProvidedDragHandleProps | null;
     readonly className?: string;
 }
 
@@ -155,10 +168,14 @@ export declare interface FormComponentProps extends FieldInfo {
      * Dangerously sets explanation as inner HTML.
      */
     readonly explanationTextAsHtml?: boolean;
-    /**
-     * Indicates whether value change events should be debounced when form component has dependencies.
-     */
-    readonly debounceValueChange?: boolean;
+}
+
+/** 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;
+    readonly registerCommand: (buttonName: string, parameters: Partial<RegisterCommandParameters>) => void;
+    readonly disableButton: (buttonName: string, buttonTitle?: string) => void;
+    readonly enableButton: (buttonName: string, buttonTitle?: string) => void;
 }
 
 declare type HTMLButtonProps = Pick<React.ButtonHTMLAttributes<HTMLButtonElement>, 'title' | 'onClick'>;
@@ -469,6 +486,7 @@ declare const Icons = {
     'xp-monitor-smartphone' : monitorSmartphone,
     'xp-monitor' : monitor,
     'xp-mug' : mug,
+    'xp-multi-channel' : multiChannel,
     'xp-newspaper' : newspaper,
     'xp-note' : note,
     'xp-notebook' : notebook,
@@ -600,6 +618,28 @@ declare interface InjectedProps {
     readonly children: React.ReactNode;
 }
 
+/**
+ * Describes options and configuration of a link plugin added to Rich text editor.
+ */
+export declare interface LinkRichTextEditorPluginOptions extends RichTextEditorPluginOptionsBase {
+    /**
+     * Dropdown options for a dropdown used in the plugin.
+     */
+    readonly dropdownOptions: RichTextEditorDropdownOption[];
+}
+
+/**
+ * LinkRichTextEditorPlugin properties.
+ */
+export declare interface LinkRichTextEditorPluginProps extends RichTextEditorPluginProps {
+}
+
+export declare enum LinkType {
+    Asset = "asset",
+    External = "external",
+    WebPage = "webpage"
+}
+
 declare interface NotificationMessage {
     readonly id?: string | number;
     readonly message: string;
@@ -617,7 +657,106 @@ declare enum NotificationMessageType {
 /**
  * Untyped alias for value used on change.
  */
-declare type OnChangeValueType = any;
+declare type OnChangeValueType = Object | null;
+
+/**
+ * Describes single dropdown option configuration.
+ */
+export declare interface RichTextEditorDropdownOption {
+    /**
+     * Option to be contained in dropdown.
+     */
+    readonly linkOption: string;
+    /**
+     * Corresponding component of an option.
+     */
+    readonly componentName?: string;
+}
+
+export declare const RichTextEditorNestedComponentLoader: {
+    ({ onLoad, ...props }: RichTextEditorNestedComponentLoaderProps): JSX.Element;
+    displayName: string;
+};
+
+export declare interface RichTextEditorNestedComponentLoaderProps extends RichTextEditorNestedComponentProps {
+    /** Function called after load of the plugin. */
+    readonly onLoad: (inputRef: RichTextEditorNestedComponentRef) => void;
+}
+
+export declare interface RichTextEditorNestedComponentProps {
+    readonly componentName: string;
+    /** Reference to RichTextEditor providing higher-scope functions (i.e. inserting link/image or executing a command). */
+    readonly inputRef?: RefObject<RichTextEditorRef>;
+    /** General low-level reference to Froala editor. */
+    readonly froalaEditorRef?: MutableRefObject<any>;
+    /** Configurator is used to access Froala configuration methods usually available in global JS scope and unavailable for a plugin in different JS module. */
+    readonly froalaEditorConfigurator: FroalaEditorConfigurator;
+}
+
+/**
+ * Ref to provide rich text editor's nested component methods.
+ */
+export declare interface RichTextEditorNestedComponentRef {
+    /**
+     * Runs rich text editor nested component.
+     */
+    readonly execute: () => void;
+}
+
+/**
+ * Describes options and configuration of a custom plugin added to Rich text editor.
+ */
+declare interface RichTextEditorPluginOptionsBase {
+
+}
+
+declare interface RichTextEditorPluginProps {
+    readonly componentName: string;
+    /** Reference to RichTextEditor providing higher-scope functions (i.e. inserting link/image or executing a command). */
+    readonly inputRef?: RefObject<RichTextEditorRef>;
+    /** General low-level reference to Froala editor. */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    readonly froalaEditorRef?: MutableRefObject<any>;
+    /** Configurator is used to access Froala configuration methods usually available in global JS scope and unavailable for a plugin in different JS module. */
+    readonly froalaEditorConfigurator: FroalaEditorConfigurator;
+    /** Options and configuration of RTE plugins. */
+    readonly pluginOptions?: RichTextEditorPluginOptionsBase;
+}
+
+/**
+ * Ref to provide rich text editor's methods.
+ */
+declare interface RichTextEditorRef {
+    /**
+     * Insert image into the text on current caret position (required).
+     */
+    readonly insertImage: (imageUrl: string, imageAttributes: { [key: string]: string }) => void;
+    /**
+     * Replace image with a different one.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    readonly replaceImage: (imageUrl: string, imageAttributes: { [key: string]: string }, imageToReplace: any) => void;
+    /**
+     * Insert link into the text on current caret position (required).
+     */
+    readonly insertLink: (linkUrl: string, linkTitle: string, linkAttributes?: { [key: string]: string }) => void;
+    /**
+     * Executes registered command by its name.
+     */
+    readonly executeCommand: (commandName: string) => void;
+    /**
+     * Insert html content into the text on current caret position (required).
+     */
+    readonly insertHtml?: (htmlContent: string) => void;
+    /**
+     * Ensure onChange event.
+     */
+    readonly ensureChange?: () => void;
+    /**
+     * Indicates if the rich text editor is disabled.
+     */
+    readonly isDisabled?: () => boolean
+}
 
 export declare const RoutingContentPlaceholder: ({ children }: RoutingContentPlaceholderProps) => JSX.Element;