--- title: "Query Filter" slug: query-filter category: component type: overview version: 20.0.0 tokens: 685 source: https://ovh.github.io/design-system/v20.0.0/llms/react-components-query-filter.txt --- # Query Filter ## Props | Property | Type | Required | Default | Description | |---|---|---|---|---| | `allowCustomValue` | `boolean` | No | undefined | Whether to allow adding a custom filter. | | `defaultOpen` | `boolean` | No | undefined | The initial open state of the query filter. Use when you don't need to control the open state of the query filter. | | `defaultValue` | `string[][]` | No | undefined | The initial selected value(s). Use when you don't need to control the selected value(s) of the query filter. | | `disabled` | `boolean` | No | undefined | Whether the component is disabled. | | `filterOption` | `QueryFilterOption` | Yes | undefined | The property filter options (operator and value). | | `filterProperty` | `QueryFilterGroup` | Yes | undefined | The properties that may be used as a filter. | | `highlightResults` | `boolean` | No | undefined | Whether to highlight the matching part of filtered items. | | `i18n` | `Partial` | No | undefined | Internal translations override (see Input i18n keys). | | `invalid` | `boolean` | No | undefined | Whether the component is in error state. | | `locale` | `'fr' | 'de' | 'en' | 'es' | 'it' | 'nl' | 'pl' | 'pt'` | No | undefined | The locale used for the translation of the internal elements. | | `name` | `string` | No | undefined | The name of the form element. Useful for form submission. | | `newElementLabel` | `string` | No | undefined | Label displayed in front of a custom filter to add. | | `noResultLabel` | `string` | No | undefined | Label displayed when no values match the current input value. | | `onInputValueChange` | `(value: QueryFilterInputValueChangeDetails) => void` | No | undefined | Callback fired when the input value changes. | | `onOpenChange` | `(detail: QueryFilterOpenChangeDetail) => void` | No | undefined | Callback fired when the query filter open state changes. | | `onValueChange` | `(value: QueryFilterValueChangeDetails) => void` | No | undefined | Callback fired when the value(s) changes. | | `open` | `boolean` | No | undefined | The controlled open state of the query filter. | | `overlayConfig` | `object` | No | undefined | The overlay configuration. | | `readOnly` | `boolean` | No | undefined | Whether the component is readonly. | | `required` | `boolean` | No | undefined | Whether the component is required. | | `value` | `string[][]` | No | undefined | The controlled selected value(s). | ## Examples - Default - Accessibility Form Field - Accessibility Aria Label ## Documentation pages - [Documentation](./react-components-query-filter--documentation.txt) - [Technical Information](./react-components-query-filter--technical-information.txt) - [Examples](./react-components-query-filter--examples.txt)