@aicayzer/inkkit 0.1.2 → 0.1.3

package/dist/chunks/{highlight-DQC71L-N.js → highlight-yHFoKkKz.js}

@@ -1,4 +1,4 @@
-import { a as Decoration, c as PluginKey, d as __toESM, i as $prose, o as DecorationSet, s as Plugin, u as __commonJSMin } from "./core-Dyg5rJLT.js";
+import { a as Decoration, c as PluginKey, d as __toESM, i as $prose, o as DecorationSet, s as Plugin, u as __commonJSMin } from "./core-Bvj0PMMi.js";
 //#region node_modules/.pnpm/highlight.js@11.11.2/node_modules/highlight.js/es/languages/arduino.js
 /** @type LanguageFn */
 function cPlusPlus(hljs) {

package/dist/core.d.ts

@@ -2,3 +2,4 @@ export { InkKitEditor } from './editor.js';
 export type { EditorEvents, EditorOptions, TextInputPreferences, CommandState, EditingMode, CaretState, Mark, Block, FormatCommand, FormatOptions, KeyInput, ImageInsertion, ShortcutName, Keymap, } from './editor.js';
 export { InkKitError } from './types.js';
 export type { DocumentFormat, EditorLabels, Heading, TableCommand, TableOptions, BlockMoveDirection, DocumentContext, DocumentInput, DocumentSnapshot, DocumentVersion, EditorErrorCode, ImageAdapter, WikiLinkReference, WikiLinkAdapter, FileReference, ClientPoint, FileContext, FilePresentation, FileAdapter, CapturedImage, PortableImage, ClipboardInput, ClipboardOutput, ClipboardScope, ClipboardImage, ClipboardDiagram, PrintableDocument, PrintableWarning, TextRange, ReadableTextSnapshot, TextRect, ViewportInsets, ViewportOptions, ViewportSnapshot, } from './types.js';
+export type { SlashMenuOptions, SlashCommandName, SlashCommand } from './types.js';

package/dist/core.js

@@ -1,2 +1,2 @@
-import { r as InkKitError, t as InkKitEditor } from "./chunks/core-Dyg5rJLT.js";
+import { r as InkKitError, t as InkKitEditor } from "./chunks/core-Bvj0PMMi.js";
 export { InkKitEditor, InkKitError };

package/dist/editor.d.ts

@@ -1,3 +1,4 @@
+import type { SlashMenuOptions } from './types.js';
 import { InkKitError, type ClientPoint, type DocumentInput, type DocumentSnapshot, type ImageAdapter, type FileAdapter, type WikiLinkAdapter, type ClipboardInput, type ClipboardOutput, type ClipboardScope, type DocumentVersion, type PrintableDocument, type TextRange, type ReadableTextSnapshot, type TextRect, type ViewportOptions, type ViewportSnapshot, type EditorLabels, type Heading, type TableCommand, type TableOptions, type BlockMoveDirection } from './types.js';
 /** An inline format that `CaretState` can report. */
 export type Mark = 'bold' | 'italic' | 'strikethrough' | 'highlight' | 'code' | 'link';
@@ -68,6 +69,8 @@ export interface TextInputPreferences {
 export interface EditorOptions {
     /** Shows, imports and exports images. Without it and `files`, image Markdown stays literal. */
     images?: ImageAdapter;
+    /** Opt-in block suggestions on an empty line. Fixed at mount. */
+    slashMenu?: SlashMenuOptions;
     /** Resolves path images and `![[name]]` embeds into images, audio, video, PDFs and file cards. */
     files?: FileAdapter;
     /** Resolves and opens `[[wiki links]]`. Without it they stay literal. */
@@ -188,6 +191,8 @@ export declare class InkKitEditor {
     private literalKeys;
     private configuredKeys;
     private readOnlyKeys;
+    private suggestions?;
+    private suggestionBase?;
     private changePlugin;
     private keys;
     private readonly events;
@@ -428,6 +433,8 @@ export declare class InkKitEditor {
      * text is each block's source.
      */
     private authoredSources;
+    private chooseWiki;
+    private chooseSlash;
     /** Returns whether the document or the marks the next typed text takes changed. */
     format(command: FormatCommand, options?: FormatOptions, expectedGeneration?: number): boolean;
     /**

package/dist/index.js

@@ -1,4 +1,4 @@
-import { n as registerMermaid, r as InkKitError, t as InkKitEditor } from "./chunks/core-Dyg5rJLT.js";
+import { n as registerMermaid, r as InkKitError, t as InkKitEditor } from "./chunks/core-Bvj0PMMi.js";
 //#region src/index.ts
 registerMermaid(async () => (await import("mermaid")).default);
 //#endregion

package/dist/style.css

@@ -953,3 +953,51 @@
     var(--inkkit-focus-offset, -2px)
   );
 }
+
+.inkkit-root .inkkit-suggestions {
+  position: fixed;
+  z-index: 100;
+  box-sizing: border-box;
+  width: var(--inkkit-menu-width, 240px);
+  max-width: calc(100vw - 8px);
+  max-height: 264px;
+  overflow-y: auto;
+  overscroll-behavior: contain;
+  padding: 4px;
+  border-radius: var(--inkkit-menu-radius, 8px);
+  background: var(--inkkit-menu-background, light-dark(#fff, #252529));
+  color: var(--inkkit-menu-text, CanvasText);
+  box-shadow: var(--inkkit-menu-shadow, 0 4px 18px #0003);
+  font: 14px / 24px var(--inkkit-font-family, system-ui, sans-serif);
+}
+.inkkit-root .inkkit-suggestions [role='option'] {
+  box-sizing: border-box;
+  height: 32px;
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  padding: 4px 8px;
+  border-radius: 4px;
+  cursor: default;
+  white-space: nowrap;
+  overflow: hidden;
+}
+.inkkit-root .inkkit-suggestions [aria-selected='true'] {
+  background: var(--inkkit-menu-highlight, light-dark(#e8e8ed, #414146));
+}
+.inkkit-root .inkkit-suggestion-glyph {
+  display: inline-block;
+  flex: 0 0 22px;
+  text-align: center;
+  font-size: 12px;
+}
+.inkkit-root .inkkit-suggestion-glyph::before {
+  content: attr(data-glyph);
+}
+.inkkit-root .inkkit-suggestions-status {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  clip-path: inset(50%);
+  overflow: hidden;
+}

package/dist/types.d.ts

@@ -74,6 +74,8 @@ export interface WikiLinkReference {
 }
 /** Resolves and opens wiki links. The host owns lookup, permissions and navigation. */
 export interface WikiLinkAdapter {
+    /** Matches note names for a typed `[[` query. Late answers are ignored. */
+    suggest?(query: string, context: FileContext): Promise<readonly string[]>;
     /** Whether the target is missing, for presentation only. */
     resolve?(reference: WikiLinkReference, context: DocumentContext): {
         missing?: boolean;
@@ -228,6 +230,26 @@ export interface ViewportSnapshot {
 }
 /** Built-in editor text. Hosts can override individual labels at mount time. */
 export interface EditorLabels {
+    suggestions: string;
+    suggestionsEmpty: string;
+    suggestionsLoading: string;
+    slashHeading1: string;
+    slashHeading2: string;
+    slashHeading3: string;
+    slashBulletList: string;
+    slashOrderedList: string;
+    slashTaskList: string;
+    slashQuote: string;
+    slashCodeBlock: string;
+    slashTable: string;
+    slashCallout: string;
+    slashDivider: string;
+    slashDiagram: string;
+    slashNote: string;
+    slashTip: string;
+    slashImportant: string;
+    slashWarning: string;
+    slashCaution: string;
     formattedEditor: string;
     plainTextEditor: string;
     sourceEditor: string;
@@ -287,3 +309,15 @@ export interface TableOptions {
     /** `sortRows`. Defaults to `text`. */
     comparison?: 'text' | 'number';
 }
+export type SlashCommandName = 'heading1' | 'heading2' | 'heading3' | 'bulletList' | 'orderedList' | 'taskList' | 'quote' | 'codeBlock' | 'table' | 'callout' | 'divider' | 'diagram';
+export interface SlashCommand {
+    name: string;
+    keywords?: readonly string[];
+    /** Returns Markdown to insert in place of the trigger. Undefined cancels the action. */
+    action(context: DocumentContext): string | undefined | Promise<string | undefined>;
+}
+export interface SlashMenuOptions {
+    enabled?: boolean;
+    commands?: readonly SlashCommandName[];
+    customCommands?: readonly SlashCommand[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicayzer/inkkit",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A preserving Markdown editor for offline web views and the web",
   "license": "MIT",
   "type": "module",