Open Pioneer Trails Packages
    Preparing search index...

    Configuration for a number field.

    Renders a numeric input that stores a number value in the feature property. Supports validation constraints (min/max), precision control, and optional stepper buttons for incrementing/ decrementing the value.

    interface NumberFieldConfig {
        errorText?: PropertyFunctionOr<string | undefined>;
        formatOptions?: NumberFormatOptions;
        helperText?: PropertyFunctionOr<string | undefined>;
        isEnabled?: PropertyFunctionOr<boolean>;
        isRequired?: PropertyFunctionOr<boolean>;
        isValid?: PropertyFunctionOr<boolean>;
        isVisible?: PropertyFunctionOr<boolean>;
        label: string;
        max?: number;
        min?: number;
        placeholder?: string;
        propertyName: string;
        showSteppers?: boolean;
        step?: number;
        type: "number-field";
    }

    Hierarchy

    • BaseFieldConfig
      • NumberFieldConfig
    Index

    Properties

    errorText?: PropertyFunctionOr<string | undefined>

    Error message to display when the field is invalid.

    Shown below the field when isValid is false. Can be a function to provide dynamic error messages based on the validation context.

    formatOptions?: NumberFormatOptions

    Options for formatting the number value for display.

    Accepts any standard Intl.NumberFormatOptions such as minimumFractionDigits, maximumFractionDigits, style, currency, etc. Use this to control how the number is displayed to the user (e.g., as currency, percentage, or with specific decimal places).

    helperText?: PropertyFunctionOr<string | undefined>

    Helper text to guide the user.

    Shown below the field to provide additional context or instructions. Can be a function to provide dynamic help text based on the field's state.

    isEnabled?: PropertyFunctionOr<boolean>

    Whether the field is enabled for user input.

    When false, the field is disabled and the user cannot modify its value. Can be a function to enable/disable the field dynamically based on other properties.

    true
    
    isRequired?: PropertyFunctionOr<boolean>

    Whether the field is required.

    When true, displays a required indicator and validates that the field has a value. Can be a function to determine required status dynamically based on other properties.

    false
    
    isValid?: PropertyFunctionOr<boolean>

    Whether the field's current value is valid.

    When false, displays the field in an error state and shows the error text if provided. Can be a function to validate the field dynamically based on its value and other properties.

    true
    
    isVisible?: PropertyFunctionOr<boolean>

    Whether the field is visible in the form.

    When false, the field is completely hidden. Can be a function to show/hide the field dynamically based on other properties.

    true
    
    label: string

    The display label shown for the field.

    Displayed above the input control to indicate what the field represents.

    max?: number

    Maximum allowed value. Values above this will be rejected.

    min?: number

    Minimum allowed value. Values below this will be rejected.

    placeholder?: string

    Placeholder text shown when the field is empty.

    Defaults to the field's BaseFieldConfig.label. Use an empty string to display no placeholder.

    propertyName: string

    The name of the feature property this field edits.

    Used to read and write the field's value from the feature's properties. Must match the property name on the feature being edited.

    showSteppers?: boolean

    Whether to show increment/decrement stepper buttons.

    When true, displays arrow buttons allowing the user to increment or decrement the value by the configured step size.

    false
    
    step?: number

    Increment/decrement step size when using stepper buttons.

    Determines how much the value changes when clicking the up/down arrows (if steppers are enabled).

    type: "number-field"

    Identifies this as a number field.