Skip to content

Latest commit

 

History

History
231 lines (135 loc) · 7.15 KB

CHANGELOG.md

File metadata and controls

231 lines (135 loc) · 7.15 KB
Raw

7.2.1 (2022-11-10)

  • Added noMouseHighlight prop to MenuItem to allow keyboard highlighting to be tracked separately from mouse hover.

7.1.0 (2022-11-09)

  • MenuList: "keydown" events are now listened for on the MenuList's own div, fixing issues where an ancestor React element could handle the "keydown" event before MenuList does.
  • MenuButton: Enter and space "keydown" events on the button element that toggle it now have stopPropagation() called so that no other components attempt to handle the event redundantly.
  • MenuButton: The third argument of the renderButton prop callback is now onKeyDown, meant to be used as a keydown event handler instead of a keypress event handler. It will still work as a keypress event handler as previously recommended, so this isn't a breaking change.

7.0.4 (2022-08-11)

  • Fixed issue where MenuButton closes its dropdown if the page loses and regains focus.

6.1.3 (2022-08-11)

  • Fixed issue where MenuButton closes its dropdown if the page loses and regains focus.

7.0.3 (2021-10-06)

6.1.2 (2021-10-06)

7.0.2 (2021-03-27)

  • Batch React updates during all event handling.

6.1.1 (2021-03-27)

  • Batch React updates during all event handling.

7.0.1 (2020-09-11)

  • Use correct types for events in the Typescript definition of MenuButton's renderButton prop.

7.0.0 (2020-09-10)

  • Breaking change: MenuButton's ButtonComponent prop was replaced with the renderButton prop. This change makes it easier to pass values down from a closure to the button element, and avoids a common mistake with the old API where a user may pass a fresh component on every render, causing React to mount a new component instance on every render.

Affected old code example:

return (
  <MenuButton
    ButtonComponent={MyButtonComponent}
    {/*...*/}
  />
);

New code example:

return (
  <MenuButton
    renderButton={(domRef, opened, onKeyDown, onMouseDown) =>
      <MyButtonComponent
        domRef={domRef}
        onKeyDown={onKeyDown}
        onMouseDown={onMouseDown}
      />
    }
    {/*...*/}
  />
);

6.1.0 (2019-10-15)

  • Added menuParentElement prop. (#14)
  • Added buttonProps prop. (#13)

6.0.5 (2019-08-09)

  • Fixed a bug where if the user opened a MenuButton and then released the click over the MenuButton's dropdown (which would always happen if the MenuButton had position: 'cover' passed in the positionOptions prop), the MenuButton would close the dropdown.

6.0.4 (2019-05-31)

  • Fixed compatibility with Flow v0.100.

6.0.3 (2019-04-11)

  • Fixed compatibility with Flow v0.96.

6.0.2 (2019-01-26)

  • Updated TypeScript and Flow type definitions to expose MenuEvent and ChosenEvent types.
  • Fixed compatibility with Flow v0.87.

6.0.1 (2018-11-08)

  • Fixed an error being logged when a user moved the mouse off of a SubMenuItem quickly before the menu opened.

6.0.0 (2018-10-31)

Breaking Changes

  • react-menu-list now requires React v16.6.0 or above.
  • The component passed to the optional MenuButton prop ButtonComponent must support a domRef prop which is passed as a ref to the button's DOM element.
  • The open method of MenuButton and SubMenuItem no longer takes a callback as a parameter. It returns a Promise now instead.

Improvements

  • No longer uses any deprecated APIs (legacy Context API, lifecycle methods, and ReactDOM.findDOMNode).
  • Added TypeScript type definitions.

5.0.1 (2018-05-15)

  • Fix compatibility with Flow v0.72.

5.0.0 (2017-10-11)

Breaking Changes

  • SubMenuItem no longer has an inner div element wrapping its children. This change allows it to be styled consistently with MenuItem. This change may break existing users that had CSS depending on the inner element. (If you had a CSS selector that mentioned a class name put onto a SubMenuItem followed by "> div", then this means you! If you didn't, then you probably aren't affected by this change.)

Improvements

  • Fixed AutoComplete example not responding to mouse clicks correctly.

4.0.0 (2017-10-04)

Breaking Changes

  • react-menu-list now requires React v16.

3.5.0 (2017-08-23)

  • Use cross-env utility so that example can be built on Windows.
  • Now compatible with Flow v0.53.

3.4.0 (2017-04-25)

  • No longer uses now-deprecated React.PropTypes. Uses prop-types package now.

3.3.0 (2017-03-10)

  • Added an optional callback parameter to MenuButton and SubMenuItem's open method.

3.2.3 (2017-03-06)

  • Now compatible with Flow v0.41.
  • Improved the documentation of MenuItem and MenuButton.

3.2.2 (2016-09-19)

  • Fix bug where changes to index prop weren't respected.

3.2.1 (2016-08-05)

  • Now compatible with Flow v0.30.

3.2.0 (2016-07-08)

  • Added ButtonComponent prop to MenuButton.

3.1.0 (2016-06-14)

  • Now auto-closes MenuButton's menu when an outside element gets focused.

3.0.0 (2016-06-07)

Breaking Changes

  • react-menu-list now requires React v15.

Improvements

  • Fix issue where MenuButton closed when its contents were focused.

2.1.0 (2016-05-04)

  • Added hasHighlight method to several components.
  • Added more MenuItem methods to SubMenuItem.
  • Fixed issue where MenuList would still block the event of a user pressing Enter when no menu items were focused.
  • Improved AutoComplete example with demonstrations of alternate behavior styles.

2.0.1 (2016-05-03)

  • Fixed exceptions emitted when a MenuList had no items.

2.0.0 (2016-04-22)

Breaking Changes

  • The zIndex prop on MenuItem and SubMenuItem was renamed to menuZIndex.

1.4.1 (2016-04-15)

  • MenuButton no longer opens when right-clicked.

1.4.0 (2016-04-14)

  • Added reposition method to MenuButton and SubMenuItem.

1.3.1 (2016-04-12)

  • Fixed focus outline appearing on MenuButton when opened with enter button in Chrome.
  • Fixed MenuButton not closing in Safari and Firefox on OS X.

1.3.0 (2016-04-12)

  • MenuButton now opens on mousedown.
  • Added zIndex, openedStyle, and openedClassName props to MenuButton and SubMenuItem.
  • Improved MenuButton documentation.

1.2.2 (2016-04-07)

  • Now lists React v15 as an acceptable peer dependency.

1.2.1 (2016-04-01)

  • Added disabled and title props to MenuButton.
  • Change MenuButton to be type="button" rather than type="submit" so that browsers don't believe it submits forms.

1.2.0 (2016-04-01)

  • Provide direction property in onHighlightChange event.
  • Make MenuListInspector's moveCursor method return false instead of throwing an exception when no child menu list is found. Arguably this is an API-breaking change, but we're not bumping the major version number here because of the current unlikelihood that any users are depending on this now.

1.1.0 (2016-04-01)

  • Add a small delay before a submenu opens when the user hovers over a SubMenuItem. This makes SubMenuItem's behavior more consistent with OS X dropdown menus, and seems to make the submenu's appearance seem less jarring to the user.

1.0.0 (2016-03-31)

  • First stable release version.