@fusion.dev/helix-headless 0.220.0 → 0.222.0

package/dist/code-editor/root/code-editor-root.d.ts

@@ -5,7 +5,7 @@ import '../../find/index.js';
 import '../../icon-button/index.js';
 import '../../toolbar/index.js';
 /** A problem in the text, from a linter or a language server, by where it is. */
-export interface EditorDiagnostic {
+export interface CodeEditorDiagnostic {
     /** Where it starts and ends, as offsets into the value. */
     from: number;
     message: string;
@@ -14,8 +14,8 @@ export interface EditorDiagnostic {
     tone?: 'danger' | 'info' | 'warning';
 }
 /** What an editor shows, which an engine draws. */
-export interface EditorEngineState {
-    diagnostics: readonly EditorDiagnostic[];
+export interface CodeEditorEngineState {
+    diagnostics: readonly CodeEditorDiagnostic[];
     /** The editor's name, for the engine's text area. */
     label: string;
     /** The language to highlight, such as `ts`, `css`, `md` or `rust`. Empty is plain text. */
@@ -27,14 +27,14 @@ export interface EditorEngineState {
     wrap: boolean;
 }
 /** What the editor tells the engine, which the engine calls as the reader works. */
-export interface EditorEngineListeners {
+export interface CodeEditorEngineListeners {
     /** The caret or selection moved, as offsets into the value. */
     caret?(from: number, to: number): void;
     /** The reader changed the text. Returns whether the change stands, so the engine can refuse one the page refused. */
     change(value: string): boolean;
 }
 /** What the find bar asks an engine to look for. */
-export interface EditorFindQuery {
+export interface CodeEditorFindQuery {
     caseSensitive: boolean;
     regex: boolean;
     /** What Replace puts in place of a match. */
@@ -43,12 +43,12 @@ export interface EditorFindQuery {
     wholeWord: boolean;
 }
 /** Where a search stands: how many matches, and which is selected, counting from 0, or -1 for none. */
-export interface EditorFindResult {
+export interface CodeEditorFindResult {
     count: number;
     index: number;
 }
 /** An engine drawing one editor, which the editor drives. */
-export interface EditorEngineView {
+export interface CodeEditorEngineView {
     /** Takes the engine out of the page. */
     destroy(): void;
     /**
@@ -56,27 +56,27 @@ export interface EditorEngineView {
      * or previous from the selected one. Marks every match while the find bar
      * is open.
      */
-    find?(query: EditorFindQuery, direction: 'first' | 'next' | 'previous'): EditorFindResult;
+    find?(query: CodeEditorFindQuery, direction: 'first' | 'next' | 'previous'): CodeEditorFindResult;
     /** Takes the marks a search drew away, as the find bar closes. */
     findEnd?(): void;
     /** Puts the caret in the engine's text area. */
     focus?(): void;
     /** Replaces the selected match, or every match, and returns where the search stands after. */
-    replace?(query: EditorFindQuery, all: boolean): EditorFindResult;
+    replace?(query: CodeEditorFindQuery, all: boolean): CodeEditorFindResult;
     /** Selects a range, scrolls it into view and puts the caret there. */
     select?(from: number, to: number): void;
     /** Shows a new state: a value set from outside, a language, diagnostics. */
-    update(state: EditorEngineState): void;
+    update(state: CodeEditorEngineState): void;
 }
 /**
  * Something that draws a code editor, such as CodeMirror through
- * `@fusion.dev/helix-editor`. The editor hands it an element to draw in.
+ * `@fusion.dev/helix-code-editor`. The editor hands it an element to draw in.
  */
-export interface EditorEngine {
-    mount(parent: HTMLElement, state: EditorEngineState, listeners: EditorEngineListeners): EditorEngineView;
+export interface CodeEditorEngine {
+    mount(parent: HTMLElement, state: CodeEditorEngineState, listeners: CodeEditorEngineListeners): CodeEditorEngineView;
 }
 /** Each diagnostic's line, counted from 1, by its start, from one pass over the value. */
-export declare const diagnosticLines: (value: string, diagnostics: readonly EditorDiagnostic[]) => number[];
+export declare const diagnosticLines: (value: string, diagnostics: readonly CodeEditorDiagnostic[]) => number[];
 /** The line and column an offset is at, each counted from 1. */
 export declare const positionOf: (value: string, at: number) => {
     column: number;
@@ -92,8 +92,8 @@ declare const HelixHeadlessCodeEditor_base: (new (...args: any[]) => import("@fu
  * A pane for working on a file: a header with its name, its language and the
  * page's own actions, the code, the problems in it, and a status line that
  * says where the caret is. On its own the code is a `<textarea>` in the code
- * face. Connect an engine and it draws the code instead: `connectEditor` from
- * `@fusion.dev/helix-editor` connects CodeMirror, with highlighting in your
+ * face. Connect an engine and it draws the code instead: `connectCodeEditor` from
+ * `@fusion.dev/helix-code-editor` connects CodeMirror, with highlighting in your
  * theme's syntax colors, line numbers, folding, bracket matching and history.
  * The value, the form, validation and the events stay the editor's, so a page
  * reads and writes it the same either way.
@@ -119,7 +119,7 @@ declare const HelixHeadlessCodeEditor_base: (new (...args: any[]) => import("@fu
  *
  * @since 0.216.0
  * @status experimental
- * @category inputs
+ * @category editors
  * @aliases Code editor, CodeMirror, File editor, IDE, Monaco
  * @documentation https://fusion.dev/helix/components/code-editor
  *
@@ -235,14 +235,14 @@ export declare class HelixHeadlessCodeEditor extends HelixHeadlessCodeEditor_bas
     /** How one problem in the list reads. `{line}` is its line and `{message}` what it says. */
     diagnosticLabel: string;
     /** The problems in the text, each underlined and listed under the editor. */
-    diagnostics: readonly EditorDiagnostic[];
+    diagnostics: readonly CodeEditorDiagnostic[];
     /** The list of problems' name. */
     diagnosticsLabel: string;
     /**
      * What draws the editor, such as `codeMirrorEngine()` from
-     * `@fusion.dev/helix-editor`. Absent, the editor is a plain text field.
+     * `@fusion.dev/helix-code-editor`. Absent, the editor is a plain text field.
      */
-    engine: EditorEngine | undefined;
+    engine: CodeEditorEngine | undefined;
     /** The name of the find bar's Close button. */
     findCloseLabel: string;
     /** The name of the find bar's toolbar, read by screen readers. */

package/dist/editor/index.d.ts

@@ -0,0 +1 @@
+export * from './root/editor-root.js';

package/dist/editor/index.js

@@ -0,0 +1 @@
+export * from './root/editor-root.js';