Dropdown arrow key support #1075
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,8 +3,7 @@ import styles from '@patternfly/patternfly-next/components/Dropdown/dropdown.css | |
| import { css } from '@patternfly/react-styles'; | ||
| import PropTypes from 'prop-types'; | ||
| import { componentShape } from '../../internal/componentShape'; | ||
| import { DropdownPosition, DropdownContext, DropdownArrowContext } from './dropdownConstants'; | ||
|
|
||
| const propTypes = { | ||
| /** Anything which can be rendered as dropdown items */ | ||
|
|
@@ -29,12 +28,117 @@ const defaultProps = { | |
| component: 'ul' | ||
| }; | ||
|
|
||
| class DropdownMenu extends React.Component { | ||
|
There was a problem hiding this comment. to keep consistent with the repo modify this to be class DropdownMenu extends React.Component {
refsCollection = {};
keyHandler = (index, position, custom = false) => { ... }
} |
||
| constructor(props) { | ||
| super(props); | ||
| this.refsCollection = {}; | ||
| this.keyHandler = this.keyHandler.bind(this); | ||
| } | ||
|
|
||
| keyHandler(index, position, custom = false) { | ||
| const kids = this.props.children; | ||
|
There was a problem hiding this comment. This could break if consumers put items in a fragment. It might be better to make use of context to pass things around. There was a problem hiding this comment. I'm not sure what you mean by using context? I am seeing that having a child that is a React.Fragment will throw an error but should we just handle that when the children get extended (wrapping them in a div) or is there a better method? There was a problem hiding this comment. The context API https://reactjs.org/docs/context.html There was a problem hiding this comment. I can move keyHandler and sendRef to a Context but they only get passed down one layer so I'm not sure it saves much. I'm also confused about the case of putting the items in a Fragment because the top level Dropdown component should be expecting an array. |
||
| if (!Array.isArray(kids)) return; | ||
| let nextIndex; | ||
| if (position === 'up') { | ||
| if (index === 0) { | ||
| // loop back to end | ||
| nextIndex = kids.length - 1; | ||
| } else { | ||
| nextIndex = index - 1; | ||
| } | ||
| } else if (index === kids.length - 1) { | ||
| // loop back to beginning | ||
| nextIndex = 0; | ||
| } else { | ||
| nextIndex = index + 1; | ||
| } | ||
| if (this.refsCollection[`item-${nextIndex}`] === null) { | ||
| this.keyHandler(nextIndex, position, custom); | ||
| } else { | ||
| custom | ||
| ? this.refsCollection[`item-${nextIndex}`].current.focus() | ||
| : this.refsCollection[`item-${nextIndex}`].focus(); | ||
| } | ||
| } | ||
|
|
||
| componentDidMount() { | ||
| if (this.props.openedOnEnter) { | ||
| if (this.props.component === 'ul') this.refsCollection['item-0'].focus(); | ||
| else { | ||
| this.refsCollection['item-0'].current.focus(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| sendRef = (index, node, isDisabled) => { | ||
| if (isDisabled || node.getAttribute('role') === 'separator') { | ||
| this.refsCollection[`item-${index}`] = null; | ||
| } else { | ||
| this.refsCollection[`item-${index}`] = node; | ||
| } | ||
| }; | ||
|
|
||
| extendChildren() { | ||
| return React.Children.map(this.props.children, (child, index) => | ||
| React.cloneElement(child, { | ||
| index | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| extendCustomChildren() { | ||
| const mappedChildren = React.Children.map(this.props.children, (child, index) => { | ||
| const mappedChild = React.cloneElement(child, { | ||
| ref: React.createRef(), | ||
| tabIndex: -1, | ||
| onKeyDown: event => { | ||
| if (event.key === 'Tab') return; | ||
| event.preventDefault(); | ||
| if (event.key === 'ArrowUp') { | ||
| this.keyHandler(index, 'up', true); | ||
| } else if (event.key === 'ArrowDown') { | ||
| this.keyHandler(index, 'down', true); | ||
| } | ||
| } | ||
| }); | ||
| !mappedChild.props.disabled | ||
| ? (this.refsCollection[`item-${index}`] = mappedChild.ref) | ||
| : (this.refsCollection[`item-${index}`] = null); | ||
| return mappedChild; | ||
| }); | ||
| return mappedChildren; | ||
| } | ||
|
|
||
| render() { | ||
| const { className, isOpen, position, children, component: Component, openedOnEnter, ...props } = this.props; | ||
| let menu = null; | ||
| if (Component === 'div') { | ||
| menu = ( | ||
| <DropdownContext.Consumer> | ||
| {onSelect => ( | ||
| <Component | ||
| {...props} | ||
| className={css( | ||
| styles.dropdownMenu, | ||
| position === DropdownPosition.right && styles.modifiers.alignRight, | ||
| className | ||
| )} | ||
| hidden={!isOpen} | ||
| onClick={event => onSelect && onSelect(event)} | ||
| > | ||
| {this.extendCustomChildren()} | ||
| </Component> | ||
| )} | ||
| </DropdownContext.Consumer> | ||
| ); | ||
| } else if (Component === 'ul') { | ||
| menu = ( | ||
| <DropdownArrowContext.Provider | ||
| value={{ | ||
| keyHandler: this.keyHandler, | ||
| sendRef: this.sendRef | ||
| }} | ||
| > | ||
| <Component | ||
| {...props} | ||
| className={css( | ||
|
|
@@ -43,36 +147,16 @@ const DropdownMenu = ({ className, isOpen, position, children, component: Compon | |
| className | ||
| )} | ||
| hidden={!isOpen} | ||
| role="menu" | ||
| > | ||
| {this.extendChildren()} | ||
| </Component> | ||
| </DropdownArrowContext.Provider> | ||
| ); | ||
| } | ||
| return menu; | ||
| } | ||
| } | ||
|
|
||
| DropdownMenu.propTypes = propTypes; | ||
| DropdownMenu.defaultProps = defaultProps; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are application launcher tests that run similar tests. Will most likely need some updates.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the tests.