@acorex/cdk 22.4.7 → 22.4.9

package/types/acorex-cdk-text-editor.d.ts

@@ -0,0 +1,156 @@
+import * as _angular_core from '@angular/core';
+import * as _tiptap_core from '@tiptap/core';
+import { Content, Extensions, Editor, JSONContent } from '@tiptap/core';
+
+type AXTextEditorTiptapEditor = Editor;
+type AXTextEditorTiptapContent = Content;
+type AXTextEditorTiptapJSON = JSONContent;
+type AXTextEditorTiptapChain = ReturnType<Editor['chain']>;
+type AXTextEditorHeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+type AXTextEditorTextAlign = 'left' | 'center' | 'right' | 'justify';
+type AXTextEditorTextDirection = 'rtl' | 'ltr';
+type AXTextEditorFontSizeToken = 'small' | 'large' | 'huge';
+declare const AX_TEXT_EDITOR_FONT_SIZE_TOKEN_VALUES: Record<AXTextEditorFontSizeToken, string>;
+type AXTextEditorCommandAttrs = Record<string, unknown>;
+declare const AX_TEXT_EDITOR_ZOOM_PRESETS: readonly [40, 50, 75, 90, 100, 125, 150, 175, 200];
+declare const AX_TEXT_EDITOR_ZOOM_MIN = 40;
+declare const AX_TEXT_EDITOR_ZOOM_MAX = 200;
+declare const AX_TEXT_EDITOR_FONT_SIZES: readonly [8, 9, 10, 11, 12, 14, 16, 18, 20, 24, 28, 32, 36, 48, 72];
+type AXTextEditorFontSize = (typeof AX_TEXT_EDITOR_FONT_SIZES)[number];
+declare const AX_TEXT_EDITOR_DEFAULT_TEXT_COLORS: string[];
+declare const AX_TEXT_EDITOR_DEFAULT_BACKGROUND_COLORS: string[];
+interface AXTextEditorRecentColor {
+    color: string;
+    kind: 'text' | 'background';
+}
+type AXTextEditorCommandType = 'undo' | 'redo' | 'bold' | 'italic' | 'underline' | 'strike' | 'heading' | 'paragraph' | 'align' | 'direction' | 'color' | 'highlight' | 'fontSize' | 'bulletList' | 'orderedList' | 'superscript' | 'subscript' | 'link' | 'unlink' | 'blockquote' | 'code' | 'codeBlock' | 'horizontalRule' | 'image' | 'video' | 'insertTable' | 'addColumnBefore' | 'addColumnAfter' | 'deleteColumn' | 'addRowBefore' | 'addRowAfter' | 'deleteRow' | 'toggleHeaderRow' | 'deleteTable';
+interface AXTextEditorFeatures {
+    table?: boolean;
+    image?: boolean;
+    video?: boolean;
+    superscript?: boolean;
+    subscript?: boolean;
+    keepSelection?: boolean;
+    placeholder?: boolean;
+}
+declare const AX_DEFAULT_TEXT_EDITOR_FEATURES: AXTextEditorFeatures;
+interface AXTextEditorLoadExtensionsOptions {
+    placeholder?: string | (() => string);
+    features?: AXTextEditorFeatures;
+    headingLevels?: AXTextEditorHeadingLevel[];
+    extensions?: Extensions;
+}
+interface AXTextEditorState {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strike: boolean;
+    code: boolean;
+    codeBlock: boolean;
+    headingLevel: AXTextEditorHeadingLevel | null;
+    bulletList: boolean;
+    orderedList: boolean;
+    blockquote: boolean;
+    superscript: boolean;
+    subscript: boolean;
+    textAlign: AXTextEditorTextAlign | null;
+    textColor: string | null;
+    highlightColor: string | null;
+    linkHref: string | null;
+    fontSize: string | null;
+    textDirection: AXTextEditorTextDirection | null;
+    table: boolean;
+    canUndo: boolean;
+    canRedo: boolean;
+    isEmpty: boolean;
+    isFocused: boolean;
+}
+declare const AX_EMPTY_TEXT_EDITOR_STATE: AXTextEditorState;
+interface AXTextEditorInitOptions {
+    content?: AXTextEditorTiptapContent;
+    editable?: boolean;
+    placeholder?: string | (() => string);
+    features?: AXTextEditorFeatures;
+    headingLevels?: AXTextEditorHeadingLevel[];
+    extensions?: Extensions;
+    editorProps?: _tiptap_core.EditorOptions['editorProps'];
+    /** @deprecated Use `editable: false` instead. */
+    readOnly?: boolean;
+    onUpdate?: (editor: AXTextEditorTiptapEditor) => void;
+    onFocus?: (editor: AXTextEditorTiptapEditor, event?: FocusEvent) => void;
+    onBlur?: (editor: AXTextEditorTiptapEditor, event?: FocusEvent) => void;
+    onSelectionUpdate?: (editor: AXTextEditorTiptapEditor) => void;
+    onTransaction?: (editor: AXTextEditorTiptapEditor) => void;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        superscript: {
+            toggleSuperscript: () => ReturnType;
+        };
+        subscript: {
+            toggleSubscript: () => ReturnType;
+        };
+        axTextEditorFontSize: {
+            setFontSize: (size: string | null) => ReturnType;
+        };
+        axTextEditorVideo: {
+            setVideo: (options: {
+                src: string;
+            }) => ReturnType;
+        };
+    }
+}
+
+declare class AXTextEditor {
+    readonly editor: _angular_core.WritableSignal<_tiptap_core.Editor>;
+    readonly state: _angular_core.WritableSignal<AXTextEditorState>;
+    readonly ready: _angular_core.WritableSignal<boolean>;
+    readonly version: _angular_core.WritableSignal<number>;
+    private readonly platformId;
+    private destroyed;
+    private applyingContent;
+    init(container: HTMLElement | string, options?: AXTextEditorInitOptions): Promise<void>;
+    destroy(): void;
+    refresh(): void;
+    setContent(value: AXTextEditorTiptapContent | null | undefined, emit?: boolean): void;
+    getHTML(): string;
+    getJSON(): AXTextEditorTiptapJSON | null;
+    getText(options?: {
+        blockSeparator?: string;
+    }): string;
+    isEmpty(): boolean;
+    isFocused(): boolean;
+    isEditable(): boolean;
+    setEditable(editable: boolean): void;
+    focus(): void;
+    blur(): void;
+    chain(): AXTextEditorTiptapChain | null;
+    get commands(): AXTextEditorTiptapEditor['commands'] | undefined;
+    isActive(command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+    can(command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+    run(command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+    private commandsApi;
+    private getCommandsApi;
+    insertContent(value: AXTextEditorTiptapContent): boolean;
+    clearContent(): boolean;
+    insertImage(src: string, alt?: string): void;
+    insertVideo(src: string): void;
+    setLink(href: string): void;
+    unsetLink(): void;
+    clearFormatting(): void;
+    toggleHeading(level: AXTextEditorHeadingLevel): void;
+    setTextAlign(align: AXTextEditorTextAlign): void;
+    setTextDirection(direction: AXTextEditorTextDirection): void;
+    private refreshState;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditor, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
+}
+
+declare function isTextEditorCommandActive(editor: AXTextEditorTiptapEditor, command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+declare function canRunTextEditorCommand(editor: AXTextEditorTiptapEditor, command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+declare function runTextEditorCommand(editor: AXTextEditorTiptapEditor, command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+
+declare function createTextEditorExtensions(placeholderOrOptions?: string | (() => string) | AXTextEditorLoadExtensionsOptions): Promise<_tiptap_core.AnyExtension[]>;
+
+export { AXTextEditor, AX_DEFAULT_TEXT_EDITOR_FEATURES, AX_EMPTY_TEXT_EDITOR_STATE, AX_TEXT_EDITOR_DEFAULT_BACKGROUND_COLORS, AX_TEXT_EDITOR_DEFAULT_TEXT_COLORS, AX_TEXT_EDITOR_FONT_SIZES, AX_TEXT_EDITOR_FONT_SIZE_TOKEN_VALUES, AX_TEXT_EDITOR_ZOOM_MAX, AX_TEXT_EDITOR_ZOOM_MIN, AX_TEXT_EDITOR_ZOOM_PRESETS, canRunTextEditorCommand, createTextEditorExtensions, isTextEditorCommandActive, runTextEditorCommand };
+export type { AXTextEditorCommandAttrs, AXTextEditorCommandType, AXTextEditorFeatures, AXTextEditorFontSize, AXTextEditorFontSizeToken, AXTextEditorHeadingLevel, AXTextEditorInitOptions, AXTextEditorLoadExtensionsOptions, AXTextEditorRecentColor, AXTextEditorState, AXTextEditorTextAlign, AXTextEditorTextDirection, AXTextEditorTiptapChain, AXTextEditorTiptapContent, AXTextEditorTiptapEditor, AXTextEditorTiptapJSON };

package/types/acorex-cdk-wysiwyg.d.ts

@@ -65,7 +65,7 @@ interface AXWysiwygLoadExtensionsOptions {
 }
 
 /**
- * @deprecated Use `AXTextEditorService` from `@acorex/components/text-editor` instead.
+ * @deprecated Use `AXTextEditor` from `@acorex/cdk/text-editor` instead.
  */
 declare class AXWysiwyg {
     readonly editor: _angular_core.WritableSignal<Editor>;