# Button Filter

Button path filter is used to show or hide HTML elements depending on their path and user selection.

```markup
<a 
    href="#"  
    data-grid-control="button-filter" 
    data-path=".red">Red</a>
```

It also can be a button:

```markup
<button 
    type="button" 
    data-grid-control="button-filter" 
    data-path=".red">Red</button>
```

| Data Attribute    | Value                   | Description                                                                                        | Required |
| ----------------- | ----------------------- | -------------------------------------------------------------------------------------------------- | -------- |
| data-grid-control | button-filter           | This attribute defines the control type.                                                           | Required |
| data-path         | any CSS selector        | It defines the path to the item that should be filtered.                                           | Optional |
| data-inverted     | false (default), true   | This attribute inverts the filter.                                                                 | Optional |
| data-id           | any alphanumeric string | <p>This attribute may be used in the deep-link, </p><p>local storage, or complex filter logic.</p> | Optional |
| data-checked      | false (default), true   | <p>Indicate whether or not </p><p>this button should be checked by default.</p>                    | Optional |

If the **`data-value`** attribute is specified, the filter will look for this text value in the provided **`data-path`**. In this case, the following data attributes may be specified:

| Data Attribute | Value                                                                        | Description                                                                                           | Required |
| -------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------- |
| data-value     | any text                                                                     | <p>The filter will look for this text </p><p>in the given <strong><code>data-path</code></strong></p> | Optional |
| data-mode      | <ul><li>contains</li><li>startsWith</li><li>endsWith</li><li>equal</li></ul> | Filter mode. The default value is "**equal**".                                                        | Optional |
| data-skip      | \[^a-zA-Z0-9]+                                                               | <p>Defines a regex of characters </p><p>that should be skipped.</p>                                   | Optional |

If the button is checked, it has **`dg-checked`** CSS class. This way it's possible to add styles to the selected button:

```css
.dg-checked{
    color: red;
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.getdatagrid.com/controls/button-path-filter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.