@placeholderco/placeholder-ui 1.0.12 → 2.1.0

package/dist/form/Select.svelte.d.ts

@@ -1,37 +1,61 @@
-import type { ComboBoxGroup, ComboBoxItem, FetchFunctionType, RetrieveLabelFunctionType, SearchFunctionType } from "../models/ComboBoxItem.js";
-import { type Snippet } from "svelte";
-interface Props {
+import type { ComboBoxGroup, ComboBoxItem, FetchFunctionType, RetrieveLabelFunctionType, SearchFunctionType } from '../models/ComboBoxItem.js';
+import { type Snippet } from 'svelte';
+export interface SelectProps {
     /** HTML name attribute for the select (falls back to label, then auto-generated) */
     name?: string;
+    /** Label text displayed above the select */
     label?: string;
+    /** Selected value (bindable) */
     value?: string;
+    /** Full selected item object */
     rawValue?: ComboBoxItem;
+    /** Placeholder text when no value is selected */
     placeholder?: string;
+    /** CSS classes for the select element */
     class?: string;
+    /** CSS classes for the container element */
     containerClass?: string;
+    /** Disable the select */
     disabled?: boolean;
+    /** Mark field as required (shows asterisk) */
     required?: boolean;
+    /** Show error state styling */
     showError?: boolean;
+    /** Error message to display */
     errorText?: string;
+    /** Auto-focus on mount (first dialog open only) */
     autofocus?: boolean;
+    /** Auto-focus on every dialog open */
     autofocusDialog?: boolean;
+    /** Enable search/filter within options */
     allowSearch?: boolean;
     /** Hide "no results" message when search finds nothing */
     hideNoResults?: boolean;
+    /** Text shown while loading options */
     loadingText?: string;
+    /** Flat list of selectable options */
     options?: ComboBoxItem[];
+    /** Options organized into groups */
     groupedOptions?: ComboBoxGroup[];
-    tooltipLocation?: "top" | "bottom" | "left" | "right";
+    /** Position of the tooltip */
+    tooltipLocation?: 'top' | 'bottom' | 'left' | 'right';
+    /** Async function to fetch options */
     fetchFunction?: FetchFunctionType | null;
+    /** Async function to search/filter options */
     searchFunction?: SearchFunctionType | null;
+    /** Async function to retrieve label for a value */
     retrieveLabelFunction?: RetrieveLabelFunctionType | null;
+    /** Rich tooltip content using a Svelte snippet */
     tooltipContent?: Snippet;
+    /** Simple tooltip text */
     tooltipText?: string;
+    /** Callback when selection changes (returns value string) */
     onchange?: (e: string | undefined) => void;
+    /** Callback when selection changes (returns full item object) */
     onchangeRaw?: (e: ComboBoxItem | undefined) => void;
     /** HTML autocomplete attribute for the input */
     autocomplete?: string;
 }
-declare const Select: import("svelte").Component<Props, {}, "value">;
+declare const Select: import("svelte").Component<SelectProps, {}, "value">;
 type Select = ReturnType<typeof Select>;
 export default Select;