office-ui-fabric-react
Version:
Reusable React components for building experiences for Office 365.
613 lines • 30.1 kB
JavaScript
define(["require", "exports", "tslib", "react", "./FocusZone.types", "../../Utilities"], function (require, exports, tslib_1, React, FocusZone_types_1, Utilities_1) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var IS_FOCUSABLE_ATTRIBUTE = 'data-is-focusable';
var IS_ENTER_DISABLED_ATTRIBUTE = 'data-disable-click-on-enter';
var FOCUSZONE_ID_ATTRIBUTE = 'data-focuszone-id';
var TABINDEX = 'tabindex';
var _allInstances = {};
var ALLOWED_INPUT_TYPES = ['text', 'number', 'password', 'email', 'tel', 'url', 'search'];
var ALLOW_VIRTUAL_ELEMENTS = false;
var FocusZone = /** @class */ (function (_super) {
tslib_1.__extends(FocusZone, _super);
function FocusZone(props) {
var _this = _super.call(this, props) || this;
_this._warnDeprecations({ rootProps: undefined });
_this._id = Utilities_1.getId('FocusZone');
_this._focusAlignment = {
left: 0,
top: 0
};
return _this;
}
FocusZone.prototype.componentDidMount = function () {
_allInstances[this._id] = this;
if (this._root) {
var windowElement = this._root.ownerDocument.defaultView;
var parentElement = Utilities_1.getParent(this._root, ALLOW_VIRTUAL_ELEMENTS);
while (parentElement &&
parentElement !== document.body &&
parentElement.nodeType === 1) {
if (Utilities_1.isElementFocusZone(parentElement)) {
this._isInnerZone = true;
break;
}
parentElement = Utilities_1.getParent(parentElement, ALLOW_VIRTUAL_ELEMENTS);
}
if (!this._isInnerZone) {
this._events.on(windowElement, 'keydown', this._onKeyDownCapture, true);
}
// Assign initial tab indexes so that we can set initial focus as appropriate.
this._updateTabIndexes();
if (this.props.defaultActiveElement) {
this._activeElement = Utilities_1.getDocument().querySelector(this.props.defaultActiveElement);
this.focus();
}
}
};
FocusZone.prototype.componentWillUnmount = function () {
delete _allInstances[this._id];
};
FocusZone.prototype.render = function () {
var _a = this.props, rootProps = _a.rootProps, ariaDescribedBy = _a.ariaDescribedBy, ariaLabelledBy = _a.ariaLabelledBy, className = _a.className;
var divProps = Utilities_1.getNativeProps(this.props, Utilities_1.divProperties);
var Tag = this.props.elementType || 'div';
return (React.createElement(Tag, tslib_1.__assign({ role: 'presentation' }, divProps, rootProps, { className: Utilities_1.css('ms-FocusZone', className), ref: this._resolveRef('_root'), "data-focuszone-id": this._id, "aria-labelledby": ariaLabelledBy, "aria-describedby": ariaDescribedBy, onKeyDown: this._onKeyDown, onFocus: this._onFocus, onMouseDownCapture: this._onMouseDown }), this.props.children));
};
/**
* Sets focus to the first tabbable item in the zone.
* @returns True if focus could be set to an active element, false if no operation was taken.
*/
FocusZone.prototype.focus = function (forceIntoFirstElement) {
if (forceIntoFirstElement === void 0) { forceIntoFirstElement = false; }
if (this._root) {
if (!forceIntoFirstElement && this._root.getAttribute(IS_FOCUSABLE_ATTRIBUTE) === 'true' && this._isInnerZone) {
var ownerZoneElement = this._getOwnerZone(this._root);
if (ownerZoneElement !== this._root) {
var ownerZone = _allInstances[ownerZoneElement.getAttribute(FOCUSZONE_ID_ATTRIBUTE)];
return !!ownerZone && ownerZone.focusElement(this._root);
}
return false;
}
else if (this._activeElement && Utilities_1.elementContains(this._root, this._activeElement)
&& Utilities_1.isElementTabbable(this._activeElement)) {
this._activeElement.focus();
return true;
}
else {
var firstChild = this._root.firstChild;
return this.focusElement(Utilities_1.getNextElement(this._root, firstChild, true));
}
}
return false;
};
/**
* Sets focus to a specific child element within the zone. This can be used in conjunction with
* onBeforeFocus to created delayed focus scenarios (like animate the scroll position to the correct
* location and then focus.)
* @param {HTMLElement} element The child element within the zone to focus.
* @returns True if focus could be set to an active element, false if no operation was taken.
*/
FocusZone.prototype.focusElement = function (element) {
var onBeforeFocus = this.props.onBeforeFocus;
if (onBeforeFocus && !onBeforeFocus(element)) {
return false;
}
if (element) {
this._setActiveElement(element);
if (this._activeElement) {
this._activeElement.focus();
}
return true;
}
return false;
};
FocusZone.prototype._onFocus = function (ev) {
var onActiveElementChanged = this.props.onActiveElementChanged;
if (this._isImmediateDescendantOfZone(ev.target)) {
this._activeElement = ev.target;
this._setFocusAlignment(this._activeElement);
}
else {
var parentElement = ev.target;
while (parentElement && parentElement !== this._root) {
if (Utilities_1.isElementTabbable(parentElement) && this._isImmediateDescendantOfZone(parentElement)) {
this._activeElement = parentElement;
break;
}
parentElement = Utilities_1.getParent(parentElement, ALLOW_VIRTUAL_ELEMENTS);
}
}
if (onActiveElementChanged) {
onActiveElementChanged(this._activeElement, ev);
}
};
/**
* Handle global tab presses so that we can patch tabindexes on the fly.
*/
FocusZone.prototype._onKeyDownCapture = function (ev) {
if (ev.which === 9 /* tab */) {
this._updateTabIndexes();
}
};
FocusZone.prototype._onMouseDown = function (ev) {
var disabled = this.props.disabled;
if (disabled) {
return;
}
var target = ev.target;
var path = [];
while (target && target !== this._root) {
path.push(target);
target = Utilities_1.getParent(target, ALLOW_VIRTUAL_ELEMENTS);
}
while (path.length) {
target = path.pop();
if (target && Utilities_1.isElementTabbable(target)) {
this._setActiveElement(target);
}
if (Utilities_1.isElementFocusZone(target)) {
// Stop here since the focus zone will take care of its own children.
break;
}
}
};
FocusZone.prototype._setActiveElement = function (element) {
var previousActiveElement = this._activeElement;
this._activeElement = element;
if (previousActiveElement) {
if (Utilities_1.isElementFocusZone(previousActiveElement)) {
this._updateTabIndexes(previousActiveElement);
}
previousActiveElement.tabIndex = -1;
}
if (this._activeElement) {
if (!this._focusAlignment) {
this._setFocusAlignment(element, true, true);
}
this._activeElement.tabIndex = 0;
}
};
/**
* Handle the keystrokes.
*/
FocusZone.prototype._onKeyDown = function (ev) {
var _a = this.props, direction = _a.direction, disabled = _a.disabled, isInnerZoneKeystroke = _a.isInnerZoneKeystroke;
if (disabled) {
return;
}
if (document.activeElement === this._root && this._isInnerZone) {
// If this element has focus, it is being controlled by a parent.
// Ignore the keystroke.
return;
}
if (this.props.onKeyDown) {
this.props.onKeyDown(ev);
if (ev.isDefaultPrevented()) {
return;
}
}
if (isInnerZoneKeystroke &&
isInnerZoneKeystroke(ev) &&
this._isImmediateDescendantOfZone(ev.target)) {
// Try to focus
var innerZone = this._getFirstInnerZone();
if (innerZone) {
if (!innerZone.focus(true)) {
return;
}
}
else if (Utilities_1.isElementFocusSubZone(ev.target)) {
if (!this.focusElement(Utilities_1.getNextElement(ev.target, ev.target.firstChild, true))) {
return;
}
}
else {
return;
}
}
else if (ev.altKey) {
return;
}
else {
switch (ev.which) {
case 32 /* space */:
if (this._tryInvokeClickForFocusable(ev.target)) {
break;
}
return;
case 37 /* left */:
if (direction !== FocusZone_types_1.FocusZoneDirection.vertical && this._moveFocusLeft()) {
break;
}
return;
case 39 /* right */:
if (direction !== FocusZone_types_1.FocusZoneDirection.vertical && this._moveFocusRight()) {
break;
}
return;
case 38 /* up */:
if (direction !== FocusZone_types_1.FocusZoneDirection.horizontal && this._moveFocusUp()) {
break;
}
return;
case 40 /* down */:
if (direction !== FocusZone_types_1.FocusZoneDirection.horizontal && this._moveFocusDown()) {
break;
}
return;
case 9 /* tab */:
if (this.props.allowTabKey) {
if (direction === FocusZone_types_1.FocusZoneDirection.vertical) {
if (ev.shiftKey) {
this._moveFocusUp();
}
else {
this._moveFocusDown();
}
break;
}
else if (direction === FocusZone_types_1.FocusZoneDirection.horizontal || direction === FocusZone_types_1.FocusZoneDirection.bidirectional) {
if (ev.shiftKey) {
this._moveFocusLeft();
}
else {
this._moveFocusRight();
}
break;
}
}
return;
case 36 /* home */:
if (this._isElementInput(ev.target) &&
!this._shouldInputLoseFocus(ev.target, false)) {
return false;
}
var firstChild = this._root.firstChild;
if (this.focusElement(Utilities_1.getNextElement(this._root, firstChild, true))) {
break;
}
return;
case 35 /* end */:
if (this._isElementInput(ev.target) &&
!this._shouldInputLoseFocus(ev.target, true)) {
return false;
}
var lastChild = this._root.lastChild;
if (this.focusElement(Utilities_1.getPreviousElement(this._root, lastChild, true, true, true))) {
break;
}
return;
case 13 /* enter */:
if (this._tryInvokeClickForFocusable(ev.target)) {
break;
}
return;
default:
return;
}
}
ev.preventDefault();
ev.stopPropagation();
};
/**
* Walk up the dom try to find a focusable element.
*/
FocusZone.prototype._tryInvokeClickForFocusable = function (target) {
if (target === this._root) {
return false;
}
do {
if (target.tagName === 'BUTTON' || target.tagName === 'A' || target.tagName === 'INPUT' || target.tagName === 'TEXTAREA') {
return false;
}
if (this._isImmediateDescendantOfZone(target) &&
target.getAttribute(IS_FOCUSABLE_ATTRIBUTE) === 'true' &&
target.getAttribute(IS_ENTER_DISABLED_ATTRIBUTE) !== 'true') {
Utilities_1.EventGroup.raise(target, 'click', null, true);
return true;
}
target = Utilities_1.getParent(target, ALLOW_VIRTUAL_ELEMENTS);
} while (target !== this._root);
return false;
};
/**
* Traverse to find first child zone.
*/
FocusZone.prototype._getFirstInnerZone = function (rootElement) {
rootElement = rootElement || this._activeElement || this._root;
if (Utilities_1.isElementFocusZone(rootElement)) {
return _allInstances[rootElement.getAttribute(FOCUSZONE_ID_ATTRIBUTE)];
}
var child = rootElement.firstElementChild;
while (child) {
if (Utilities_1.isElementFocusZone(child)) {
return _allInstances[child.getAttribute(FOCUSZONE_ID_ATTRIBUTE)];
}
var match = this._getFirstInnerZone(child);
if (match) {
return match;
}
child = child.nextElementSibling;
}
return null;
};
FocusZone.prototype._moveFocus = function (isForward, getDistanceFromCenter, ev) {
var element = this._activeElement;
var candidateDistance = -1;
var candidateElement = undefined;
var changedFocus = false;
var isBidirectional = this.props.direction === FocusZone_types_1.FocusZoneDirection.bidirectional;
if (!element) {
return false;
}
if (this._isElementInput(element)) {
if (!this._shouldInputLoseFocus(element, isForward)) {
return false;
}
}
var activeRect = isBidirectional ? element.getBoundingClientRect() : null;
do {
element = (isForward ?
Utilities_1.getNextElement(this._root, element) :
Utilities_1.getPreviousElement(this._root, element));
if (isBidirectional) {
if (element) {
var targetRect = element.getBoundingClientRect();
var elementDistance = getDistanceFromCenter(activeRect, targetRect);
if (elementDistance === -1 && candidateDistance === -1) {
candidateElement = element;
break;
}
if (elementDistance > -1 && (candidateDistance === -1 || elementDistance < candidateDistance)) {
candidateDistance = elementDistance;
candidateElement = element;
}
if (candidateDistance >= 0 && elementDistance < 0) {
break;
}
}
}
else {
candidateElement = element;
break;
}
} while (element);
// Focus the closest candidate
if (candidateElement && candidateElement !== this._activeElement) {
changedFocus = true;
this.focusElement(candidateElement);
}
else if (this.props.isCircularNavigation) {
if (isForward) {
return this.focusElement(Utilities_1.getNextElement(this._root, this._root.firstElementChild, true));
}
else {
return this.focusElement(Utilities_1.getPreviousElement(this._root, this._root.lastElementChild, true, true, true));
}
}
return changedFocus;
};
FocusZone.prototype._moveFocusDown = function () {
var targetTop = -1;
var leftAlignment = this._focusAlignment.left;
if (this._moveFocus(true, function (activeRect, targetRect) {
var distance = -1;
// ClientRect values can be floats that differ by very small fractions of a decimal.
// If the difference between top and bottom are within a pixel then we should treat
// them as equivalent by using Math.floor. For instance 5.2222 and 5.222221 should be equivalent,
// but without Math.Floor they will be handled incorrectly.
var targetRectTop = Math.floor(targetRect.top);
var activeRectBottom = Math.floor(activeRect.bottom);
if (targetRectTop < activeRectBottom) {
return 999999999;
}
if ((targetTop === -1 && targetRectTop >= activeRectBottom) ||
(targetRectTop === targetTop)) {
targetTop = targetRectTop;
if (leftAlignment >= targetRect.left && leftAlignment <= (targetRect.left + targetRect.width)) {
distance = 0;
}
else {
distance = Math.abs((targetRect.left + (targetRect.width / 2)) - leftAlignment);
}
}
return distance;
})) {
this._setFocusAlignment(this._activeElement, false, true);
return true;
}
return false;
};
FocusZone.prototype._moveFocusUp = function () {
var targetTop = -1;
var leftAlignment = this._focusAlignment.left;
if (this._moveFocus(false, function (activeRect, targetRect) {
var distance = -1;
// ClientRect values can be floats that differ by very small fractions of a decimal.
// If the difference between top and bottom are within a pixel then we should treat
// them as equivalent by using Math.floor. For instance 5.2222 and 5.222221 should be equivalent,
// but without Math.Floor they will be handled incorrectly.
var targetRectBottom = Math.floor(targetRect.bottom);
var targetRectTop = Math.floor(targetRect.top);
var activeRectTop = Math.floor(activeRect.top);
if (targetRectBottom > activeRectTop) {
return 999999999;
}
if ((targetTop === -1 && targetRectBottom <= activeRectTop) ||
(targetRectTop === targetTop)) {
targetTop = targetRectTop;
if (leftAlignment >= targetRect.left && leftAlignment <= (targetRect.left + targetRect.width)) {
distance = 0;
}
else {
distance = Math.abs((targetRect.left + (targetRect.width / 2)) - leftAlignment);
}
}
return distance;
})) {
this._setFocusAlignment(this._activeElement, false, true);
return true;
}
return false;
};
FocusZone.prototype._moveFocusLeft = function () {
var _this = this;
if (this._moveFocus(Utilities_1.getRTL(), function (activeRect, targetRect) {
var distance = -1;
if (targetRect.bottom > activeRect.top &&
targetRect.right <= activeRect.right &&
_this.props.direction !== FocusZone_types_1.FocusZoneDirection.vertical) {
distance = activeRect.right - targetRect.right;
}
return distance;
})) {
this._setFocusAlignment(this._activeElement, true, false);
return true;
}
return false;
};
FocusZone.prototype._moveFocusRight = function () {
var _this = this;
if (this._moveFocus(!Utilities_1.getRTL(), function (activeRect, targetRect) {
var distance = -1;
if (targetRect.top < activeRect.bottom &&
targetRect.left >= activeRect.left &&
_this.props.direction !== FocusZone_types_1.FocusZoneDirection.vertical) {
distance = targetRect.left - activeRect.left;
}
return distance;
})) {
this._setFocusAlignment(this._activeElement, true, false);
return true;
}
return false;
};
FocusZone.prototype._setFocusAlignment = function (element, isHorizontal, isVertical) {
if (this.props.direction === FocusZone_types_1.FocusZoneDirection.bidirectional &&
(!this._focusAlignment || isHorizontal || isVertical)) {
var rect = element.getBoundingClientRect();
var left = rect.left + (rect.width / 2);
var top_1 = rect.top + (rect.height / 2);
if (!this._focusAlignment) {
this._focusAlignment = { left: left, top: top_1 };
}
if (isHorizontal) {
this._focusAlignment.left = left;
}
if (isVertical) {
this._focusAlignment.top = top_1;
}
}
};
FocusZone.prototype._isImmediateDescendantOfZone = function (element) {
return this._getOwnerZone(element) === this._root;
};
FocusZone.prototype._getOwnerZone = function (element) {
var parentElement = Utilities_1.getParent(element, ALLOW_VIRTUAL_ELEMENTS);
while (parentElement && parentElement !== this._root && parentElement !== document.body) {
if (Utilities_1.isElementFocusZone(parentElement)) {
return parentElement;
}
parentElement = Utilities_1.getParent(parentElement, ALLOW_VIRTUAL_ELEMENTS);
}
return this._root;
};
FocusZone.prototype._updateTabIndexes = function (element) {
if (!element) {
this._defaultFocusElement = null;
element = this._root;
if (this._activeElement && !Utilities_1.elementContains(element, this._activeElement)) {
this._activeElement = null;
}
}
// If active element changes state to disabled, set it to null.
// Otherwise, we lose keyboard accessibility to other elements in focus zone.
if (this._activeElement && !Utilities_1.isElementTabbable(this._activeElement)) {
this._activeElement = null;
}
var childNodes = element.children;
for (var childIndex = 0; childNodes && childIndex < childNodes.length; childIndex++) {
var child = childNodes[childIndex];
if (!Utilities_1.isElementFocusZone(child)) {
// If the item is explicitly set to not be focusable then TABINDEX needs to be set to -1.
if (child.getAttribute && child.getAttribute(IS_FOCUSABLE_ATTRIBUTE) === 'false') {
child.setAttribute(TABINDEX, '-1');
}
if (Utilities_1.isElementTabbable(child)) {
if (this.props.disabled) {
child.setAttribute(TABINDEX, '-1');
}
else if (!this._isInnerZone && ((!this._activeElement && !this._defaultFocusElement) || this._activeElement === child)) {
this._defaultFocusElement = child;
if (child.getAttribute(TABINDEX) !== '0') {
child.setAttribute(TABINDEX, '0');
}
}
else if (child.getAttribute(TABINDEX) !== '-1') {
child.setAttribute(TABINDEX, '-1');
}
}
else if (child.tagName === 'svg' && child.getAttribute('focusable') !== 'false') {
// Disgusting IE hack. Sad face.
child.setAttribute('focusable', 'false');
}
}
else if (child.getAttribute(IS_FOCUSABLE_ATTRIBUTE) === 'true') {
if (!this._isInnerZone && ((!this._activeElement && !this._defaultFocusElement) || this._activeElement === child)) {
this._defaultFocusElement = child;
if (child.getAttribute(TABINDEX) !== '0') {
child.setAttribute(TABINDEX, '0');
}
}
else if (child.getAttribute(TABINDEX) !== '-1') {
child.setAttribute(TABINDEX, '-1');
}
}
this._updateTabIndexes(child);
}
};
FocusZone.prototype._isElementInput = function (element) {
if (element && element.tagName && (element.tagName.toLowerCase() === 'input' || element.tagName.toLowerCase() === 'textarea')) {
return true;
}
return false;
};
FocusZone.prototype._shouldInputLoseFocus = function (element, isForward) {
if (element &&
element.type &&
ALLOWED_INPUT_TYPES.indexOf(element.type.toLowerCase()) > -1) {
var selectionStart = element.selectionStart;
var selectionEnd = element.selectionEnd;
var isRangeSelected = selectionStart !== selectionEnd;
var inputValue = element.value;
// We shouldn't lose focus in the following cases:
// 1. There is range selected.
// 2. When selection start is larger than 0 and it is backward.
// 3. when selection start is not the end of lenght and it is forward.
if (isRangeSelected ||
(selectionStart > 0 && !isForward) ||
(selectionStart !== inputValue.length && isForward)) {
return false;
}
}
return true;
};
FocusZone.defaultProps = {
isCircularNavigation: false,
direction: FocusZone_types_1.FocusZoneDirection.bidirectional
};
tslib_1.__decorate([
Utilities_1.autobind
], FocusZone.prototype, "_onFocus", null);
tslib_1.__decorate([
Utilities_1.autobind
], FocusZone.prototype, "_onMouseDown", null);
tslib_1.__decorate([
Utilities_1.autobind
], FocusZone.prototype, "_onKeyDown", null);
return FocusZone;
}(Utilities_1.BaseComponent));
exports.FocusZone = FocusZone;
});
//# sourceMappingURL=FocusZone.js.map