Skip to main content

Checkbox List Facet

Checkbox List Facet is a multi-select option list. It sends all selected option values for the configured target and argument mode.

Authoring Structure

Checkbox List Facet
└── Checkbox List Facet Option

Parent Props

GroupPropDefaultMeaning
SettingstargetemptyShared target ID.
Settingsargument_modedefaultSingle argument mode.
Settingstarget_multiple_query_argumentsfalseEnables mapped bundle mode.
Settingsoptions_behaviorallAvailability behavior.
Settingsshow_countsfalseEnables dynamic counts.
Settingsaria_labelFilter optionsAccessible name for the checkbox group.
Mode groupsmode-specific propsvariesSee Argument Modes.
Stylingclassome-checkbox-list-facet-root-defaultRoot list class.

Option Props

GroupPropDefaultMeaning
ContentvalueemptySent value in single-argument mode.
ContentlabelOptionVisible label.
Metadatakey, valueemptyOptional rows for custom JavaScript integrations.
Query Value Mappingsmapping_key, valueemptyValues used when parent mapped bundle mode is enabled.
SettingsdisabledfalsePrevents selection.
Settingsis_defaultfalsePreselects the option when no restored value exists.
SettingsmodecheckboxOption presentation: checkbox or button.
Settingsused_with_multiple_argumentsfalseSwitches option authoring to query value mappings.
Settingscount_displayinlineInline count text or separate count span.
Stylingoption, button, indicator, tick, label, input, count classescomponent defaultsOption presentation classes.

Runtime Notes

  • Multiple options can be selected at the same time.
  • mode = button changes presentation only; the facet remains multi-select.
  • The runtime syncs data-ome-selected-values, hidden transport inputs, aria-checked, disabled state, hidden state, and count displays.

Example

Checkbox List Facet:
- target = posts
- argument_mode = default
- facet_key = name

Options:
- beta-bar
- gamma-baz