Options Filter

The Options Filter allows searching based on a set of populated options.

Configure options

To set up an Options, go to Design, select a list filter element, click the element to open the general settings, go to the Type field, and select Options.

When you select Options, you will see the following properties from the element available for configuration:

  • Display Type: Define how the filter should be presented to users.
    • Auto Complete
    • Multi-Select Box
    • Select Box
    • Text Field
Performance Warning
When any of the AutoComplete, Multiple Select Box, or Select Box types are selected, all possible select options will be loaded on the page load. However, if you have thousands of select options or source them from the Options Data Store, this may cause a significant increase in page load time.
  • Size (Multi-Select Box): Control the height of the filter when Display Type is set to Multi-Select Box.
  • Default Value: Default filter value.
  • Options: Options available for filter search.

    Foreign Key

    If your column stores the foreign key to another form table, you can utilize this Options Filter and set the Options Data Store (i.e., Default Form Options Data Store) so that you can search by using the label column configured.
    • Value: Option Value
    • Label: Option Label
    • Grouping: Option Grouping Value.
  • Or Load Data From:
    Options are to be populated dynamically using the Options Data Store plugin.
    Available Options Data Stores:

Configuring any options Data Store here will ignore 'Options' property values (if any).

Performance Warning
If you have many select options or source them from the Options Data Store, this may significantly increase page load time. You may consider using the grouping attribute below to load the required options selectively.
  • Field ID to control available options based on Grouping: Dynamically change the available options based on the grouping attribute defined in the options by matching the current value of the element ID defined.
Created by Julieth Last modified by Aadrian on Dec 13, 2024