Skip to main content

Deprecations

Nothing on this page has stopped working. Each entry still behaves as it always did, and each one now writes a one-time warning to the browser console pointing at its replacement.

The warnings fire once per element, not once per interaction, so a page with one old attribute produces one line rather than a stream.

Why bother migrating

A deprecated attribute is one that no longer matches how the rest of the attribute surface is spelled, so it is the one most likely to be dropped in a future major version. Migrating now is a rename, not a rebuild.

wf-algolia-reset on a filter item​

Replace with .

The attribute that names a radio group's "All" option was called reset, which reads like the clear-all button it has nothing to do with. Same value, same behaviour, clearer name:

<!-- before -->
<div wf-algolia-element="filter-item" wf-algolia-reset="category">All</div>

<!-- after -->
<div wf-algolia-element="filter-item" wf-algolia-default-option="category">All</div>

The clear-all button is unaffected. wf-algolia-button="reset" is a different attribute and is not deprecated.

Related: a radio group with no default option now warns too. Without one there is no way for a visitor to get back to unfiltered, so add one even if nothing was deprecated on that group. See Radio filters.

wf-algolia-match="numeric-min"​

Replace with and a range-min input on its own.

numeric-min predates open-ended ranges. Now that a range group accepts a minimum without a maximum, the alias has nothing left to do:

<!-- after -->
<div wf-algolia-element="filter-group" wf-algolia-type="range" wf-algolia-field="rating">
  <input wf-algolia-element="range-min" wf-algolia-field="rating" type="number" />
</div>

See Range filters and Comparison filters.

wf-algolia-match values other than or and and​

Replace with or or and.

any and all were offered in earlier documentation but never had a runtime implementation: a group set to either behaved as or. That is now explicit, and any unrecognised value warns and falls back to or.

numeric-min is the one exception, handled above.

wf-algolia-format="currency"​

Replace with plus .

currency hardcoded a $ and two decimal places, which made every other currency in the world impossible to express. The replacement separates the number from its symbol:

<!-- before -->
<div wf-algolia-text="price" wf-algolia-format="currency"></div>

<!-- after -->
<div
  wf-algolia-text="price"
  wf-algolia-format="number"
  wf-algolia-prefix="$"
  wf-algolia-decimals="2"
></div>

Drop if you do not want forced trailing zeros. See Formatting values.

The combined field:value base filter​

Replace with the split and pair.

<!-- before -->
<section wf-algolia-element="browse" wf-algolia-base-filter="category:Shoes"></section>

<!-- after -->
<section
  wf-algolia-element="browse"
  wf-algolia-base-filter-field="category"
  wf-algolia-base-filter-value="Shoes"
></section>

The combined form takes one field and one value and nothing else. The split form is what everything since is built on: comma-separated values, numbered clauses, and the -match and -logic controls. It is also easier to bind to a CMS field, because the value stands alone. See Always-on filters.

The same applies to on a static list.

Removed: the multi-section search engine​

This one is not a deprecation. It is gone.

An undocumented fourth search engine read a wf-algolia-element="results" panel containing section children, and competed with the other engines over the same markup. It was never in the attribute reference, and the Designer extension never built it.

Multi-source dropdowns ride the autocomplete engine instead: one autocomplete-section per index, each with its own . See Query suggestions for the closest worked example, and the Autocomplete Section component for the full attribute list.

If you hand-built a dropdown on the old shape, rebuild it as an autocomplete.