@ebay/ui-core-react/ebay-filter-menu/README.md

Skin components build off React

# EbayFilterMenu

## Demo

[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/docs/building-blocks-ebay-filter-menu--docs)

## Usage

### Import JS

```jsx harmony
import { EbayFilterMenu, EbayFilterMenuItem, EbayFilterMenuFooterButton } from "@ebay/ui-core-react/ebay-filter-menu";
```

### Import following styles from SKIN

```jsx harmony
import "@ebay/skin/filter-menu";
```

### If tokens haven't been added to the project at a higher level, make sure to import

```jsx harmony
import "@ebay/skin/tokens";
```

### Or import styles using SCSS/CSS

```jsx harmony
import "@ebay/skin/filter-menu.css";
```

```jsx harmony
<EbayFilterMenu>
    <EbayFilterMenuItem value="item1">Item 1</EbayFilterMenuItem>
    <EbayFilterMenuItem value="item2">Item 2</EbayFilterMenuItem>
    <EbayFilterMenuFooterButton>Submit</EbayFilterMenuFooterButton>
</EbayFilterMenu>
```

## Attributes

| Name                          | Type     | Required | Description                                                | Data                                        |
| ----------------------------- | -------- | -------- | ---------------------------------------------------------- | ------------------------------------------- |
| `classPrefix`                 | String   | No       | Modifies the base prefix for all Skin classes in the menu  | `"filter-menu"` (default)                   |
| `formName`                    | String   | No       | Name attribute for the form                                |                                             |
| `formAction`                  | String   | No       | Action attribute for the form                              |                                             |
| `formMethod`                  | String   | No       | Method attribute for the form                              |                                             |
| `variant`                     | String   | No       | Variant of the filter menu, `form` or `default`            |                                             |
| `type`                        | String   | No       | Type of the filter menu, `checkbox` or `radio`             |                                             |
| `searchHeaderValue`           | String   | No       | Optional value override for the input in the search header |                                             |
| `searchHeaderPlaceholderText` | String   | No       | Enables the search header and populates placeholder text   |                                             |
| `a11ySearchHeaderClearText`   | String   | No       | Accessibility text for the search header clear button      |                                             |
| `onFormSubmit`                | Function | No       | Triggered on form submit                                   | `(event: Event, { checked, checkedIndex })` |
| `onFooterClick`               | Function | No       | Triggered on footer button click                           | `(event: Event, { checked, checkedIndex })` |
| `onChange`                    | Function | No       | Triggered on item change                                   | `(event: Event, { checked, checkedIndex })` |
| `onSearchChange`              | Function | No       | Triggered on search input change                           | `(event: Event, { searchTerm })`            |