Type Alias NumberElement

NumberElement: {
    displayAsCurrency?: boolean;
    isInteger?: boolean;
    isSlider: boolean;
    maxNumber?: number;
    minNumber?: number;
    sliderIncrement?: number;
    type: "number";
} & FormElementWithInput<number>

An element to allow the user to supply a number.

The element must have an id property that contains a universally unique identifier (UUID). The identifier must be a Version 4 (V4) UUID and must conform to the formatting requirements defined in this RFC 9562 specification: https://www.rfc-editor.org/rfc/rfc9562.html

Type declaration

  • OptionaldisplayAsCurrency?: boolean

    If true, the form will indicate the number is a currency value.

  • OptionalisInteger?: boolean

    If true, the user will not be able to enter a decimal number, only integers are allowed.

  • isSlider: boolean

    If true, the input will display as a slider instead of a numeric input and the sliderIncrement is required.

  • OptionalmaxNumber?: number

    Prevent the user from entering a number more than this number.

    If isInteger is true, this value must also be an integer.

    Must be more than the minNumber if minNumber is set to a number.

  • OptionalminNumber?: number

    Prevent the user from entering a number less than this number.

    If isInteger is true, this value must also be an integer.

    Must be less than the maxNumber if maxNumber is set to a number.

  • OptionalsliderIncrement?: number

    Required if isSlider is true, otherwise must be undefined.

    The increment the slider will go up and down by. Must be greater than 0 and supports decimals.

    If isInteger is true, this value must also be an integer.

  • type: "number"

Settings

Member Visibility