@sveltia/ui 0.25.7 → 0.25.9

package/dist/components/toolbar/toolbar.svelte.d.ts

@@ -10,57 +10,58 @@ type Toolbar = {
  */
 declare const Toolbar: import("svelte").Component<{
     /**
-     * - The `class` attribute on the wrapper element.
+     * The `class` attribute on the wrapper element.
      */
     class?: string | undefined;
     /**
-     * - Whether to hide the widget.
+     * Whether to hide the widget.
      */
     hidden?: boolean | undefined;
     /**
-     * - Whether to disable the widget. An alias of the `aria-disabled`
+     * Whether to disable the widget. An alias of the `aria-disabled`
      * attribute.
      */
     disabled?: boolean | undefined;
     /**
-     * - Orientation of the widget. An alias of
-     * the `aria-orientation` attribute.
+     * Orientation of the widget. An alias of the
+     * `aria-orientation` attribute.
      */
     orientation?: "vertical" | "horizontal" | undefined;
     /**
-     * - The style variant of the toolbar.
+     * The style variant of the toolbar.
      */
     variant?: "primary" | "secondary" | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 } & Record<string, any>, {}, "">;
 type Props = {
     /**
-     * - The `class` attribute on the wrapper element.
+     * The `class` attribute on the wrapper element.
      */
     class?: string | undefined;
     /**
-     * - Whether to hide the widget.
+     * Whether to hide the widget.
      */
     hidden?: boolean | undefined;
     /**
-     * - Whether to disable the widget. An alias of the `aria-disabled`
+     * Whether to disable the widget. An alias of the `aria-disabled`
      * attribute.
      */
     disabled?: boolean | undefined;
     /**
-     * - Orientation of the widget. An alias of
-     * the `aria-orientation` attribute.
+     * Orientation of the widget. An alias of the
+     * `aria-orientation` attribute.
      */
     orientation?: "vertical" | "horizontal" | undefined;
     /**
-     * - The style variant of the toolbar.
+     * The style variant of the toolbar.
      */
     variant?: "primary" | "secondary" | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 };
+import type { Snippet } from 'svelte';

package/dist/components/util/app-shell.svelte

@@ -7,11 +7,14 @@
 <script>
   import { onMount } from 'svelte';
 
+  /**
+   * @import { Snippet } from 'svelte';
+   */
+
   /**
    * @typedef {object} Props
-   * @property {'horizontal' | 'vertical'} [orientation] - Orientation of the app
-   * shell’s children..
-   * @property {import('svelte').Snippet} [children] - Primary slot content.
+   * @property {'horizontal' | 'vertical'} [orientation] Orientation of the app shell’s children.
+   * @property {Snippet} [children] Primary slot content.
    */
 
   /**

package/dist/components/util/app-shell.svelte.d.ts

@@ -10,23 +10,22 @@ type AppShell = {
  */
 declare const AppShell: import("svelte").Component<{
     /**
-     * - Orientation of the app
-     * shell’s children..
+     * Orientation of the app shell’s children.
      */
     orientation?: "vertical" | "horizontal" | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 } & Record<string, any>, {}, "">;
 type Props = {
     /**
-     * - Orientation of the app
-     * shell’s children..
+     * Orientation of the app shell’s children.
      */
     orientation?: "vertical" | "horizontal" | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 };
+import type { Snippet } from 'svelte';

package/dist/components/util/group.svelte

@@ -4,13 +4,17 @@
   @see https://w3c.github.io/aria/#group
 -->
 <script>
+  /**
+   * @import { Snippet } from 'svelte';
+   */
+
   /**
    * @typedef {object} Props
-   * @property {string} [class] - The `class` attribute on the wrapper element.
-   * @property {boolean} [hidden] - Whether to hide the widget.
-   * @property {boolean} [disabled] - Whether to disable the widget. An alias of the `aria-disabled`
+   * @property {string} [class] The `class` attribute on the wrapper element.
+   * @property {boolean} [hidden] Whether to hide the widget.
+   * @property {boolean} [disabled] Whether to disable the widget. An alias of the `aria-disabled`
    * attribute.
-   * @property {import('svelte').Snippet} [children] - Primary slot content.
+   * @property {Snippet} [children] Primary slot content.
    */
 
   /**

package/dist/components/util/group.svelte.d.ts

@@ -9,39 +9,40 @@ type Group = {
  */
 declare const Group: import("svelte").Component<{
     /**
-     * - The `class` attribute on the wrapper element.
+     * The `class` attribute on the wrapper element.
      */
     class?: string | undefined;
     /**
-     * - Whether to hide the widget.
+     * Whether to hide the widget.
      */
     hidden?: boolean | undefined;
     /**
-     * - Whether to disable the widget. An alias of the `aria-disabled`
+     * Whether to disable the widget. An alias of the `aria-disabled`
      * attribute.
      */
     disabled?: boolean | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 } & Record<string, any>, {}, "">;
 type Props = {
     /**
-     * - The `class` attribute on the wrapper element.
+     * The `class` attribute on the wrapper element.
      */
     class?: string | undefined;
     /**
-     * - Whether to hide the widget.
+     * Whether to hide the widget.
      */
     hidden?: boolean | undefined;
     /**
-     * - Whether to disable the widget. An alias of the `aria-disabled`
+     * Whether to disable the widget. An alias of the `aria-disabled`
      * attribute.
      */
     disabled?: boolean | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 };
+import type { Snippet } from 'svelte';

package/dist/components/util/modal.svelte

@@ -8,7 +8,11 @@
   import Placeholder from './placeholder.svelte';
 
   /**
-   * @type {import('../../typedefs').ModalProps & Record<string, any>}
+   * @import { ModalProps } from '../../typedefs';
+   */
+
+  /**
+   * @type {ModalProps & Record<string, any>}
    */
   let {
     /* eslint-disable prefer-const */
@@ -34,7 +38,7 @@
 
   /**
    * Close the modal.
-   * @param {string} returnValue - Return value to be used for `<dialog>`.
+   * @param {string} returnValue Return value to be used for `<dialog>`.
    */
   export const close = (returnValue) => {
     if (!dialog) {
@@ -57,7 +61,7 @@
     new Promise((resolve) => {
       /**
        * Transition event listener.
-       * @param {TransitionEvent} event - `transition` event.
+       * @param {TransitionEvent} event `transition` event.
        */
       const listener = (event) => {
         if (event.target === dialog) {

package/dist/components/util/modal.svelte.d.ts

@@ -6,6 +6,7 @@ type Modal = {
     close: (returnValue: string) => void;
 };
 /** A generic modal top-layer helper based on the HTML `<dialog>` element. */
-declare const Modal: import("svelte").Component<import("../../typedefs").ModalProps & Record<string, any>, {
+declare const Modal: import("svelte").Component<ModalProps & Record<string, any>, {
     close: (returnValue: string) => void;
 }, "dialog" | "open">;
+import type { ModalProps } from '../../typedefs';

package/dist/components/util/placeholder.svelte

@@ -3,9 +3,13 @@
   @see https://github.com/sveltejs/svelte/issues/3088
 -->
 <script>
+  /**
+   * @import { Snippet } from 'svelte';
+   */
+
   /**
    * @typedef {object} Props
-   * @property {import('svelte').Snippet} [children] - Primary slot content.
+   * @property {Snippet} [children] Primary slot content.
    */
 
   /**

package/dist/components/util/placeholder.svelte.d.ts

@@ -6,13 +6,14 @@ type Placeholder = {
 /** @see https://github.com/sveltejs/svelte/issues/3088 */
 declare const Placeholder: import("svelte").Component<{
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 } & Record<string, any>, {}, "">;
 type Props = {
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
 };
+import type { Snippet } from 'svelte';

package/dist/components/util/popup.svelte

@@ -9,28 +9,34 @@
   import { activatePopup } from '../../services/popup.svelte.js';
   import Modal from './modal.svelte';
 
+  /**
+   * @import { Snippet } from 'svelte';
+   * @import { Writable } from 'svelte/store';
+   * @import { ModalProps, PopupPosition } from '../../typedefs';
+   */
+
   /**
    * @typedef {object} Props
-   * @property {string} [class] - The `class` attribute on the content element.
-   * @property {boolean} [open] - Whether to open the popup.
-   * @property {boolean} [hovered] - Whether the content is hovered.
-   * @property {HTMLElement} [anchor] - A reference to the anchor element that opens the popup.
+   * @property {string} [class] The `class` attribute on the content element.
+   * @property {boolean} [open] Whether to open the popup.
+   * @property {boolean} [hovered] Whether the content is hovered.
+   * @property {HTMLElement} [anchor] A reference to the anchor element that opens the popup.
    * Typically a `<button>`.
-   * @property {HTMLElement} [content] - A reference to the content element.
-   * @property {import('../../typedefs').PopupPosition} [position] - Where to show the popup.
-   * @property {HTMLElement} [positionBaseElement] - The base element of {@link position}. If
-   * omitted, this will be {@link anchor}.
-   * @property {HTMLDialogElement} [parentDialogElement] - A reference to a dialog element that is
+   * @property {HTMLElement} [content] A reference to the content element.
+   * @property {PopupPosition} [position] Where to show the popup.
+   * @property {HTMLElement} [positionBaseElement] The base element of {@link position}. If omitted,
+   * this will be {@link anchor}.
+   * @property {HTMLDialogElement} [parentDialogElement] A reference to a dialog element that is
    * already displayed. This should be provided for a nested popup.
-   * @property {boolean} [touchOptimized] - Whether to show the popup at the center of the screen on
+   * @property {boolean} [touchOptimized] Whether to show the popup at the center of the screen on
    * mobile/tablet and ignore the defined dropdown `position`.
-   * @property {import('svelte').Snippet} [children] - Primary slot content.
-   * @property {import('svelte').Snippet} [extraContent] - Extra slot content.
-   * @property {(event: CustomEvent) => void} [onOpen] - Custom `Open` event handler.
+   * @property {Snippet} [children] Primary slot content.
+   * @property {Snippet} [extraContent] Extra slot content.
+   * @property {(event: CustomEvent) => void} [onOpen] Custom `Open` event handler.
    */
 
   /**
-   * @type {import('../../typedefs').ModalProps & Props & Record<string, any>}
+   * @type {ModalProps & Props & Record<string, any>}
    */
   let {
     /* eslint-disable prefer-const */
@@ -73,7 +79,7 @@
   let contentType = $state();
   /**
    * Style to be applied to the content.
-   * @type {import('svelte/store').Writable<Record<string, any>>}
+   * @type {Writable<Record<string, any>>}
    */
   let style = writable({
     inset: undefined,
@@ -83,8 +89,8 @@
   });
 
   /**
-   * @type {{ style: import('svelte/store').Writable<Record<string, any>>, open:
-   * import('svelte/store').Writable<boolean>, checkPosition: () => void } | undefined}
+   * @type {{ style: Writable<Record<string, any>>, open: Writable<boolean>, checkPosition:
+   * () => void } | undefined}
    */
   let popupInstance = undefined;
   let hoveredTimeout = 0;

package/dist/components/util/popup.svelte.d.ts

@@ -4,111 +4,114 @@ type Popup = {
     $set?(props: Partial<ModalProps & Props & Record<string, any>>): void;
 };
 /** Generic popup helper. */
-declare const Popup: import("svelte").Component<import("../../typedefs").ModalProps & {
+declare const Popup: import("svelte").Component<ModalProps & {
     /**
-     * - The `class` attribute on the content element.
+     * The `class` attribute on the content element.
      */
     class?: string | undefined;
     /**
-     * - Whether to open the popup.
+     * Whether to open the popup.
      */
     open?: boolean | undefined;
     /**
-     * - Whether the content is hovered.
+     * Whether the content is hovered.
      */
     hovered?: boolean | undefined;
     /**
-     * - A reference to the anchor element that opens the popup.
+     * A reference to the anchor element that opens the popup.
      * Typically a `<button>`.
      */
     anchor?: HTMLElement | undefined;
     /**
-     * - A reference to the content element.
+     * A reference to the content element.
      */
     content?: HTMLElement | undefined;
     /**
-     * - Where to show the popup.
+     * Where to show the popup.
      */
-    position?: import("../../typedefs").PopupPosition | undefined;
+    position?: PopupPosition | undefined;
     /**
-     * - The base element of {@link position}. If
-     * omitted, this will be {@link anchor}.
+     * The base element of {@link position}. If omitted,
+     * this will be {@link anchor}.
      */
     positionBaseElement?: HTMLElement | undefined;
     /**
-     * - A reference to a dialog element that is
+     * A reference to a dialog element that is
      * already displayed. This should be provided for a nested popup.
      */
     parentDialogElement?: HTMLDialogElement | undefined;
     /**
-     * - Whether to show the popup at the center of the screen on
+     * Whether to show the popup at the center of the screen on
      * mobile/tablet and ignore the defined dropdown `position`.
      */
     touchOptimized?: boolean | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
     /**
-     * - Extra slot content.
+     * Extra slot content.
      */
-    extraContent?: import("svelte").Snippet<[]> | undefined;
+    extraContent?: Snippet<[]> | undefined;
     /**
-     * - Custom `Open` event handler.
+     * Custom `Open` event handler.
      */
     onOpen?: ((event: CustomEvent) => void) | undefined;
 } & Record<string, any>, {}, "open" | "hovered" | "content">;
 type Props = {
     /**
-     * - The `class` attribute on the content element.
+     * The `class` attribute on the content element.
      */
     class?: string | undefined;
     /**
-     * - Whether to open the popup.
+     * Whether to open the popup.
      */
     open?: boolean | undefined;
     /**
-     * - Whether the content is hovered.
+     * Whether the content is hovered.
      */
     hovered?: boolean | undefined;
     /**
-     * - A reference to the anchor element that opens the popup.
+     * A reference to the anchor element that opens the popup.
      * Typically a `<button>`.
      */
     anchor?: HTMLElement | undefined;
     /**
-     * - A reference to the content element.
+     * A reference to the content element.
      */
     content?: HTMLElement | undefined;
     /**
-     * - Where to show the popup.
+     * Where to show the popup.
      */
-    position?: import("../../typedefs").PopupPosition | undefined;
+    position?: PopupPosition | undefined;
     /**
-     * - The base element of {@link position}. If
-     * omitted, this will be {@link anchor}.
+     * The base element of {@link position}. If omitted,
+     * this will be {@link anchor}.
      */
     positionBaseElement?: HTMLElement | undefined;
     /**
-     * - A reference to a dialog element that is
+     * A reference to a dialog element that is
      * already displayed. This should be provided for a nested popup.
      */
     parentDialogElement?: HTMLDialogElement | undefined;
     /**
-     * - Whether to show the popup at the center of the screen on
+     * Whether to show the popup at the center of the screen on
      * mobile/tablet and ignore the defined dropdown `position`.
      */
     touchOptimized?: boolean | undefined;
     /**
-     * - Primary slot content.
+     * Primary slot content.
      */
-    children?: import("svelte").Snippet<[]> | undefined;
+    children?: Snippet<[]> | undefined;
     /**
-     * - Extra slot content.
+     * Extra slot content.
      */
-    extraContent?: import("svelte").Snippet<[]> | undefined;
+    extraContent?: Snippet<[]> | undefined;
     /**
-     * - Custom `Open` event handler.
+     * Custom `Open` event handler.
      */
     onOpen?: ((event: CustomEvent) => void) | undefined;
 };
+import type { ModalProps } from '../../typedefs';
+import type { PopupPosition } from '../../typedefs';
+import type { Snippet } from 'svelte';

package/dist/index.js

@@ -2,9 +2,9 @@ import { addMessages, init } from 'svelte-i18n';
 
 /**
  * Load strings and initialize the locales.
- * @param {object} [init] - Initialize options.
- * @param {string} [init.fallbackLocale] - Fallback locale.
- * @param {string} [init.initialLocale] - Initial locale.
+ * @param {object} [init] Initialize options.
+ * @param {string} [init.fallbackLocale] Fallback locale.
+ * @param {string} [init.initialLocale] Initial locale.
  * @see https://github.com/kaisermann/svelte-i18n/blob/main/docs/Getting%20Started.md
  * @see https://vitejs.dev/guide/features.html#glob-import
  */

package/dist/services/events.svelte.d.ts

@@ -1,3 +1,4 @@
 export function isMac(): boolean;
 export function matchShortcuts(event: KeyboardEvent, shortcuts: string): boolean;
-export function activateKeyShortcuts(element: (HTMLInputElement | HTMLButtonElement), shortcuts?: string | undefined): import("svelte/action").ActionReturn;
+export function activateKeyShortcuts(element: (HTMLInputElement | HTMLButtonElement), shortcuts?: string | undefined): ActionReturn;
+import type { ActionReturn } from 'svelte/action';

package/dist/services/events.svelte.js

@@ -1,3 +1,7 @@
+/**
+ * @import { ActionReturn } from 'svelte/action';
+ */
+
 /**
  * Check if the user agent is macOS.
  * @returns {boolean} Result.
@@ -8,8 +12,8 @@ export const isMac = () =>
 
 /**
  * Whether the event matches the given keyboard shortcuts.
- * @param {KeyboardEvent} event - `keydown` or `keypress` event.
- * @param {string} shortcuts - Keyboard shortcuts like `A` or `Ctrl+S`.
+ * @param {KeyboardEvent} event `keydown` or `keypress` event.
+ * @param {string} shortcuts Keyboard shortcuts like `A` or `Ctrl+S`.
  * @returns {boolean} Result.
  * @see https://w3c.github.io/aria/#aria-keyshortcuts
  */
@@ -48,11 +52,11 @@ export const matchShortcuts = (event, shortcuts) => {
 
 /**
  * Activate keyboard shortcuts.
- * @param {(HTMLInputElement | HTMLButtonElement)} element - Element.
- * @param {string} [shortcuts] - Keyboard shortcuts like `A` or `Accel+S` to focus and click the
- * text field or button. Multiple shortcuts can be defined space-separated. The `Accel` modifier
- * will be replaced with `Ctrl` on Windows/Linux and `Command` on macOS.
- * @returns {import('svelte/action').ActionReturn} Actions.
+ * @param {(HTMLInputElement | HTMLButtonElement)} element Element.
+ * @param {string} [shortcuts] Keyboard shortcuts like `A` or `Accel+S` to focus and click the text
+ * field or button. Multiple shortcuts can be defined space-separated. The `Accel` modifier will be
+ * replaced with `Ctrl` on Windows/Linux and `Command` on macOS.
+ * @returns {ActionReturn} Actions.
  */
 export const activateKeyShortcuts = (element, shortcuts = '') => {
   /** @type {string | undefined} */
@@ -60,7 +64,7 @@ export const activateKeyShortcuts = (element, shortcuts = '') => {
 
   /**
    * Handle the event.
-   * @param {KeyboardEvent} event - `keydown` event.
+   * @param {KeyboardEvent} event `keydown` event.
    */
   const handler = (event) => {
     const { disabled, offsetParent } = element;

package/dist/services/group.svelte.d.ts

@@ -1 +1,2 @@
-export function activateGroup(parent: HTMLElement, params?: object | undefined): import("svelte/action").ActionReturn;
+export function activateGroup(parent: HTMLElement, params?: object | undefined): ActionReturn;
+import type { ActionReturn } from 'svelte/action';

package/dist/services/group.svelte.js

@@ -1,3 +1,7 @@
+/**
+ * @import { ActionReturn } from 'svelte/action';
+ */
+
 import { generateElementId } from '@sveltia/utils/element';
 import { sleep } from '@sveltia/utils/misc';
 
@@ -61,9 +65,9 @@ const config = {
 class Group {
   /**
    * Initialize a new `Group` instance.
-   * @param {HTMLElement} parent - Parent element.
-   * @param {object} [options] - Options.
-   * @param {boolean} [options.clickToSelect] - Whether to select an item by clicking on it.
+   * @param {HTMLElement} parent Parent element.
+   * @param {object} [options] Options.
+   * @param {boolean} [options.clickToSelect] Whether to select an item by clicking on it.
    * @todo Check for added elements probably with `MutationObserver`.
    */
   constructor(parent, { clickToSelect = true } = {}) {
@@ -211,8 +215,8 @@ class Group {
 
   /**
    * Select (and move focus to) the given target.
-   * @param {(MouseEvent | KeyboardEvent)} event - Triggered event.
-   * @param {HTMLElement} newTarget - Target element.
+   * @param {(MouseEvent | KeyboardEvent)} event Triggered event.
+   * @param {HTMLElement} newTarget Target element.
    */
   selectTarget(event, newTarget) {
     if (this.isDisabled || this.isReadOnly) {
@@ -335,7 +339,7 @@ class Group {
 
   /**
    * Handle the `click` event on the widget.
-   * @param {MouseEvent} event - `click` event.
+   * @param {MouseEvent} event `click` event.
    */
   onClick(event) {
     // eslint-disable-next-line prefer-destructuring
@@ -354,7 +358,7 @@ class Group {
 
   /**
    * Handle the `keydown` event on the widget.
-   * @param {KeyboardEvent} event - `keydown` event.
+   * @param {KeyboardEvent} event `keydown` event.
    */
   onKeyDown(event) {
     const { key, ctrlKey, metaKey, shiftKey, altKey } = event;
@@ -461,7 +465,7 @@ class Group {
 
   /**
    * Called whenever the params are updated. Filter the items based on the search terms.
-   * @param {{ searchTerms: string }} params - Updated params.
+   * @param {{ searchTerms: string }} params Updated params.
    */
   onUpdate({ searchTerms }) {
     const terms = searchTerms.trim().toLocaleLowerCase();
@@ -493,9 +497,9 @@ class Group {
 
 /**
  * Activate a new group.
- * @param {HTMLElement} parent - Parent element.
- * @param {object} [params] - Action params.
- * @returns {import('svelte/action').ActionReturn} Action.
+ * @param {HTMLElement} parent Parent element.
+ * @param {object} [params] Action params.
+ * @returns {ActionReturn} Action.
  */
 export const activateGroup = (parent, params) => {
   const group = new Group(parent, params);
@@ -503,7 +507,7 @@ export const activateGroup = (parent, params) => {
   return {
     /**
      * Called whenever the params are updated.
-     * @param {any} newParams - Updated params.
+     * @param {any} newParams Updated params.
      */
     update(newParams) {
       group.onUpdate(newParams);