feat: allow disabling selected item events

src/hooks/useMultipleSelection/README.md

@@ -587,6 +587,10 @@ It is required to pass either `selectedItem` or `index` to
 
 Optional properties:
 
+- `disabled`: If this is set to true, then no event handlers will be returned
+  from `getSelectedItemProps` and a `disabled` prop will be returned
+  (effectively disabling `Delete` and `Backspace` keys events).
+
 - `ref`: if you need to access the dropdown element via a ref object, you'd call
   the function like this: `getDropdown({ref: yourDropdownRef})`. As a result,
   the dropdown element will receive a composed `ref` property, which guarantees

src/hooks/useMultipleSelection/__tests__/getSelectedItemProps.test.js

@@ -32,6 +32,20 @@ describe('getSelectedItemProps', () => {
 
       expect(itemProps.tabIndex).toEqual(0)
     })
+
+    test("handlers are not called if it's disabled", () => {
+      const {result} = renderUseMultipleSelection()
+      const itemProps = result.current.getSelectedItemProps({
+        disabled: true,
+        index: 0,
+        selectedItem: items[0],
+      })
+
+      expect(itemProps.onChange).toBeUndefined()
+      expect(itemProps.onKeyDown).toBeUndefined()
+      expect(itemProps.onBlur).toBeUndefined()
+      expect(itemProps.disabled).toBe(true)
+    })
   })
 
   describe('user props', () => {

src/hooks/useMultipleSelection/index.js

@@ -190,8 +190,10 @@ function useMultipleSelection(userProps = {}) {
           }
         }),
         tabIndex: index === latestState.activeIndex ? 0 : -1,
-        onClick: callAllEventHandlers(onClick, selectedItemHandleClick),
-        onKeyDown: callAllEventHandlers(onKeyDown, selectedItemHandleKeyDown),
+        ...(!rest.disabled && {
+          onClick: callAllEventHandlers(onClick, selectedItemHandleClick),
+          onKeyDown: callAllEventHandlers(onKeyDown, selectedItemHandleKeyDown),
+        }),
         ...rest,
       }
     },

typings/index.d.ts

@@ -639,6 +639,7 @@ export interface A11yRemovalMessage<Item> {
 export interface UseMultipleSelectionGetSelectedItemPropsOptions<Item>
   extends React.HTMLProps<HTMLElement>,
     GetPropsWithRefKey {
+  disabled?: boolean
   index?: number
   selectedItem: Item
 }