Interface ActionParameter<T, M>

Parameter to accept user input within an action

interface ActionParameter<T, M> {
    label?: string;
    max?: M;
    min?: M;
    name: string;
    pattern?: string;
    patternDescription?: string;
    required?: boolean;
    type?: T;
}

Type Parameters

Properties

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

Properties

Optionallabel

label?: string

placeholder text for the user input field

Optionalmax

max?: M

the maximum value allowed based on the type

Optionalmin

min?: M

the minimum value allowed based on the type

name

name: string

parameter name in url

Optionalpattern

pattern?: string

regular expression pattern to validate user input client side

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