From 4c55ad8c644f32fd4463a69a96ebf107d0c36120 Mon Sep 17 00:00:00 2001
From: Tom Southall <tsouthall@gmail.com>
Date: Tue, 15 Mar 2022 12:42:30 +0000
Subject: [PATCH] Pass the highlighted state to custom Item component

---
 README.md                   | 5 ++++-
 src/lib/components/item.jsx | 1 +
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ba1e0e1..341fd05 100644
--- a/README.md
+++ b/README.md
@@ -477,7 +477,9 @@ in order to exit the focused state of the search box.
   - `containerFocus`** Note that `container` and `containerFocus` are mutually exclusive. Only one or the other applies depending on whether the search box `<input>` has focus. If the styling of the outer container is to change when the search box receives focus, specify styles for `containerFocus`. If nothing is specified for `containerFocus` the styles for `container` are applied whether or not the search box has focus.
   - **`input`** Applies to the search box `<input>` element as well as the typeahead `<input>`. As the typeahead is positioned directly beneath the search box, these must be styled almost identically.
   - **`inputFocus`** Applies to the search box `<input>` element as well as the typeahead `<input>`, only when the search box has focus. Note that `input` and `inputFocus` are mutually exclusive. Only one or the other applies depending on whether the search box `<input>` has focus. If nothing is specified for `inputFocus` the styles for `input` are applied whether or not the search box has focus.
-  - **`query`** For styles applying *only* to the search box `<input>` element and *not* the typeahead element beneath. A valid example is example text colour. Note that this element already has the following styles applied which cannot be overridden: `position: relative; z-index: 1; background-color: transparent;`.
+  - **`query`** For styles applying *only* to the search box `<input>` element and *not* the typeahead element beneath. A valid example is example text colour. Note that this element already has the following styles applied which cannot be overridden:
+    - When typeahead is visible `position: relative; z-index: 1; background-color: transparent;`
+    - When typeahead is not visible `position: relative;`
   - **`typeahead`** For styles applying *only* to the typeahead `<input>` element and *not* the search box element above. A valid example is example text colour. Note that this element already has the following styles applied which cannot be overridden: `position: absolute; z-index: 0; top: 0; left: 0;`.
   - **`cancelButton`** A `<button>` element. This is only rendered when the search box has focus. Note that this element already has the following styles applied which cannot be overridden: `z-index: 3`. You may wish only to display this at mobile screen widths.
   - **`clearButton`** A `<button>` element. This is only rendered when the search box contains text. Note that this element already has the following styles applied which cannot be overridden: `z-index: 2`.
@@ -530,6 +532,7 @@ The following custom components can also be supplied as props:
   - **`groupIndex`** (number) The index of the group. Matches the order supplied in the `listbox` or `defaultListbox` prop. Zero-indexed.
   - **`groupName`** (string) The `name` of the group supplied in the `listbox` or `defaultListbox` prop.
   - **`index`** (number) The index of the item within the listbox. Zero-indexed. This allows you to style, say, the first item differently to all the rest in the listbox.
+  - **`isHighlighted`** (boolean) If `true` indicates that the item is currently in a highlighted state
   - **`item`** The item in the same format as supplied by the `listbox` or `defaultListbox` prop.
   - **`query`** The text currently entered in the search box. This can be used to show matched text in the item.
   - **`searchType`** (string) Either `"startswith"` or `"contains"`. Indicates how the item was matched to the query.
diff --git a/src/lib/components/item.jsx b/src/lib/components/item.jsx
index ca05209..e0e2e4e 100644
--- a/src/lib/components/item.jsx
+++ b/src/lib/components/item.jsx
@@ -41,6 +41,7 @@ export default function Item(props) {
         groupIndex={item.groupIndex}
         groupName={item.groupName}
         index={index}
+        isHighlighted={isHighlighted}
         item={item.value}
         query={query}
         searchType={item.searchType}