Open Pioneer Trails Packages
    Preparing search index...

    Type Alias SelectConfig

    SelectConfig: {
        errorText?: PropertyFunctionOr<string | undefined>;
        helperText?: PropertyFunctionOr<string | undefined>;
        isEnabled?: PropertyFunctionOr<boolean>;
        isRequired?: PropertyFunctionOr<boolean>;
        isValid?: PropertyFunctionOr<boolean>;
        isVisible?: PropertyFunctionOr<boolean>;
        label: string;
        placeholder?: string;
        propertyName: string;
        showClearTrigger?: boolean;
        type: "select";
    } & (
        | { options: Option<string>[]; valueType: "string" }
        | { options: Option<number>[]; valueType: "number" }
    )

    Configuration for a select field.

    Renders a dropdown select input that allows users to choose from a list of predefined options. The field can store either string or number values depending on the valueType property.

    Type Declaration

    • Optional ReadonlyerrorText?: 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.

    • Optional ReadonlyhelperText?: 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.

    • Optional ReadonlyisEnabled?: 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
    • Optional ReadonlyisRequired?: 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
    • Optional ReadonlyisValid?: 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
    • Optional ReadonlyisVisible?: 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
    • Readonlylabel: string

      The display label shown for the field.

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

    • Optional Readonlyplaceholder?: string

      Placeholder text shown when the field is empty.

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

    • ReadonlypropertyName: 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.

    • Optional ReadonlyshowClearTrigger?: boolean

      Whether to show a button to clear the current selection.

      When true, displays a clear button that allows users to reset the field value to undefined. Defaults to true for optional fields and false for required fields.

      !isRequired
    • Readonlytype: "select"

      Identifies this as a select field.

    • { options: Option<string>[]; valueType: "string" }
      • Readonlyoptions: Option<string>[]

        Array of available options for the field.

      • ReadonlyvalueType: "string"

        Indicates that option values are strings.

    • { options: Option<number>[]; valueType: "number" }
      • Readonlyoptions: Option<number>[]

        Array of available options for the field.

      • ReadonlyvalueType: "number"

        Indicates that option values are numbers.

    Settings

    Member Visibility