@gravionlabs/helix-core 22.1.1 → 22.1.3

package/types/gravionlabs-helix-core-editor.d.ts

@@ -1,15 +1,29 @@
-import { EditorPassThrough, EditorInitEvent, EditorTextChangeEvent, EditorSelectionChangeEvent, EditorChangeEvent, EditorFocusEvent, EditorBlurEvent } from '@gravionlabs/helix-core/types/editor';
-export * from '@gravionlabs/helix-core/types/editor';
-import * as _angular_core from '@angular/core';
-import { TemplateRef } from '@angular/core';
-import * as i2 from '@gravionlabs/helix-core/api';
-import { Header, HelixTemplate } from '@gravionlabs/helix-core/api';
-import { BaseEditableHolder } from '@gravionlabs/helix-core/baseeditableholder';
-import * as i1 from '@gravionlabs/helix-core/bind';
-import { Bind } from '@gravionlabs/helix-core/bind';
-import { Nullable } from '@gravionlabs/helix-core/ts-helpers';
-import { BaseStyle } from '@gravionlabs/helix-core/base';
-
+import { EditorBlurEvent, EditorChangeEvent, EditorFocusEvent, EditorInitEvent, EditorPassThrough, EditorSelectionChangeEvent, EditorTextChangeEvent } from "@gravionlabs/helix-core/types/editor";
+import * as i0 from "@angular/core";
+import { TemplateRef } from "@angular/core";
+import * as i2 from "@gravionlabs/helix-core/api";
+import { Header, HelixTemplate } from "@gravionlabs/helix-core/api";
+import { BaseEditableHolder } from "@gravionlabs/helix-core/baseeditableholder";
+import * as i1 from "@gravionlabs/helix-core/bind";
+import { Bind } from "@gravionlabs/helix-core/bind";
+import { Nullable } from "@gravionlabs/helix-core/ts-helpers";
+import { BaseStyle } from "@gravionlabs/helix-core/base";
+export * from "@gravionlabs/helix-core/types/editor";
+export declare class EditorStyle extends BaseStyle {
+  name: string;
+  style: string;
+  classes: {
+    root: ({ instance }: {
+      instance: any;
+    }) => (string | {
+      'h-invalid': any;
+    })[];
+    toolbar: string;
+    content: string;
+  };
+  static ɵfac: i0.ɵɵFactoryDeclaration<EditorStyle, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
 /**
  *
  * Editor groups a collection of contents in tabs.
@@ -19,170 +33,208 @@ import { BaseStyle } from '@gravionlabs/helix-core/base';
  * @module editorstyle
  *
  */
-declare enum EditorClasses {
-    /**
-     * Class name of the root element
-     */
-    root = "h-editor",
-    /**
-     * Class name of the toolbar element
-     */
-    toolbar = "h-editor-toolbar",
-    /**
-     * Class name of the content element
-     */
-    content = "h-editor-content"
-}
-declare class EditorStyle extends BaseStyle {
-    name: string;
-    style: string;
-    classes: {
-        root: ({ instance }: {
-            instance: any;
-        }) => (string | {
-            'h-invalid': any;
-        })[];
-        toolbar: string;
-        content: string;
-    };
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EditorStyle, never>;
-    static ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
-}
-interface EditorStyle extends BaseStyle {
+export declare enum EditorClasses {
+  /**
+   * Class name of the root element
+   */
+  root = "h-editor",
+  /**
+   * Class name of the toolbar element
+   */
+  toolbar = "h-editor-toolbar",
+  /**
+   * Class name of the content element
+   */
+  content = "h-editor-content"
 }
-
-declare const EDITOR_VALUE_ACCESSOR: any;
+export interface EditorStyle extends BaseStyle {}
+export declare const EDITOR_VALUE_ACCESSOR: any;
 /**
  * Editor groups a collection of contents in tabs.
  * @group Components
  */
-declare class Editor extends BaseEditableHolder<EditorPassThrough> {
-    componentName: string;
-    $pcEditor: Editor | undefined;
-    bindDirectiveInstance: Bind;
-    onAfterViewChecked(): void;
-    /**
-     * Inline style of the container.
-     * @group Props
-     */
-    readonly style: _angular_core.InputSignal<{
-        [klass: string]: any;
-    } | null | undefined>;
-    /**
-     * Style class of the container.
-     * @deprecated since v20.0.0, use `class` instead.
-     * @group Props
-     */
-    readonly styleClass: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Placeholder text to show when editor is empty.
-     * @group Props
-     */
-    readonly placeholder: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Whitelist of formats to display, see [here](https://quilljs.com/docs/formats/) for available options.
-     * @group Props
-     */
-    readonly formats: _angular_core.InputSignal<string[] | undefined>;
-    /**
-     * Modules configuration of Editor, see [here](https://quilljs.com/docs/modules/) for available options.
-     * @group Props
-     */
-    readonly modules: _angular_core.InputSignal<object | undefined>;
-    /**
-     * DOM Element or a CSS selector for a DOM Element, within which the editor’s p elements (i.e. tooltips, etc.) should be confined. Currently, it only considers left and right boundaries.
-     * @group Props
-     */
-    readonly bounds: _angular_core.InputSignal<string | HTMLElement | undefined>;
-    /**
-     * DOM Element or a CSS selector for a DOM Element, specifying which container has the scrollbars (i.e. overflow-y: auto), if is has been changed from the default ql-editor with custom CSS. Necessary to fix scroll jumping bugs when Quill is set to auto grow its height, and another ancestor container is responsible from the scrolling..
-     * @group Props
-     */
-    readonly scrollingContainer: _angular_core.InputSignal<string | HTMLElement | undefined>;
-    /**
-     * Shortcut for debug. Note debug is a static method and will affect other instances of Quill editors on the page. Only warning and error messages are enabled by default.
-     * @group Props
-     */
-    readonly debug: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Whether to instantiate the editor to read-only mode.
-     * @group Props
-     */
-    readonly readonly: _angular_core.InputSignal<boolean>;
-    /**
-     * Callback to invoke when the quill modules are loaded.
-     * @param {EditorInitEvent} event - custom event.
-     * @group Emits
-     */
-    readonly onEditorInit: _angular_core.OutputEmitterRef<EditorInitEvent>;
-    /**
-     * Callback to invoke when text of editor changes.
-     * @param {EditorTextChangeEvent} event - custom event.
-     * @group Emits
-     */
-    readonly onTextChange: _angular_core.OutputEmitterRef<EditorTextChangeEvent>;
-    /**
-     * Callback to invoke when selection of the text changes.
-     * @param {EditorSelectionChangeEvent} event - custom event.
-     * @group Emits
-     */
-    readonly onSelectionChange: _angular_core.OutputEmitterRef<EditorSelectionChangeEvent>;
-    /**
-     * Callback to invoke when editor content changes (combines both text and selection changes).
-     * @param {EditorChangeEvent} event - custom event.
-     * @group Emits
-     */
-    readonly onEditorChange: _angular_core.OutputEmitterRef<EditorChangeEvent>;
-    /**
-     * Callback to invoke when editor receives focus.
-     * @param {EditorFocusEvent} event - custom event.
-     * @group Emits
-     */
-    readonly onFocus: _angular_core.OutputEmitterRef<EditorFocusEvent>;
-    /**
-     * Callback to invoke when editor loses focus.
-     * @param {EditorBlurEvent} event - custom event.
-     * @group Emits
-     */
-    readonly onBlur: _angular_core.OutputEmitterRef<EditorBlurEvent>;
-    readonly toolbar: _angular_core.Signal<Header | undefined>;
-    value: Nullable<string>;
-    delayedCommand: Function | null;
-    quill: any;
-    dynamicQuill: any;
-    /**
-     * Custom item template.
-     * @group Templates
-     */
-    readonly headerTemplate: _angular_core.Signal<Nullable<TemplateRef<any>>>;
-    readonly templates: _angular_core.Signal<readonly HelixTemplate[]>;
-    _headerTemplate: TemplateRef<any> | undefined;
-    private get isAttachedQuillEditorToDOM();
-    private quillElements;
-    private focusListener;
-    private blurListener;
-    _componentStyle: EditorStyle;
-    constructor();
-    onAfterContentInit(): void;
-    /**
-     * @override
-     *
-     * @see {@link BaseEditableHolder.writeControlValue}
-     * Writes the value to the control.
-     */
-    writeControlValue(value: any): void;
-    getQuill(): any;
-    private initQuillEditor;
-    private createQuillEditor;
-    onDestroy(): void;
-    private initQuillElements;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<Editor, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Editor, "h-editor", never, { "style": { "alias": "style"; "required": false; "isSignal": true; }; "styleClass": { "alias": "styleClass"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "formats": { "alias": "formats"; "required": false; "isSignal": true; }; "modules": { "alias": "modules"; "required": false; "isSignal": true; }; "bounds": { "alias": "bounds"; "required": false; "isSignal": true; }; "scrollingContainer": { "alias": "scrollingContainer"; "required": false; "isSignal": true; }; "debug": { "alias": "debug"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; }, { "onEditorInit": "onInit"; "onTextChange": "onTextChange"; "onSelectionChange": "onSelectionChange"; "onEditorChange": "onEditorChange"; "onFocus": "onFocus"; "onBlur": "onBlur"; }, ["toolbar", "headerTemplate", "templates"], ["h-header"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
-}
-declare class EditorModule {
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EditorModule, never>;
-    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<EditorModule, never, [typeof Editor, typeof i2.SharedModule], [typeof Editor, typeof i2.SharedModule]>;
-    static ɵinj: _angular_core.ɵɵInjectorDeclaration<EditorModule>;
+export declare class Editor extends BaseEditableHolder<EditorPassThrough> {
+  componentName: string;
+  $pcEditor: Editor | undefined;
+  bindDirectiveInstance: Bind;
+  onAfterViewChecked(): void;
+  /**
+   * Inline style of the container.
+   * @group Props
+   */
+  readonly style: import("@angular/core").InputSignal<{
+    [klass: string]: any;
+  } | null | undefined>;
+  /**
+   * Style class of the container.
+   * @deprecated since v20.0.0, use `class` instead.
+   * @group Props
+   */
+  readonly styleClass: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Placeholder text to show when editor is empty.
+   * @group Props
+   */
+  readonly placeholder: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Whitelist of formats to display, see [here](https://quilljs.com/docs/formats/) for available options.
+   * @group Props
+   */
+  readonly formats: import("@angular/core").InputSignal<string[] | undefined>;
+  /**
+   * Modules configuration of Editor, see [here](https://quilljs.com/docs/modules/) for available options.
+   * @group Props
+   */
+  readonly modules: import("@angular/core").InputSignal<object | undefined>;
+  /**
+   * DOM Element or a CSS selector for a DOM Element, within which the editor’s p elements (i.e. tooltips, etc.) should be confined. Currently, it only considers left and right boundaries.
+   * @group Props
+   */
+  readonly bounds: import("@angular/core").InputSignal<string | HTMLElement | undefined>;
+  /**
+   * DOM Element or a CSS selector for a DOM Element, specifying which container has the scrollbars (i.e. overflow-y: auto), if is has been changed from the default ql-editor with custom CSS. Necessary to fix scroll jumping bugs when Quill is set to auto grow its height, and another ancestor container is responsible from the scrolling..
+   * @group Props
+   */
+  readonly scrollingContainer: import("@angular/core").InputSignal<string | HTMLElement | undefined>;
+  /**
+   * Shortcut for debug. Note debug is a static method and will affect other instances of Quill editors on the page. Only warning and error messages are enabled by default.
+   * @group Props
+   */
+  readonly debug: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Whether to instantiate the editor to read-only mode.
+   * @group Props
+   */
+  readonly readonly: import("@angular/core").InputSignal<boolean>;
+  /**
+   * Callback to invoke when the quill modules are loaded.
+   * @param {EditorInitEvent} event - custom event.
+   * @group Emits
+   */
+  readonly onEditorInit: import("@angular/core").OutputEmitterRef<EditorInitEvent>;
+  /**
+   * Callback to invoke when text of editor changes.
+   * @param {EditorTextChangeEvent} event - custom event.
+   * @group Emits
+   */
+  readonly onTextChange: import("@angular/core").OutputEmitterRef<EditorTextChangeEvent>;
+  /**
+   * Callback to invoke when selection of the text changes.
+   * @param {EditorSelectionChangeEvent} event - custom event.
+   * @group Emits
+   */
+  readonly onSelectionChange: import("@angular/core").OutputEmitterRef<EditorSelectionChangeEvent>;
+  /**
+   * Callback to invoke when editor content changes (combines both text and selection changes).
+   * @param {EditorChangeEvent} event - custom event.
+   * @group Emits
+   */
+  readonly onEditorChange: import("@angular/core").OutputEmitterRef<EditorChangeEvent>;
+  /**
+   * Callback to invoke when editor receives focus.
+   * @param {EditorFocusEvent} event - custom event.
+   * @group Emits
+   */
+  readonly onFocus: import("@angular/core").OutputEmitterRef<EditorFocusEvent>;
+  /**
+   * Callback to invoke when editor loses focus.
+   * @param {EditorBlurEvent} event - custom event.
+   * @group Emits
+   */
+  readonly onBlur: import("@angular/core").OutputEmitterRef<EditorBlurEvent>;
+  readonly toolbar: import("@angular/core").Signal<Header | undefined>;
+  value: Nullable<string>;
+  delayedCommand: Function | null;
+  quill: any;
+  dynamicQuill: any;
+  /**
+   * Custom item template.
+   * @group Templates
+   */
+  readonly headerTemplate: import("@angular/core").Signal<Nullable<TemplateRef<any>>>;
+  readonly templates: import("@angular/core").Signal<readonly HelixTemplate[]>;
+  _headerTemplate: TemplateRef<any> | undefined;
+  private get isAttachedQuillEditorToDOM();
+  private quillElements;
+  private focusListener;
+  private blurListener;
+  _componentStyle: EditorStyle;
+  constructor();
+  onAfterContentInit(): void;
+  /**
+   * @override
+   *
+   * @see {@link BaseEditableHolder.writeControlValue}
+   * Writes the value to the control.
+   */
+  writeControlValue(value: any): void;
+  getQuill(): any;
+  private initQuillEditor;
+  private createQuillEditor;
+  onDestroy(): void;
+  private initQuillElements;
+  static ɵfac: i0.ɵɵFactoryDeclaration<Editor, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<Editor, "h-editor", never, {
+    "style": {
+      "alias": "style";
+      "required": false;
+      "isSignal": true;
+    };
+    "styleClass": {
+      "alias": "styleClass";
+      "required": false;
+      "isSignal": true;
+    };
+    "placeholder": {
+      "alias": "placeholder";
+      "required": false;
+      "isSignal": true;
+    };
+    "formats": {
+      "alias": "formats";
+      "required": false;
+      "isSignal": true;
+    };
+    "modules": {
+      "alias": "modules";
+      "required": false;
+      "isSignal": true;
+    };
+    "bounds": {
+      "alias": "bounds";
+      "required": false;
+      "isSignal": true;
+    };
+    "scrollingContainer": {
+      "alias": "scrollingContainer";
+      "required": false;
+      "isSignal": true;
+    };
+    "debug": {
+      "alias": "debug";
+      "required": false;
+      "isSignal": true;
+    };
+    "readonly": {
+      "alias": "readonly";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {
+    "onEditorInit": "onInit";
+    "onTextChange": "onTextChange";
+    "onSelectionChange": "onSelectionChange";
+    "onEditorChange": "onEditorChange";
+    "onFocus": "onFocus";
+    "onBlur": "onBlur";
+  }, ["toolbar", "headerTemplate", "templates"], ["h-header"], true, [{
+    directive: typeof i1.Bind;
+    inputs: {};
+    outputs: {};
+  }]>;
 }
-
-export { EDITOR_VALUE_ACCESSOR, Editor, EditorClasses, EditorModule, EditorStyle };
+export declare class EditorModule {
+  static ɵfac: i0.ɵɵFactoryDeclaration<EditorModule, never>;
+  static ɵmod: i0.ɵɵNgModuleDeclaration<EditorModule, never, [typeof Editor, typeof i2.SharedModule], [typeof Editor, typeof i2.SharedModule]>;
+  static ɵinj: i0.ɵɵInjectorDeclaration<EditorModule>;
+}