@sveltia/ui 0.64.0 → 0.65.0

package/dist/typedefs.d.ts

@@ -756,11 +756,72 @@ export type TextEditorConfig = {
      * Whether the editor is used as a code editor.
      */
     isCodeEditor: boolean;
+    /**
+     * Whether to autocomplete emojis when the user types a
+     * shortcode, like `:smi`. Default: `false`.
+     */
+    useEmojiAutocomplete?: boolean | undefined;
     /**
      * Default language for the code editor.
      */
     defaultLanguage?: string | undefined;
 };
+/**
+ * Raw emoji data as published by `emojilib`, keyed by emoji character. Each value lists the
+ * canonical name followed by any keywords.
+ */
+export type EmojiData = Record<string, string[]>;
+export type EmojiEntry = {
+    /**
+     * Emoji character, e.g. `🎉`.
+     */
+    emoji: string;
+    /**
+     * Canonical name used as the shortcode, e.g. `party_popper`.
+     */
+    name: string;
+    /**
+     * Lower-cased alternative keywords, e.g. `party`, `tada`.
+     */
+    aliases: string[];
+};
+/**
+ * A shortcode being typed, as handed to the emoji suggestions. Each host extends this with
+ * whatever it needs to locate the shortcode again when the emoji is inserted.
+ */
+export type EmojiTrigger = {
+    /**
+     * Identifier of this shortcode occurrence. It must stay the same while the
+     * query grows, so the list can tell a dismissed shortcode from a new one.
+     */
+    id: string;
+    /**
+     * Shortcode being typed, without the leading colon.
+     */
+    query: string;
+};
+/**
+ * Viewport-relative bounds of the shortcode being typed, which the emoji suggestions are anchored
+ * to.
+ */
+export type EmojiAnchorRect = {
+    /**
+     * Distance from the top of the viewport.
+     */
+    top: number;
+    /**
+     * Distance from the top of the viewport to the bottom of the shortcode.
+     */
+    bottom: number;
+    /**
+     * Distance from the left of the viewport.
+     */
+    left: number;
+    /**
+     * Distance from the left of the viewport to the right of the shortcode.
+     */
+    right: number;
+};
 /**
  * Loaders used to obtain the Shiki syntax highlighting engine, grammars and themes. Each returns
  * the loaded ES module, or a falsy value when the requested language or theme is unavailable.

package/dist/typedefs.js

@@ -314,9 +314,43 @@
  * @property {boolean} useMarkdownShortcuts Whether to enable Markdown keyboard shortcuts in the
  * rich text editor.
  * @property {boolean} isCodeEditor Whether the editor is used as a code editor.
+ * @property {boolean} [useEmojiAutocomplete] Whether to autocomplete emojis when the user types a
+ * shortcode, like `:smi`. Default: `false`.
  * @property {string} [defaultLanguage] Default language for the code editor.
  */
 
+/**
+ * Raw emoji data as published by `emojilib`, keyed by emoji character. Each value lists the
+ * canonical name followed by any keywords.
+ * @typedef {Record<string, string[]>} EmojiData
+ */
+
+/**
+ * @typedef {object} EmojiEntry
+ * @property {string} emoji Emoji character, e.g. `🎉`.
+ * @property {string} name Canonical name used as the shortcode, e.g. `party_popper`.
+ * @property {string[]} aliases Lower-cased alternative keywords, e.g. `party`, `tada`.
+ */
+
+/**
+ * A shortcode being typed, as handed to the emoji suggestions. Each host extends this with
+ * whatever it needs to locate the shortcode again when the emoji is inserted.
+ * @typedef {object} EmojiTrigger
+ * @property {string} id Identifier of this shortcode occurrence. It must stay the same while the
+ * query grows, so the list can tell a dismissed shortcode from a new one.
+ * @property {string} query Shortcode being typed, without the leading colon.
+ */
+
+/**
+ * Viewport-relative bounds of the shortcode being typed, which the emoji suggestions are anchored
+ * to.
+ * @typedef {object} EmojiAnchorRect
+ * @property {number} top Distance from the top of the viewport.
+ * @property {number} bottom Distance from the top of the viewport to the bottom of the shortcode.
+ * @property {number} left Distance from the left of the viewport.
+ * @property {number} right Distance from the left of the viewport to the right of the shortcode.
+ */
+
 /**
  * Loaders used to obtain the Shiki syntax highlighting engine, grammars and themes. Each returns
  * the loaded ES module, or a falsy value when the requested language or theme is unavailable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltia/ui",
-  "version": "0.64.0",
+  "version": "0.65.0",
   "description": "A collection of Svelte components and utilities for building user interfaces.",
   "repository": {
     "type": "git",
@@ -48,6 +48,7 @@
     "@lexical/utils": "^0.49.0",
     "@sveltia/i18n": "^1.2.3",
     "@sveltia/utils": "^0.12.1",
+    "emojilib": "^4.0.3",
     "lexical": "^0.49.0"
   },
   "devDependencies": {