@geoscene/common-components 5.0.19

package/dist/components/geoscene-ckeditor5/customElement.d.ts

@@ -0,0 +1,97 @@
+/// <reference path="../../index.d.ts" />
+import type { PublicLitElement as LitElement } from "@geoscene/lumina";
+import type { EditorType, InputMentionField } from "./types.js";
+
+/** @internal */
+export abstract class GeosceneCkeditor5 extends LitElement {
+  /**
+   * The editor's text area will have a vertical resize handle if set to true
+   *
+   * @default false
+   */
+  accessor canResizeVertically: boolean | undefined;
+  /**
+   * language for ckeditor
+   *
+   * @default "en"
+   */
+  accessor currentLanguage: string;
+  /**
+   * Config to customize editor (will be merged with default config)
+   * Default config will match html or markdown editor here:https://devtopia.geoscene.cn/WebGIS/ckeditor5-build-classic.
+   * Also includes default language and field expression mentions settings
+   */
+  accessor customConfig: any | undefined;
+  /** The function that will be used to distinguish expressions from fields in the default mention configuration */
+  accessor customExpressionCheck: ((field: {
+      id: string;
+      name: string;
+  }) => boolean) | undefined;
+  /**
+   * Base configuration for editor
+   *
+   * @default "html"
+   */
+  accessor editorType: EditorType | undefined;
+  /**
+   * The fields / expressions in the default mention configuration will be grouped if set to true
+   *
+   * @default false
+   */
+  accessor groupFieldsAndExpressions: boolean | undefined;
+  /**
+   * Header text for expressions mention dropdown (assuming default mention configuration)
+   *
+   * @default ""
+   */
+  accessor intlExpressionsGroupHeading: string;
+  /**
+   * Header text for fields in mention dropdown (assuming default mention configuration)
+   *
+   * @default ""
+   */
+  accessor intlFieldsGroupHeading: string;
+  /**
+   * Placeholder text for editor
+   *
+   * @default ""
+   */
+  accessor intlTextPlaceHolder: string;
+  /**
+   * List of fields/expressions for the default mentions implementation
+   * If you don't want mentions or are customizing the mention feed in customConfig, you do not need to supply this
+   */
+  accessor mentionFields: InputMentionField[] | undefined;
+  /**
+   * The toolbar will be hidden and the data will only be changeable through the `textData` prop if true
+   *
+   * @default false
+   */
+  accessor readOnly: boolean | undefined;
+  /** Input data for editor in html / markdown text format */
+  accessor textData: string | undefined;
+  /** Get the current data in the editor. */
+  getData(): Promise<any>;
+  /** Set focus on the component. */
+  setFocus(): Promise<void>;
+  /** @deprecated use geosceneCreated instead */
+  readonly geosceneCkeditor5Created: import("@geoscene/lumina").TargetedEvent<this, GeosceneCkeditor5>;
+  /** @deprecated use geosceneDataUpdated instead */
+  readonly geosceneCkeditor5DataUpdated: import("@geoscene/lumina").TargetedEvent<this, string>;
+  /** @deprecated use geosceneSourceEditingChanged instead */
+  readonly geosceneCkeditor5SourceEditingChanged: import("@geoscene/lumina").TargetedEvent<this, boolean>;
+  /** Emitted when the editor has been created. */
+  readonly geosceneCreated: import("@geoscene/lumina").TargetedEvent<this, GeosceneCkeditor5>;
+  /** Emitted when the editor's data has been updated. */
+  readonly geosceneDataUpdated: import("@geoscene/lumina").TargetedEvent<this, string>;
+  /** Emitted when the editor's source editing mode has changed. */
+  readonly geosceneSourceEditingChanged: import("@geoscene/lumina").TargetedEvent<this, boolean>;
+  readonly "@eventTypes": {
+    geosceneCkeditor5Created: GeosceneCkeditor5["geosceneCkeditor5Created"]["detail"];
+    geosceneCkeditor5DataUpdated: GeosceneCkeditor5["geosceneCkeditor5DataUpdated"]["detail"];
+    geosceneCkeditor5SourceEditingChanged: GeosceneCkeditor5["geosceneCkeditor5SourceEditingChanged"]["detail"];
+    geosceneCreated: GeosceneCkeditor5["geosceneCreated"]["detail"];
+    geosceneDataUpdated: GeosceneCkeditor5["geosceneDataUpdated"]["detail"];
+    geosceneSourceEditingChanged: GeosceneCkeditor5["geosceneSourceEditingChanged"]["detail"];
+  };
+}