handsontable 0.0.0-next-0a86f7c-20221207 → 0.0.0-next-486680e-20221207

package/helpers/mixed.js

@@ -152,7 +152,7 @@ var domMessages = {
 function _injectProductInfo(key, element) {
   var hasValidType = !isEmpty(key);
   var isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  var hotVersion = "0.0.0-next-0a86f7c-20221207";
+  var hotVersion = "0.0.0-next-486680e-20221207";
   var keyValidityDate;
   var consoleMessageState = 'invalid';
   var domMessageState = 'invalid';

package/helpers/mixed.mjs

@@ -142,7 +142,7 @@ var domMessages = {
 export function _injectProductInfo(key, element) {
   var hasValidType = !isEmpty(key);
   var isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  var hotVersion = "0.0.0-next-0a86f7c-20221207";
+  var hotVersion = "0.0.0-next-486680e-20221207";
   var keyValidityDate;
   var consoleMessageState = 'invalid';
   var domMessageState = 'invalid';

package/package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/handsontable/handsontable/issues"
   },
   "author": "Handsoncode <hello@handsontable.com>",
-  "version": "0.0.0-next-0a86f7c-20221207",
+  "version": "0.0.0-next-486680e-20221207",
   "main": "index",
   "module": "index.mjs",
   "jsnext:main": "index.mjs",

package/pluginHooks.js

@@ -1693,13 +1693,22 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  */
 'beforeStretchingColumnWidth',
 /**
- * Fired by {@link Filters} plugin before applying [filtering](@/guides/columns/column-filter.md).
- * This hook is fired when {@link Options#filters} option is enabled.
+ * Fired by the [`Filters`](@/api/filters.md) plugin,
+ * before a [column filter](@/guides/columns/column-filter.md) gets applied.
+ *
+ * [`beforeFilter`](#beforefilter) takes one argument (`conditionsStack`), which is an array of objects.
+ * Each object represents one of your [column filters](@/api/filters.md#addcondition),
+ * and consists of the following properties:
+ *
+ * | Property     | Possible values                                                         | Description                                                                                                              |
+ * | ------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+ * | `column`     | Number                                                                  | A visual index of the column to which the filter will be applied.                                                        |
+ * | `conditions` | Array of objects                                                        | Each object represents one condition. For details, see [`addCondition()`](@/api/filters.md#addcondition).                |
+ * | `operation`  | `'conjunction'` \| `'disjunction'` \| `'disjunctionWithExtraCondition'` | An operation to perform on your set of `conditions`. For details, see [`addCondition()`](@/api/filters.md#addcondition). |
+ *
+ * An example of the format of the `conditionsStack` argument:
  *
- * @event Hooks#beforeFilter
- * @param {object[]} conditionsStack An array of objects with added formulas.
  * ```js
- * // Example format of the conditionsStack argument:
  * [
  *   {
  *     column: 2,
@@ -1717,17 +1726,47 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  *   },
  * ]
  * ```
- * @returns {boolean} If hook returns `false` value then filtering won't be applied on the UI side (server-side filtering).
+ *
+ * To perform server-side filtering (i.e., to not apply filtering to Handsontable's UI),
+ * set [`beforeFilter`](#beforefilter) to return `false`:
+ *
+ * ```js
+ * new Handsontable(document.getElementById('example'), {
+ *   beforeFilter: (conditionsStack) => {
+ *     return false;
+ *   }
+ * });
+ *```
+ *
+ * Read more:
+ * - [Guides: Column filter](@/guides/columns/column-filter.md)
+ * - [Hooks: `afterFilter`](#afterfilter)
+ * - [Options: `filters`](@/api/options.md#filters)
+ * - [Plugins: `Filters`](@/api/filters.md)
+ * – [Plugin methods: `addCondition()`](@/api/filters.md#addcondition)
+ *
+ * @event Hooks#beforeFilter
+ * @param {object[]} conditionsStack An array of objects with your [column filters](@/api/filters.md#addcondition).
+ * @returns {boolean} To perform server-side filtering (i.e., to not apply filtering to Handsontable's UI), return `false`.
  */
 'beforeFilter',
 /**
- * Fired by {@link Filters} plugin after applying [filtering](@/guides/columns/column-filter.md).
- * This hook is fired when {@link Options#filters} option is enabled.
+ * Fired by the [`Filters`](@/api/filters.md) plugin,
+ * after a [column filter](@/guides/columns/column-filter.md) gets applied.
+ *
+ * [`afterFilter`](#afterfilter) takes one argument (`conditionsStack`), which is an array of objects.
+ * Each object represents one of your [column filters](@/api/filters.md#addcondition),
+ * and consists of the following properties:
+ *
+ * | Property     | Possible values                                                         | Description                                                                                                              |
+ * | ------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+ * | `column`     | Number                                                                  | A visual index of the column to which the filter was applied.                                                            |
+ * | `conditions` | Array of objects                                                        | Each object represents one condition. For details, see [`addCondition()`](@/api/filters.md#addcondition).                |
+ * | `operation`  | `'conjunction'` \| `'disjunction'` \| `'disjunctionWithExtraCondition'` | An operation to perform on your set of `conditions`. For details, see [`addCondition()`](@/api/filters.md#addcondition). |
+ *
+ * An example of the format of the `conditionsStack` argument:
  *
- * @event Hooks#afterFilter
- * @param {object[]} conditionsStack An array of objects with added conditions.
  * ```js
- * // Example format of the conditionsStack argument:
  * [
  *   {
  *     column: 2,
@@ -1745,6 +1784,16 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  *   },
  * ]
  * ```
+ *
+ * Read more:
+ * - [Guides: Column filter](@/guides/columns/column-filter.md)
+ * - [Hooks: `beforeFilter`](#beforefilter)
+ * - [Options: `filters`](@/api/options.md#filters)
+ * - [Plugins: `Filters`](@/api/filters.md)
+ * – [Plugin methods: `addCondition()`](@/api/filters.md#addcondition)
+ *
+ * @event Hooks#afterFilter
+ * @param {object[]} conditionsStack An array of objects with your [column filters](@/api/filters.md#addcondition).
  */
 'afterFilter',
 /**

package/pluginHooks.mjs

@@ -1688,13 +1688,22 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  */
 'beforeStretchingColumnWidth',
 /**
- * Fired by {@link Filters} plugin before applying [filtering](@/guides/columns/column-filter.md).
- * This hook is fired when {@link Options#filters} option is enabled.
+ * Fired by the [`Filters`](@/api/filters.md) plugin,
+ * before a [column filter](@/guides/columns/column-filter.md) gets applied.
+ *
+ * [`beforeFilter`](#beforefilter) takes one argument (`conditionsStack`), which is an array of objects.
+ * Each object represents one of your [column filters](@/api/filters.md#addcondition),
+ * and consists of the following properties:
+ *
+ * | Property     | Possible values                                                         | Description                                                                                                              |
+ * | ------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+ * | `column`     | Number                                                                  | A visual index of the column to which the filter will be applied.                                                        |
+ * | `conditions` | Array of objects                                                        | Each object represents one condition. For details, see [`addCondition()`](@/api/filters.md#addcondition).                |
+ * | `operation`  | `'conjunction'` \| `'disjunction'` \| `'disjunctionWithExtraCondition'` | An operation to perform on your set of `conditions`. For details, see [`addCondition()`](@/api/filters.md#addcondition). |
+ *
+ * An example of the format of the `conditionsStack` argument:
  *
- * @event Hooks#beforeFilter
- * @param {object[]} conditionsStack An array of objects with added formulas.
  * ```js
- * // Example format of the conditionsStack argument:
  * [
  *   {
  *     column: 2,
@@ -1712,17 +1721,47 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  *   },
  * ]
  * ```
- * @returns {boolean} If hook returns `false` value then filtering won't be applied on the UI side (server-side filtering).
+ *
+ * To perform server-side filtering (i.e., to not apply filtering to Handsontable's UI),
+ * set [`beforeFilter`](#beforefilter) to return `false`:
+ *
+ * ```js
+ * new Handsontable(document.getElementById('example'), {
+ *   beforeFilter: (conditionsStack) => {
+ *     return false;
+ *   }
+ * });
+ *```
+ *
+ * Read more:
+ * - [Guides: Column filter](@/guides/columns/column-filter.md)
+ * - [Hooks: `afterFilter`](#afterfilter)
+ * - [Options: `filters`](@/api/options.md#filters)
+ * - [Plugins: `Filters`](@/api/filters.md)
+ * – [Plugin methods: `addCondition()`](@/api/filters.md#addcondition)
+ *
+ * @event Hooks#beforeFilter
+ * @param {object[]} conditionsStack An array of objects with your [column filters](@/api/filters.md#addcondition).
+ * @returns {boolean} To perform server-side filtering (i.e., to not apply filtering to Handsontable's UI), return `false`.
  */
 'beforeFilter',
 /**
- * Fired by {@link Filters} plugin after applying [filtering](@/guides/columns/column-filter.md).
- * This hook is fired when {@link Options#filters} option is enabled.
+ * Fired by the [`Filters`](@/api/filters.md) plugin,
+ * after a [column filter](@/guides/columns/column-filter.md) gets applied.
+ *
+ * [`afterFilter`](#afterfilter) takes one argument (`conditionsStack`), which is an array of objects.
+ * Each object represents one of your [column filters](@/api/filters.md#addcondition),
+ * and consists of the following properties:
+ *
+ * | Property     | Possible values                                                         | Description                                                                                                              |
+ * | ------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+ * | `column`     | Number                                                                  | A visual index of the column to which the filter was applied.                                                            |
+ * | `conditions` | Array of objects                                                        | Each object represents one condition. For details, see [`addCondition()`](@/api/filters.md#addcondition).                |
+ * | `operation`  | `'conjunction'` \| `'disjunction'` \| `'disjunctionWithExtraCondition'` | An operation to perform on your set of `conditions`. For details, see [`addCondition()`](@/api/filters.md#addcondition). |
+ *
+ * An example of the format of the `conditionsStack` argument:
  *
- * @event Hooks#afterFilter
- * @param {object[]} conditionsStack An array of objects with added conditions.
  * ```js
- * // Example format of the conditionsStack argument:
  * [
  *   {
  *     column: 2,
@@ -1740,6 +1779,16 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  *   },
  * ]
  * ```
+ *
+ * Read more:
+ * - [Guides: Column filter](@/guides/columns/column-filter.md)
+ * - [Hooks: `beforeFilter`](#beforefilter)
+ * - [Options: `filters`](@/api/options.md#filters)
+ * - [Plugins: `Filters`](@/api/filters.md)
+ * – [Plugin methods: `addCondition()`](@/api/filters.md#addcondition)
+ *
+ * @event Hooks#afterFilter
+ * @param {object[]} conditionsStack An array of objects with your [column filters](@/api/filters.md#addcondition).
  */
 'afterFilter',
 /**