@stryke/types/dist/form.d.ts

A package containing many base TypeScript type definitions that are shared across many projects.

import type { NameValuePair } from "./utilities";
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> extends NameValuePair<TValue, TName> {
    /**
     * The index of the select option
     */
    index: number;
    /**
     * 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;
    /**
     * An optional image to display in the select option
     */
    image?: 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;
}