antfarm/src/lib/ui/field.ts

File automation framework for ants.

/**
 * Interface fields which describe webhook requests for user interfaces.
 */
export interface FieldOptions {

    /**
     * The query string ID of the field.
     */
    id: string;

    /**
     * The human-readable field name.
     */
    name: string;

    /**
     * Field max character length.
     */
    max_length?: number;

    /**
     * Required flag.
     */
    required?: boolean;

    /**
     * Field type. Drop-down, text, etc..
     */
    type?: string;

    /**
     * Placeholder text
     */
    placeholder?: string;

    /**
     * Acceptable options
     */
    valueList?: any[];

    /**
     * Tooltip to show more details on hover.
     */
    tooltip?: string;

    /**
     * Description to display near the form field.
     */
    description?: string;

    /**
     * Default or current value.
     */
    value?: string;

    /**
     * Read-only
     */
    readOnly?: boolean;
}