@acorex/components 22.4.2 → 22.4.4

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

@@ -0,0 +1,296 @@
+import * as _angular_core from '@angular/core';
+import { OnDestroy } from '@angular/core';
+import * as _tiptap_core from '@tiptap/core';
+import { Editor, ChainedCommands, JSONContent, Content, Extension } from '@tiptap/core';
+import * as polytype from 'polytype';
+import { MXInputBaseValueComponent, MXLookComponent, AXOrientation, AXClickEvent } from '@acorex/cdk/common';
+
+/**
+ * Marker base for projected editor tools and slots.
+ */
+declare abstract class AXTextEditorSlot {
+}
+
+type AXTextEditorOutputFormat = 'json' | 'html';
+type AXTextEditorValue = string | Record<string, unknown> | null;
+interface AXTextEditorHostBridge {
+    placeHolder(): string;
+    outputFormat(): AXTextEditorOutputFormat;
+    value(): AXTextEditorValue;
+    disabled(): boolean;
+    readonly(): boolean;
+    notifyFocus(event?: FocusEvent): void;
+    notifyBlur(event?: FocusEvent): void;
+    notifyValue(value: AXTextEditorValue): void;
+}
+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_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' | 'bulletList' | 'orderedList' | 'superscript' | 'subscript' | 'link' | 'unlink' | 'blockquote' | 'code' | 'codeBlock' | 'horizontalRule' | 'insertTable' | 'addColumnBefore' | 'addColumnAfter' | 'deleteColumn' | 'addRowBefore' | 'addRowAfter' | 'deleteRow' | 'toggleHeaderRow' | 'deleteTable';
+
+declare class AXTextEditorCommandComponent extends AXTextEditorSlot {
+    private readonly editorService;
+    readonly command: _angular_core.InputSignal<AXTextEditorCommandType>;
+    readonly attrs: _angular_core.InputSignal<AXTextEditorCommandAttrs>;
+    readonly icon: _angular_core.InputSignal<string>;
+    readonly label: _angular_core.InputSignal<string>;
+    protected readonly toggleable: _angular_core.Signal<boolean>;
+    protected readonly active: _angular_core.Signal<boolean>;
+    protected readonly enabled: _angular_core.Signal<boolean>;
+    protected execute(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorCommandComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorCommandComponent, "ax-text-editor-command", never, { "command": { "alias": "command"; "required": true; "isSignal": true; }; "attrs": { "alias": "attrs"; "required": false; "isSignal": true; }; "icon": { "alias": "icon"; "required": false; "isSignal": true; }; "label": { "alias": "label"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorContentComponent extends AXTextEditorSlot implements OnDestroy {
+    private readonly editorService;
+    private readonly elementRef;
+    private readonly platformId;
+    private editor;
+    constructor();
+    private host;
+    ngOnDestroy(): void;
+    private createEditor;
+    private emitValue;
+    private serialize;
+    private toContent;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorContentComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorContentComponent, "ax-text-editor-content", never, {}, {}, never, never, true, never>;
+}
+
+declare function isTextEditorCommandActive(editor: Editor, command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+declare function canRunTextEditorCommand(editor: Editor, command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+declare function runTextEditorCommand(editor: Editor, command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+
+/**
+ * Per-editor Tiptap facade. Provided on `ax-text-editor`, so projected tools and
+ * custom toolbar children can `inject(AXTextEditorService)` and use either the
+ * named-command helpers or the full Tiptap instance.
+ */
+declare class AXTextEditorService {
+    private readonly _editor;
+    private host;
+    private preservedRange;
+    readonly editor: _angular_core.Signal<Editor>;
+    readonly version: _angular_core.WritableSignal<number>;
+    readonly disabled: _angular_core.WritableSignal<boolean>;
+    readonly readonly: _angular_core.WritableSignal<boolean>;
+    readonly editable: _angular_core.Signal<boolean>;
+    readonly textColor: _angular_core.WritableSignal<string>;
+    readonly highlightColor: _angular_core.WritableSignal<string>;
+    readonly zoom: _angular_core.WritableSignal<number>;
+    readonly zoomFactor: _angular_core.Signal<number>;
+    bindHost(host: AXTextEditorHostBridge): void;
+    syncHostState(): void;
+    getHost(): AXTextEditorHostBridge | null;
+    setEditor(editor: Editor | null): void;
+    refresh(): void;
+    chain(): ChainedCommands | null;
+    get commands(): Editor['commands'] | undefined;
+    get canCommands(): ReturnType<Editor['can']> | undefined;
+    isActive(command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+    can(command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+    preserveSelection(): void;
+    clearPreservedSelection(): void;
+    run(command: AXTextEditorCommandType, attrs?: AXTextEditorCommandAttrs): boolean;
+    private restorePreservedSelection;
+    getJSON(): JSONContent | null;
+    getHTML(): string;
+    getText(options?: {
+        blockSeparator?: string;
+    }): string;
+    setContent(content: Content, emitUpdate?: boolean): boolean;
+    insertContent(value: Content): boolean;
+    clearContent(): boolean;
+    focus(): boolean;
+    blur(): boolean;
+    isEmpty(): boolean;
+    isFocused(): boolean;
+    isEditable(): boolean;
+    setEditable(editable: boolean): void;
+    setZoom(value: number): void;
+    zoomIn(step?: number): void;
+    zoomOut(step?: number): void;
+    fitToPage(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
+}
+
+declare const AXTextEditorComponent_base: polytype.Polytype.ClusteredConstructor<[{
+    new (): MXInputBaseValueComponent<AXTextEditorValue>;
+    ɵfac: _angular_core.ɵɵFactoryDeclaration<MXInputBaseValueComponent<any>, never>;
+    ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
+}, typeof MXLookComponent]>;
+declare class AXTextEditorComponent extends AXTextEditorComponent_base {
+    private readonly editorService;
+    private readonly destroyRef;
+    private readonly projected;
+    private syncingFromEditor;
+    readonly placeHolder: _angular_core.InputSignal<string>;
+    readonly outputFormat: _angular_core.InputSignal<AXTextEditorOutputFormat>;
+    readonly initialLine: _angular_core.InputSignal<number>;
+    protected readonly zoomFactor: _angular_core.Signal<number>;
+    constructor();
+    protected readonly projectedContent: _angular_core.Signal<boolean>;
+    getEditor(): _tiptap_core.Editor;
+    getEditorService(): AXTextEditorService;
+    /** @ignore */
+    notifyEditorFocus(event?: FocusEvent): void;
+    /** @ignore */
+    notifyEditorBlur(event?: FocusEvent): void;
+    /** @ignore */
+    notifyEditorValue(value: AXTextEditorValue): void;
+    protected internalValueChanged(value: AXTextEditorValue): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorComponent, "ax-text-editor", never, { "disabled": { "alias": "disabled"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "value": { "alias": "value"; "required": false; }; "state": { "alias": "state"; "required": false; }; "name": { "alias": "name"; "required": false; }; "look": { "alias": "look"; "required": false; }; "placeHolder": { "alias": "placeHolder"; "required": false; "isSignal": true; }; "outputFormat": { "alias": "outputFormat"; "required": false; "isSignal": true; }; "initialLine": { "alias": "initialLine"; "required": false; "isSignal": true; }; }, { "onBlur": "onBlur"; "onFocus": "onFocus"; "valueChange": "valueChange"; "stateChange": "stateChange"; "onValueChanged": "onValueChanged"; "readonlyChange": "readonlyChange"; "disabledChange": "disabledChange"; }, ["projected"], ["*"], true, never>;
+}
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        superscript: {
+            toggleSuperscript: () => ReturnType;
+        };
+        subscript: {
+            toggleSubscript: () => ReturnType;
+        };
+    }
+}
+declare function createTextEditorExtensions(placeholder?: string | (() => string)): Extension[];
+
+declare class AXTextEditorToolbarComponent extends AXTextEditorSlot {
+    private readonly editorService;
+    readonly orientation: _angular_core.InputSignal<AXOrientation>;
+    protected onMouseDown(event: MouseEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorToolbarComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorToolbarComponent, "ax-text-editor-toolbar", never, { "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; }, {}, never, ["ax-prefix", "*", "ax-suffix"], true, never>;
+}
+
+declare class AXTextEditorHistoryComponent extends AXTextEditorSlot {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorHistoryComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorHistoryComponent, "ax-text-editor-history", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorHeadingComponent extends AXTextEditorSlot {
+    private readonly editorService;
+    protected readonly editorReady: _angular_core.Signal<boolean>;
+    protected readonly isParagraphSelected: _angular_core.Signal<boolean>;
+    protected readonly isH1: _angular_core.Signal<boolean>;
+    protected readonly isH2: _angular_core.Signal<boolean>;
+    protected readonly isH3: _angular_core.Signal<boolean>;
+    protected readonly currentLabel: _angular_core.Signal<"H1" | "H2" | "H3" | "Paragraph">;
+    protected onSelect(event: AXClickEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorHeadingComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorHeadingComponent, "ax-text-editor-heading", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorFontStyleComponent extends AXTextEditorSlot {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorFontStyleComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorFontStyleComponent, "ax-text-editor-font-style", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorAlignmentComponent extends AXTextEditorSlot {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorAlignmentComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorAlignmentComponent, "ax-text-editor-alignment", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorColorsComponent extends AXTextEditorSlot {
+    protected readonly editorService: AXTextEditorService;
+    protected setColor(color: string | null): void;
+    protected setHighlight(color: string | null): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorColorsComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorColorsComponent, "ax-text-editor-colors", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorColorSwatchesComponent extends AXTextEditorSlot {
+    protected readonly editorService: AXTextEditorService;
+    readonly textColors: _angular_core.InputSignal<string[]>;
+    readonly backgroundColors: _angular_core.InputSignal<string[]>;
+    readonly recentColors: _angular_core.ModelSignal<AXTextEditorRecentColor[]>;
+    protected readonly resolvedTextColors: _angular_core.Signal<string[]>;
+    protected readonly resolvedBackgroundColors: _angular_core.Signal<string[]>;
+    protected isTextSelected(color: string): boolean;
+    protected isBackgroundSelected(color: string): boolean;
+    protected applyText(color: string): void;
+    protected applyBackground(color: string): void;
+    protected applyRecent(item: AXTextEditorRecentColor): void;
+    private remember;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorColorSwatchesComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorColorSwatchesComponent, "ax-text-editor-color-swatches", never, { "textColors": { "alias": "textColors"; "required": false; "isSignal": true; }; "backgroundColors": { "alias": "backgroundColors"; "required": false; "isSignal": true; }; "recentColors": { "alias": "recentColors"; "required": false; "isSignal": true; }; }, { "recentColors": "recentColorsChange"; }, never, never, true, never>;
+}
+
+declare class AXTextEditorListComponent extends AXTextEditorSlot {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorListComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorListComponent, "ax-text-editor-list", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorLinkComponent extends AXTextEditorSlot {
+    protected readonly editorService: AXTextEditorService;
+    private readonly dropdown;
+    protected readonly href: _angular_core.WritableSignal<string>;
+    protected readonly active: _angular_core.Signal<boolean>;
+    private savedFrom;
+    private savedTo;
+    protected syncHref(): void;
+    protected apply(): void;
+    protected remove(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorLinkComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorLinkComponent, "ax-text-editor-link", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorBlocksComponent extends AXTextEditorSlot {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorBlocksComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorBlocksComponent, "ax-text-editor-blocks", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorTableComponent extends AXTextEditorSlot {
+    private readonly editorService;
+    private readonly dropdown;
+    protected readonly cells: number[];
+    protected readonly hover: _angular_core.WritableSignal<{
+        rows: number;
+        cols: number;
+    }>;
+    protected readonly sizeLabel: _angular_core.Signal<string>;
+    protected isHighlighted(row: number, col: number): boolean;
+    protected insert(rows: number, cols: number): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorTableComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorTableComponent, "ax-text-editor-table", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorScriptComponent extends AXTextEditorSlot {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorScriptComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorScriptComponent, "ax-text-editor-script", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorZoomComponent extends AXTextEditorSlot {
+    protected readonly editorService: AXTextEditorService;
+    private readonly dropdown;
+    protected readonly presets: readonly [40, 50, 75, 90, 100, 125, 150, 175, 200];
+    protected readonly draft: _angular_core.WritableSignal<string>;
+    protected readonly zoomLabel: _angular_core.Signal<string>;
+    protected readonly canZoomOut: _angular_core.Signal<boolean>;
+    protected readonly canZoomIn: _angular_core.Signal<boolean>;
+    protected syncDraft(): void;
+    protected onDraftInput(event: Event): void;
+    protected commitDraft(): void;
+    protected applyPreset(value: number): void;
+    protected fitToPage(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorZoomComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXTextEditorZoomComponent, "ax-text-editor-zoom", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXTextEditorModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXTextEditorModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXTextEditorModule, never, [typeof AXTextEditorComponent, typeof AXTextEditorToolbarComponent, typeof AXTextEditorContentComponent, typeof AXTextEditorCommandComponent, typeof AXTextEditorHistoryComponent, typeof AXTextEditorHeadingComponent, typeof AXTextEditorFontStyleComponent, typeof AXTextEditorAlignmentComponent, typeof AXTextEditorColorsComponent, typeof AXTextEditorColorSwatchesComponent, typeof AXTextEditorListComponent, typeof AXTextEditorLinkComponent, typeof AXTextEditorBlocksComponent, typeof AXTextEditorTableComponent, typeof AXTextEditorScriptComponent, typeof AXTextEditorZoomComponent], [typeof AXTextEditorComponent, typeof AXTextEditorToolbarComponent, typeof AXTextEditorContentComponent, typeof AXTextEditorCommandComponent, typeof AXTextEditorHistoryComponent, typeof AXTextEditorHeadingComponent, typeof AXTextEditorFontStyleComponent, typeof AXTextEditorAlignmentComponent, typeof AXTextEditorColorsComponent, typeof AXTextEditorColorSwatchesComponent, typeof AXTextEditorListComponent, typeof AXTextEditorLinkComponent, typeof AXTextEditorBlocksComponent, typeof AXTextEditorTableComponent, typeof AXTextEditorScriptComponent, typeof AXTextEditorZoomComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXTextEditorModule>;
+}
+
+export { AXTextEditorAlignmentComponent, AXTextEditorBlocksComponent, AXTextEditorColorSwatchesComponent, AXTextEditorColorsComponent, AXTextEditorCommandComponent, AXTextEditorComponent, AXTextEditorContentComponent, AXTextEditorFontStyleComponent, AXTextEditorHeadingComponent, AXTextEditorHistoryComponent, AXTextEditorLinkComponent, AXTextEditorListComponent, AXTextEditorModule, AXTextEditorScriptComponent, AXTextEditorService, AXTextEditorSlot, AXTextEditorTableComponent, AXTextEditorToolbarComponent, AXTextEditorZoomComponent, AX_TEXT_EDITOR_DEFAULT_BACKGROUND_COLORS, AX_TEXT_EDITOR_DEFAULT_TEXT_COLORS, AX_TEXT_EDITOR_ZOOM_MAX, AX_TEXT_EDITOR_ZOOM_MIN, AX_TEXT_EDITOR_ZOOM_PRESETS, canRunTextEditorCommand, createTextEditorExtensions, isTextEditorCommandActive, runTextEditorCommand };
+export type { AXTextEditorCommandAttrs, AXTextEditorCommandType, AXTextEditorHostBridge, AXTextEditorOutputFormat, AXTextEditorRecentColor, AXTextEditorValue };