Skip to content

ScopeGroup ​

Overview ​

Renders a list's active scopes as a strip of ScopeChips, plus a Clear scopes control when more than one clearable scope is active. A scope is a list constraint supplied by a link or by application code that has no editable input: the chips describe it and offer removal, and the add-filter menu never offers it. The scope-side counterpart to FilterGroup's chips.

Presentational only: the group reports which scopes the reader asked to clear, and the host removes their values.

Theme entry: ScopeGroup

Props ​

NameTypeRequiredDefaultDescription
themeOverrideObjectnullA partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
scopesarray[]Active scopes, each { name, label, keys, source, clearable }; name and source together identify a scope.
hostedbooleanfalseWhen true, the chips render as a bare subgroup (no band chrome) for hosting inside a shared ConstraintsBar. When false (default), the chips render as a self-contained strip.

Slots ​

NameScopedDescription
scope-chipyesReplaces one whole scope chip. Slot props: scope, and clear(), which asks to clear that scope when it is clearable.
scope-labelyesReplaces a scope chip's label text, keeping the chip and its clear control. Slot props: scope.

Full slot reference

Events ​

NameDescription
clearEmitted with the array of scope objects the reader asked to clear: one from a chip, every clearable scope from Clear scopes.

Full event reference

Source ​

client/lib/display/scope/ScopeGroup.vue