Interface ActionParameterSelectable<T>

interface ActionParameterSelectable<T> {
    label?: string;
    max?: MinMax<T>;
    min?: MinMax<T>;
    name: string;
    options: {
        label: string;
        selected?: boolean;
        value: string;
    }[];
    patternDescription?: string;
    required?: boolean;
    type?: T;
}

Type Parameters

Hierarchy

Properties

label? max? min? name options patternDescription? required? type?

Properties

Optionallabel

label?: string

placeholder text for the user input field

Optionalmax

max?: MinMax<T>

the maximum value allowed based on the type

Optionalmin

min?: MinMax<T>

the minimum value allowed based on the type

name

name: string

parameter name in url

options

options: {
    label: string;
    selected?: boolean;
    value: string;
}[]

Listing of the options the user should be able to select from

Type declaration

  • label: string

    displayed UI label of this selectable option

  • Optionalselected?: boolean

    whether this option should be selected by default

  • value: string

    value of this selectable option

OptionalpatternDescription

patternDescription?: string

human-readable description of the type and/or pattern, represents a caption and error, if value doesn't match

Optionalrequired

required?: boolean

declare if this field is required (defaults to false)

Optionaltype

type?: T

input field type

Settings

Member Visibility

On This Page

Properties