Display Filters

The displayFilters property controls which properties appear in the editor panels when Wix users select your component. Use it to hide properties that your component uses internally but that Wix users shouldn't edit, or to show only relevant properties for a specific preset or state.

You can define displayFilters in:

If multiple levels define filters, the editor applies them in order: element filters first, then preset filters, then state filters. Only items that pass every applicable filter appear in the editor.

Note: Display groups and display filters operate independently. Display filters remove properties before the editor panel receives them. Display groups organize whatever properties remain.

Supported filter keys

Each key corresponds to a section in your manifest. Use hide or show (not both) to control which items from that section appear in the editor. If you don't define a display filter for a category, no filter is applied.

  • hide: The editor shows all items except those in the list.
  • show: The editor shows only the items in the list, everything else is hidden.

Note: Specify only one of hide or show in a single display filter.

dataDisplayFilter

Filter keys from your data map.


cssPropertiesDisplayFilter

Filter keys from your cssProperties map.


cssCustomPropertiesDisplayFilter

Filter keys from your cssCustomProperties map.


elementsDisplayFilter

Filter keys from your elements map.


customActionsDisplayFilter

Filter keys from your customActions map.


actionsDisplayFilter

Filter built-in editor actions. Use the predefined action names listed below.


statesDisplayFilter

Filter keys from your states map.

Examples

Element and preset filters

The following uses both hide and show across levels. At the component level, the component hides the data property internalId. The 'compact' preset then uses show to restrict the visible data properties to just title and icon. When you select that preset, only those two appear in the editor; the editor hides subtitle and any other data properties.

Copy

All supported filter keys

The following shows displayFilters with all supported keys configured.

Copy

See also

Did this help?