@dvcol/neo-svelte/dist/inputs/neo-select.model.d.ts

Neomorphic ui library for svelte 5

import type { Snippet } from 'svelte';
import type { HTMLOptionAttributes } from 'svelte/elements';
import type { NeoButtonProps } from '../buttons/neo-button.model.js';
import type { NeoInputProps } from './common/neo-input.model.js';
import type { NeoListItemOrSection, NeoListSelectedItem } from '../list/neo-list.model.js';
import type { NeoPopSelectProps } from '../tooltips/neo-pop-select.model.js';
export type NeoNativeSelectOption<Value = unknown> = string | number | ({
    value: Value;
    label?: string | Snippet;
} & HTMLOptionAttributes);
export type NeoNativeSelectProps<Value = unknown> = {
    /**
     * Custom icon for the picker.
     */
    icon?: NeoButtonProps['icon'];
    /**
     * Button properties to pass to the show/hide dropdown button.
     */
    buttonProps?: NeoButtonProps;
    /**
     * The array of options to display in the select.
     */
    options?: NeoNativeSelectOption<Value>[];
} & NeoInputProps;
export type NeoSelectOption<Value = unknown> = NeoListItemOrSection<Value>;
export type NeoSelectProps<Value = unknown> = {
    /**
     * Custom icon for the picker.
     */
    icon?: NeoButtonProps['icon'];
    /**
     * Custom content to display in the input.
     */
    content?: NeoInputProps['display'];
    /**
     * The array of options to display in the select.
     */
    options?: NeoSelectOption<Value>[];
    /**
     * Transform the selected item(s) into a displayable string.
     * @param selection
     */
    display?: (selection?: NeoListSelectedItem<Value> | NeoListSelectedItem<Value>[]) => NeoInputProps['display'];
    /**
     * Extract the selected item(s) value.
     * @param selection
     */
    transform?: (selection?: NeoListSelectedItem<Value> | NeoListSelectedItem<Value>[]) => undefined | Value | Value[];
    /**
     * Optional ref to the list.
     */
    listRef?: NeoPopSelectProps<Value>['listRef'];
    /**
     * Optional filter to highlight text.
     */
    highlight?: NeoPopSelectProps<Value>['highlight'];
    /**
     * A filter function to apply to each item in the list.
     * @param item
     */
    filter?: NeoPopSelectProps<Value>['filter'];
    /**
     * A sort function to apply to the list items.
     * @param a
     * @param b
     */
    sort?: NeoPopSelectProps<Value>['sort'];
    /**
     * The currently selected item(s).
     */
    selected?: NeoPopSelectProps<Value>['selected'];
    /**
     * Whether to show the search input.
     */
    search?: NeoPopSelectProps<Value>['search'];
    /**
     * Optional ref to the tooltip.
     */
    tooltipRef?: NeoPopSelectProps<Value>['tooltipRef'];
    /**
     * Optional ref to the trigger element.
     */
    triggerRef?: NeoPopSelectProps<Value>['triggerRef'];
    /**
     * The tooltip open state.
     */
    open?: NeoPopSelectProps<Value>['open'];
    /**
     * The delay in milliseconds before the tooltip opens on hover.
     *
     * @default 500
     */
    hoverDelay?: NeoPopSelectProps<Value>['hoverDelay'];
    /**
     * The delay in milliseconds before the tooltip open state changes.
     *
     * @default 100
     */
    openDelay?: NeoPopSelectProps<Value>['openDelay'];
    /**
     * Whether to open the tooltip on focus.
     */
    openOnFocus?: NeoPopSelectProps<Value>['openOnFocus'];
    /**
     * Whether to open the tooltip on hover.
     */
    openOnHover?: NeoPopSelectProps<Value>['openOnHover'];
    /**
     * Event listener that fires when an item is selected/deselected.
     * @param event
     */
    onSelect?: NeoPopSelectProps<Value>['onSelect'];
    /**
     * Event Handlers that fires on open.
     */
    onOpen?: NeoPopSelectProps<Value>['onOpen'];
    /**
     * Event Handlers that fires on close.
     */
    onClose?: NeoPopSelectProps<Value>['onClose'];
    /**
     * Optional props to pass to the list.
     */
    listProps?: NeoPopSelectProps<Value>;
    /**
     * Button properties to pass to the show/hide dropdown button.
     */
    buttonProps?: NeoButtonProps;
} & Omit<NeoInputProps, 'display'>;
export declare const displayValue: NeoSelectProps['display'];
export declare const transformValue: NeoSelectProps['transform'];