feat: add transformItems to all widgets

content/widgets/breadcrumb.md

@@ -40,4 +40,6 @@ options:
     description: Separator used in the attributes to separate level values
   - name: rootPath
     description: Prefix path to use if the first level is not the root level.
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/clear-refinements.md

@@ -27,4 +27,6 @@ options:
   - name: clearsQuery
     default: false
     description: Also clears the query
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/current-refinements.md

@@ -47,4 +47,6 @@ options:
   - name: clearsQuery
     default: false
     description: The clear all button also clears the query
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/geo-search.md

@@ -93,4 +93,6 @@ options:
     description: Maximum radius to search around the position
   - name: precision
     description: Precision of geo search
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/hierarchical-menu.md

@@ -168,4 +168,6 @@ options:
     description: Show the siblings of the selected parent level of the current refined value. This does not impact the root level.
   - name: sortBy
     description: array or function to sort the results by
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/hits-per-page.md

@@ -18,4 +18,6 @@ classes:
 options:
   - name: items
     description: Array of objects with the value, the label and a boolean "default" which decides which item to select by default
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/hits.md

@@ -37,4 +37,7 @@ classes:
     description: the list of results
   - name: .ais-Hits-item
     description: the hit list item
+options:
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/infinite-hits.md

@@ -73,4 +73,7 @@ classes:
     description: the button used to display more results
   - name: .ais-InfiniteHits-loadMore--disabled
     description: the disabled button used to display more results
+options:
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/menu-select.md

@@ -25,4 +25,6 @@ options:
     description: Number of items to show
   - name: sortBy
     description: array or function to sort the results by
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/menu.md

@@ -127,4 +127,6 @@ options:
     description: Whether or not to have the option to load more values
   - name: sortBy
     description: array or function to sort the results by
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/numeric-menu.md

@@ -40,4 +40,6 @@ options:
     description: Attribute to apply the filter to
   - name: items
     description: Array of objects with a label, start and end value. Start and end can individually be left as undefined to only apply a single bound
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/numeric-selector.md

@@ -15,4 +15,7 @@ classes:
     description: the select
   - name: .ais-NumericSelector-option
     description: the select options
+options:
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/pagination.md

@@ -73,4 +73,6 @@ options:
   - name: showPrevious
     default: true
     description: Whether to show the "previous page" control
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/rating-menu.md

@@ -73,4 +73,6 @@ options:
     description: Attribute to apply the filter to
   - name: max
     description: Maximum number of (stars) to display
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/refinement-list.md

@@ -136,4 +136,6 @@ options:
     description: Whether or not to have the option to load more values
   - name: sortBy
     description: array or function to sort the results by
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/sort-by.md

@@ -18,4 +18,6 @@ classes:
 options:
   - name: items
     description: Array of objects with value (the index to search on) and a label
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---

content/widgets/stats.md

@@ -11,4 +11,7 @@ classes:
   - name: .ais-Stats-text
     description: the text of the widget
     description: the count of items for each item
+options:
+  - name: transformItems
+  description: Function which receives the items, which will be called before displaying them. Should return a new array with the same shape as the original array. Useful for mapping over the items to transform, remove or reorder them
 ---