Open Pioneer Trails Packages
    Preparing search index...

    Configuration for a color picker field.

    Renders a color picker input that stores a color value (in hexadecimal format) in the feature property. Includes an optional swatch palette for quick color selection.

    interface ColorPickerConfig {
        errorText?: PropertyFunctionOr<string | undefined>;
        helperText?: PropertyFunctionOr<string | undefined>;
        isEnabled?: PropertyFunctionOr<boolean>;
        isRequired?: PropertyFunctionOr<boolean>;
        isValid?: PropertyFunctionOr<boolean>;
        isVisible?: PropertyFunctionOr<boolean>;
        label: string;
        propertyName: string;
        swatchColors?: string[];
        type: "color-picker";
    }

    Hierarchy

    • BaseFieldConfig
      • ColorPickerConfig
    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.

    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.

    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.

    swatchColors?: string[]

    Optional array of predefined colors to display as swatches.

    Colors should be specified as hex strings (e.g., "#ff0000" for red). When provided (and not empty), displays a swatch palette allowing users to quickly select from these colors.

    type: "color-picker"

    Identifies this as a color picker field.