Update dependency downshift to v8 #339

renovate · 2023-07-17T14:22:25Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
downshift (source)	`^6.1.12` -> `^8.2.2`

Release Notes

downshift-js/downshift (downshift)

`v8.2.2`

Compare Source

Bug Fixes

typescript: add onPress to toggle button props parameter (#1548) (fd6ab68)

`v8.2.1`

Compare Source

Bug Fixes

defaultProps: use undefined environment on React Native (#1546) (7d8c32d)
useSelect: preventDefault on item props onMouseDown (b24f2e6)
useSelect: preventDefault on item props onMouseDown (#1547) (05ffa9c)

`v8.2.0`

Compare Source

Features

update dependencies and react to v18 (#1538) (9828365)

`v8.1.1`

Compare Source

Bug Fixes

typescript: missing generic parameter of React.RefObject (#1536) (bc7639c)

`v8.1.0`

Compare Source

Features

useSelect: focus toggle when opened initially (#1527) (90d6d72)

`v8.0.2`

Compare Source

Bug Fixes

types: remove GestureResponderEvent (#1524) (883a458)

`v8.0.1`

Compare Source

Bug Fixes

useCombobox: initial focus behaviour (#1526) (cae0884)

`v8.0.0`

Compare Source

Features

v8 (#1509) (b62fe05)

BREAKING CHANGES

Release Downshift v8.

PRs included:

https://github.com/downshift-js/downshift/pull/1440
https://github.com/downshift-js/downshift/pull/1445
https://github.com/downshift-js/downshift/pull/1463
https://github.com/downshift-js/downshift/pull/1510
https://github.com/downshift-js/downshift/pull/1482

Changes

These changes will also be covered in the V8 migration guide.

isItemDisabled

Both useCombobox and useSelect now support the isItemDisabled function. This new API is used to mark menu items as disabled, and as such remove the from the navigation and prevent them from being selected. The old API required passing the disabled prop to the getItemProps function. This old API has been removed and you will receive a console warning if you are trying to use the disabled prop in getItemProps.

Example of API migration:

Old:

const items = [{value: 'item1'}, {value: 'item2'}]

const {getInputProps, ...rest} = useCombobox({items})

return (
  // ... rest
  <li {...getItemProps({item, disabled: item.value === 'item2'})}>
)

New:

const items = [{value: 'item1'}, {value: 'item2'}]

const {getInputProps, ...rest} = useCombobox({items, isItemDisabled(item, _index) { return item.value === 'item2' }})

return (
  // ... rest
  <li {...getItemProps({item})}>
)

The API for Downshift remains unchange.

useCombobox input click

ARIA 1.2 recommends to toggle the menu open state at input click. Previously, in v7, the menu was opened on receiving focus, from both mouse and keyboard. Starting with v8, input focus will not trigger any state change anymore. Only the input click event will be handled and will trigger a menu toggle. Consequently:

getInputProps will not return any Focus event handler.
getInputProps will return a Click event handler.
useCombobox.stateChangeTypes.InputFocus has been removed.
useCombobox.stateChangeTypes.InputClick has been added instead.

We recommend having the default toggle on input click behaviour as it's part of the official ARIA combobox 1.2 spec, but if you wish to override it and not toggle the menu on click, use the stateReducer:

function stateReducer(state, actionAndChanges) {
  const {changes, type} = actionAndChanges
  switch (type) {
    case useCombobox.stateChangeTypes.InputClick:
      return {
        ...changes,
        isOpen: state.isOpen, // do not toggle the menu when input is clicked.
      }
    default:
      return changes
  }
}

If you want to return to the v7 behaviour and open the menu on focus, keep the reducer above so you remove the toggle behaviour, and call the openMenu imperative function, returned by useCombobox, in a onFocus handler passed to
getInputProps:

<input
  {...getInputProps({
    onFocus() {
      openMenu()
    },
  })}
/>

Consider to use the default 1.2 ARIA behaviour provided by default in order to align your widget to the accessibility official spec. This behaviour consistency improves the user experience, since all comboboxes should behave the same and
there won't be need for any additional guess work done by your users.

Getter props return value types

Previously, the return value from the getter props returned by both Downshift and the hooks was any. In v8 we improved the types in order to reflect what is actually returned: the default values return by the getter prop function and
whatever else the user passes as arguments. The type changes are done in this PR, make sure you adapt your TS code, if applicable.

Also, in the Downshift component, the return values for some getter prop values have changed from null to undefined, since that is what HTML elements expect (value or undefined). These values are also reflected in the TS types.

getRootProps: 'aria-owns': isOpen ? this.menuId : ~~null~~undefined,
getInputProps:
- 'aria-controls': isOpen ? this.menuId : ~~null~~undefined
- 'aria-activedescendant': isOpen && typeof highlightedIndex === 'number' &&
  highlightedIndex >= 0 ? this.getItemId(highlightedIndex) : ~~null~~undefined
getMenuProps: props && props['aria-label'] ? ~~null~~undefined : this.labelId,

environment propTypes

The environment prop is useful when you are using downshift in a context
different than regular DOM. Its TS type has been updated to contain Node and
the propTypes have also been updated to reflect the properties which are
required by downshift from environment.

`v7.6.2`

Compare Source

Bug Fixes

useCombobox: exhaustive deps for getInputProps (#1518) (57f8690)

`v7.6.1`

Compare Source

Bug Fixes

useCombobox: tab to body should select element (#1517) (1730fbe)

Bug Fixes

useCombobox: Ensure highlighted index is not selected on browser tab change (#1484) (4ff1385), closes #1471

`v7.4.0`

Compare Source

Features

useCombobox: selectedItemChanged support (#1480) (9b3199a)

`v7.3.4`

Compare Source

Bug Fixes

defaultProps: only select if there are items and one is highlighted (#1467) (108c1ba)

`v7.3.3`

Compare Source

Bug Fixes

hooks: correctly compute item and index in getter function (#1473) (7471fba)

`v7.3.2`

Compare Source

Bug Fixes

useCombobox: controlled selectedItem extra renders (#1477) (c6c0af5)

`v7.3.1`

Compare Source

Bug Fixes

useMultipleSelection: do not crash in react native (#1479) (8c903c3)

`v7.3.0`

Compare Source

Features

useSelect: react native handlers (#1476) (e97c368)

`v7.2.2`

Compare Source

Bug Fixes

useCombobox: use environment instead of document (#1478) (4566580)

`v7.2.1`

Compare Source

Bug Fixes

hooks: do not add mouse and touch events in React native (#1472) (694f2af)

`v7.2.0`

Compare Source

Features

update scrollIntoView library (#1464) (3571528)

`v7.1.2`

Compare Source

`v7.1.1`

Compare Source

`v7.1.0`

Compare Source

Features

useSelect: improve highlight by character keys algorithm (#1456) (d822530)

`v7.0.5`

Compare Source

Bug Fixes

add clean up to avoid effect firing twice in strict mode (#1436) (25a673b)

`v7.0.4`

Compare Source

Bug Fixes

TS: make refKey optional in GetRootPropsOptions (#1444) (d62ba91)

`v7.0.3`

Compare Source

Bug Fixes

manually release patch version (#1442) (1cbb53a)

`v7.0.1`

Compare Source

Bug Fixes

useSelect: trigger click manually on Enter / Space (#1429) (04a9d9d)

`v7.0.0`

Compare Source

Features

downshift v7 (#1415) (7540e3d)

BREAKING CHANGES

updates to useCombobox and useSelect to adhere to the 1.2 version of the ARIA Combobox pattern.

Migration guide is available in this file.

Closes https://github.com/downshift-js/downshift/issues/1365.
Closes https://github.com/downshift-js/downshift/issues/1239.
Contains changes from https://github.com/downshift-js/downshift/pull/1149.

Configuration

📅 Schedule: Branch creation - "before 7am on Tuesday,before 7am on Wednesday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

changeset-bot · 2023-07-17T14:22:29Z

⚠️ No Changeset found

Latest commit: 701e193

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

renovate bot force-pushed the renovate/downshift-8.x branch from 099b304 to 45540f5 Compare August 7, 2023 16:59

renovate bot force-pushed the renovate/downshift-8.x branch from 45540f5 to 1a564e4 Compare September 25, 2023 16:10

Update dependency downshift to v8

701e193

renovate bot force-pushed the renovate/downshift-8.x branch from 1a564e4 to 701e193 Compare October 2, 2023 16:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency downshift to v8 #339

Update dependency downshift to v8 #339

renovate bot commented Jul 17, 2023 •

edited

Loading

changeset-bot bot commented Jul 17, 2023 •

edited

Loading

Update dependency downshift to v8 #339

Are you sure you want to change the base?

Update dependency downshift to v8 #339

Conversation

renovate bot commented Jul 17, 2023 • edited Loading

Release Notes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

BREAKING CHANGES

PRs included:

Changes

isItemDisabled

useCombobox input click

Getter props return value types

environment propTypes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

BREAKING CHANGES

Configuration

changeset-bot bot commented Jul 17, 2023 • edited Loading

⚠️ No Changeset found

renovate bot commented Jul 17, 2023 •

edited

Loading

changeset-bot bot commented Jul 17, 2023 •

edited

Loading