-
Notifications
You must be signed in to change notification settings - Fork 4k
/
container.js
144 lines (121 loc) · 3.94 KB
/
container.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/**
* External dependencies
*/
import { omit, noop, isFunction } from 'lodash';
/**
* WordPress dependencies
*/
import { Component, forwardRef } from '@wordpress/element';
import { focus } from '@wordpress/dom';
function cycleValue( value, total, offset ) {
const nextValue = value + offset;
if ( nextValue < 0 ) {
return total + nextValue;
} else if ( nextValue >= total ) {
return nextValue - total;
}
return nextValue;
}
class NavigableContainer extends Component {
constructor() {
super( ...arguments );
this.onKeyDown = this.onKeyDown.bind( this );
this.bindContainer = this.bindContainer.bind( this );
this.getFocusableContext = this.getFocusableContext.bind( this );
this.getFocusableIndex = this.getFocusableIndex.bind( this );
}
componentDidMount() {
// We use DOM event listeners instead of React event listeners
// because we want to catch events from the underlying DOM tree
// The React Tree can be different from the DOM tree when using
// portals. Block Toolbars for instance are rendered in a separate
// React Trees.
this.container.addEventListener( 'keydown', this.onKeyDown );
this.container.addEventListener( 'focus', this.onFocus );
}
componentWillUnmount() {
this.container.removeEventListener( 'keydown', this.onKeyDown );
this.container.removeEventListener( 'focus', this.onFocus );
}
bindContainer( ref ) {
const { forwardedRef } = this.props;
this.container = ref;
if ( isFunction( forwardedRef ) ) {
forwardedRef( ref );
} else if ( forwardedRef && 'current' in forwardedRef ) {
forwardedRef.current = ref;
}
}
getFocusableContext( target ) {
const { onlyBrowserTabstops } = this.props;
const finder = onlyBrowserTabstops ? focus.tabbable : focus.focusable;
const focusables = finder.find( this.container );
const index = this.getFocusableIndex( focusables, target );
if ( index > -1 && target ) {
return { index, target, focusables };
}
return null;
}
getFocusableIndex( focusables, target ) {
const directIndex = focusables.indexOf( target );
if ( directIndex !== -1 ) {
return directIndex;
}
}
onKeyDown( event ) {
if ( this.props.onKeyDown ) {
this.props.onKeyDown( event );
}
const { getFocusableContext } = this;
const { cycle = true, eventToOffset, onNavigate = noop, stopNavigationEvents } = this.props;
const offset = eventToOffset( event );
// eventToOffset returns undefined if the event is not handled by the component
if ( offset !== undefined && stopNavigationEvents ) {
// Prevents arrow key handlers bound to the document directly interfering
event.stopImmediatePropagation();
// When navigating a collection of items, prevent scroll containers
// from scrolling.
if ( event.target.getAttribute( 'role' ) === 'menuitem' ) {
event.preventDefault();
}
}
if ( ! offset ) {
return;
}
const context = getFocusableContext( document.activeElement );
if ( ! context ) {
return;
}
const { index, focusables } = context;
const nextIndex = cycle ? cycleValue( index, focusables.length, offset ) : index + offset;
if ( nextIndex >= 0 && nextIndex < focusables.length ) {
focusables[ nextIndex ].focus();
onNavigate( nextIndex, focusables[ nextIndex ] );
}
}
render() {
const { children, ...props } = this.props;
// Disable reason: Assumed role is applied by parent via props spread.
/* eslint-disable jsx-a11y/no-static-element-interactions */
return (
<div ref={ this.bindContainer }
{ ...omit( props, [
'stopNavigationEvents',
'eventToOffset',
'onNavigate',
'cycle',
'onlyBrowserTabstops',
'forwardedRef',
] ) }
>
{ children }
</div>
);
/* eslint-enable jsx-a11y/no-static-element-interactions */
}
}
const forwardedNavigableContainer = ( props, ref ) => {
return <NavigableContainer { ...props } forwardedRef={ ref } />;
};
forwardedNavigableContainer.displayName = 'NavigableContainer';
export default forwardRef( forwardedNavigableContainer );