@storm-stack/types/dist/utility-types/form.d.ts

⚡ The storm-stack monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.

export type SelectOptionValue = string | number | boolean | null;
/**
 * A utility type for specifying the type of an option for a Select or Radio form field.
 */
export interface SelectOption<TValue extends SelectOptionValue = SelectOptionValue, TName = string> {
    /**
     * The index of the select option
     */
    index: number;
    /**
     * The string value to display in the field
     */
    name: TName;
    /**
     * The value stored behind the scenes when selected
     */
    value: TValue;
    /**
     * The description of the select option
     */
    description?: string;
    /**
     * A short string describing the status of the select option
     */
    status?: string;
    /**
     * An optional icon to display in the select option
     */
    icon?: any;
    /**
     * Is the option value valid for selection in the dropdown
     */
    disabled: boolean;
    /**
     * Sets or retrieves whether the option in the list box is the default item.
     */
    selected: boolean;
}