509 lines
18 KiB
JavaScript
509 lines
18 KiB
JavaScript
/* *
|
|
*
|
|
* (c) 2009-2021 Øystein Moseng
|
|
*
|
|
* Accessibility component for the range selector.
|
|
*
|
|
* License: www.highcharts.com/license
|
|
*
|
|
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
|
|
*
|
|
* */
|
|
'use strict';
|
|
var __extends = (this && this.__extends) || (function () {
|
|
var extendStatics = function (d, b) {
|
|
extendStatics = Object.setPrototypeOf ||
|
|
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
return extendStatics(d, b);
|
|
};
|
|
return function (d, b) {
|
|
if (typeof b !== "function" && b !== null)
|
|
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
extendStatics(d, b);
|
|
function __() { this.constructor = d; }
|
|
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
};
|
|
})();
|
|
import RangeSelector from '../../Extensions/RangeSelector.js';
|
|
import AccessibilityComponent from '../AccessibilityComponent.js';
|
|
import ChartUtilities from '../Utils/ChartUtilities.js';
|
|
var unhideChartElementFromAT = ChartUtilities.unhideChartElementFromAT, getAxisRangeDescription = ChartUtilities.getAxisRangeDescription;
|
|
import Announcer from '../Utils/Announcer.js';
|
|
import KeyboardNavigationHandler from '../KeyboardNavigationHandler.js';
|
|
import U from '../../Core/Utilities.js';
|
|
var addEvent = U.addEvent, attr = U.attr;
|
|
/* *
|
|
*
|
|
* Functions
|
|
*
|
|
* */
|
|
/* eslint-disable valid-jsdoc */
|
|
/**
|
|
* @private
|
|
*/
|
|
function shouldRunInputNavigation(chart) {
|
|
return Boolean(chart.rangeSelector &&
|
|
chart.rangeSelector.inputGroup &&
|
|
chart.rangeSelector.inputGroup.element.style.visibility !== 'hidden' &&
|
|
chart.options.rangeSelector.inputEnabled !== false &&
|
|
chart.rangeSelector.minInput &&
|
|
chart.rangeSelector.maxInput);
|
|
}
|
|
/* *
|
|
*
|
|
* Class
|
|
*
|
|
* */
|
|
/**
|
|
* The RangeSelectorComponent class
|
|
*
|
|
* @private
|
|
* @class
|
|
* @name Highcharts.RangeSelectorComponent
|
|
*/
|
|
var RangeSelectorComponent = /** @class */ (function (_super) {
|
|
__extends(RangeSelectorComponent, _super);
|
|
function RangeSelectorComponent() {
|
|
/* *
|
|
*
|
|
* Properties
|
|
*
|
|
* */
|
|
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
_this.announcer = void 0;
|
|
return _this;
|
|
}
|
|
/* *
|
|
*
|
|
* Functions
|
|
*
|
|
* */
|
|
/* eslint-disable valid-jsdoc */
|
|
/**
|
|
* Init the component
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.init = function () {
|
|
var chart = this.chart;
|
|
this.announcer = new Announcer(chart, 'polite');
|
|
};
|
|
/**
|
|
* Called on first render/updates to the chart, including options changes.
|
|
*/
|
|
RangeSelectorComponent.prototype.onChartUpdate = function () {
|
|
var chart = this.chart, component = this, rangeSelector = chart.rangeSelector;
|
|
if (!rangeSelector) {
|
|
return;
|
|
}
|
|
this.updateSelectorVisibility();
|
|
this.setDropdownAttrs();
|
|
if (rangeSelector.buttons &&
|
|
rangeSelector.buttons.length) {
|
|
rangeSelector.buttons.forEach(function (button) {
|
|
component.setRangeButtonAttrs(button);
|
|
});
|
|
}
|
|
// Make sure input boxes are accessible and focusable
|
|
if (rangeSelector.maxInput && rangeSelector.minInput) {
|
|
['minInput', 'maxInput'].forEach(function (key, i) {
|
|
var input = rangeSelector[key];
|
|
if (input) {
|
|
unhideChartElementFromAT(chart, input);
|
|
component.setRangeInputAttrs(input, 'accessibility.rangeSelector.' + (i ? 'max' : 'min') +
|
|
'InputLabel');
|
|
}
|
|
});
|
|
}
|
|
};
|
|
/**
|
|
* Hide buttons from AT when showing dropdown, and vice versa.
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.updateSelectorVisibility = function () {
|
|
var chart = this.chart;
|
|
var rangeSelector = chart.rangeSelector;
|
|
var dropdown = (rangeSelector &&
|
|
rangeSelector.dropdown);
|
|
var buttons = (rangeSelector &&
|
|
rangeSelector.buttons ||
|
|
[]);
|
|
var hideFromAT = function (el) { return el.setAttribute('aria-hidden', true); };
|
|
if (rangeSelector &&
|
|
rangeSelector.hasVisibleDropdown &&
|
|
dropdown) {
|
|
unhideChartElementFromAT(chart, dropdown);
|
|
buttons.forEach(function (btn) { return hideFromAT(btn.element); });
|
|
}
|
|
else {
|
|
if (dropdown) {
|
|
hideFromAT(dropdown);
|
|
}
|
|
buttons.forEach(function (btn) { return unhideChartElementFromAT(chart, btn.element); });
|
|
}
|
|
};
|
|
/**
|
|
* Set accessibility related attributes on dropdown element.
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.setDropdownAttrs = function () {
|
|
var chart = this.chart;
|
|
var dropdown = (chart.rangeSelector &&
|
|
chart.rangeSelector.dropdown);
|
|
if (dropdown) {
|
|
var label = chart.langFormat('accessibility.rangeSelector.dropdownLabel', { rangeTitle: chart.options.lang.rangeSelectorZoom });
|
|
dropdown.setAttribute('aria-label', label);
|
|
dropdown.setAttribute('tabindex', -1);
|
|
}
|
|
};
|
|
/**
|
|
* @private
|
|
* @param {Highcharts.SVGElement} button
|
|
*/
|
|
RangeSelectorComponent.prototype.setRangeButtonAttrs = function (button) {
|
|
attr(button.element, {
|
|
tabindex: -1,
|
|
role: 'button'
|
|
});
|
|
};
|
|
/**
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.setRangeInputAttrs = function (input, langKey) {
|
|
var chart = this.chart;
|
|
attr(input, {
|
|
tabindex: -1,
|
|
'aria-label': chart.langFormat(langKey, { chart: chart })
|
|
});
|
|
};
|
|
/**
|
|
* @private
|
|
* @param {Highcharts.KeyboardNavigationHandler} keyboardNavigationHandler
|
|
* @param {number} keyCode
|
|
* @return {number} Response code
|
|
*/
|
|
RangeSelectorComponent.prototype.onButtonNavKbdArrowKey = function (keyboardNavigationHandler, keyCode) {
|
|
var response = keyboardNavigationHandler.response, keys = this.keyCodes, chart = this.chart, wrapAround = chart.options.accessibility
|
|
.keyboardNavigation.wrapAround, direction = (keyCode === keys.left || keyCode === keys.up) ? -1 : 1, didHighlight = chart.highlightRangeSelectorButton(chart.highlightedRangeSelectorItemIx + direction);
|
|
if (!didHighlight) {
|
|
if (wrapAround) {
|
|
keyboardNavigationHandler.init(direction);
|
|
return response.success;
|
|
}
|
|
return response[direction > 0 ? 'next' : 'prev'];
|
|
}
|
|
return response.success;
|
|
};
|
|
/**
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.onButtonNavKbdClick = function (keyboardNavigationHandler) {
|
|
var response = keyboardNavigationHandler.response, chart = this.chart, wasDisabled = chart.oldRangeSelectorItemState === 3;
|
|
if (!wasDisabled) {
|
|
this.fakeClickEvent(chart.rangeSelector.buttons[chart.highlightedRangeSelectorItemIx].element);
|
|
}
|
|
return response.success;
|
|
};
|
|
/**
|
|
* Called whenever a range selector button has been clicked, either by
|
|
* mouse, touch, or kbd/voice/other.
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.onAfterBtnClick = function () {
|
|
var chart = this.chart;
|
|
var axisRangeDescription = getAxisRangeDescription(chart.xAxis[0]);
|
|
var announcement = chart.langFormat('accessibility.rangeSelector.clickButtonAnnouncement', { chart: chart, axisRangeDescription: axisRangeDescription });
|
|
if (announcement) {
|
|
this.announcer.announce(announcement);
|
|
}
|
|
};
|
|
/**
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.onInputKbdMove = function (direction) {
|
|
var chart = this.chart;
|
|
var rangeSel = chart.rangeSelector;
|
|
var newIx = chart.highlightedInputRangeIx = (chart.highlightedInputRangeIx || 0) + direction;
|
|
var newIxOutOfRange = newIx > 1 || newIx < 0;
|
|
if (newIxOutOfRange) {
|
|
if (chart.accessibility) {
|
|
chart.accessibility.keyboardNavigation.tabindexContainer
|
|
.focus();
|
|
chart.accessibility.keyboardNavigation.move(direction);
|
|
}
|
|
}
|
|
else if (rangeSel) {
|
|
var svgEl = rangeSel[newIx ? 'maxDateBox' : 'minDateBox'];
|
|
var inputEl = rangeSel[newIx ? 'maxInput' : 'minInput'];
|
|
if (svgEl && inputEl) {
|
|
chart.setFocusToElement(svgEl, inputEl);
|
|
}
|
|
}
|
|
};
|
|
/**
|
|
* @private
|
|
* @param {number} direction
|
|
*/
|
|
RangeSelectorComponent.prototype.onInputNavInit = function (direction) {
|
|
var _this = this;
|
|
var component = this;
|
|
var chart = this.chart;
|
|
var buttonIxToHighlight = direction > 0 ? 0 : 1;
|
|
var rangeSel = chart.rangeSelector;
|
|
var svgEl = (rangeSel &&
|
|
rangeSel[buttonIxToHighlight ? 'maxDateBox' : 'minDateBox']);
|
|
var minInput = (rangeSel && rangeSel.minInput);
|
|
var maxInput = (rangeSel && rangeSel.maxInput);
|
|
var inputEl = buttonIxToHighlight ? maxInput : minInput;
|
|
chart.highlightedInputRangeIx = buttonIxToHighlight;
|
|
if (svgEl && minInput && maxInput) {
|
|
chart.setFocusToElement(svgEl, inputEl);
|
|
// Tab-press with the input focused does not propagate to chart
|
|
// automatically, so we manually catch and handle it when relevant.
|
|
if (this.removeInputKeydownHandler) {
|
|
this.removeInputKeydownHandler();
|
|
}
|
|
var keydownHandler = function (e) {
|
|
var isTab = (e.which || e.keyCode) === _this.keyCodes.tab;
|
|
if (isTab) {
|
|
e.preventDefault();
|
|
e.stopPropagation();
|
|
component.onInputKbdMove(e.shiftKey ? -1 : 1);
|
|
}
|
|
};
|
|
var minRemover_1 = addEvent(minInput, 'keydown', keydownHandler);
|
|
var maxRemover_1 = addEvent(maxInput, 'keydown', keydownHandler);
|
|
this.removeInputKeydownHandler = function () {
|
|
minRemover_1();
|
|
maxRemover_1();
|
|
};
|
|
}
|
|
};
|
|
/**
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.onInputNavTerminate = function () {
|
|
var rangeSel = (this.chart.rangeSelector || {});
|
|
if (rangeSel.maxInput) {
|
|
rangeSel.hideInput('max');
|
|
}
|
|
if (rangeSel.minInput) {
|
|
rangeSel.hideInput('min');
|
|
}
|
|
if (this.removeInputKeydownHandler) {
|
|
this.removeInputKeydownHandler();
|
|
delete this.removeInputKeydownHandler;
|
|
}
|
|
};
|
|
/**
|
|
* @private
|
|
*/
|
|
RangeSelectorComponent.prototype.initDropdownNav = function () {
|
|
var _this = this;
|
|
var chart = this.chart;
|
|
var rangeSelector = chart.rangeSelector;
|
|
var dropdown = (rangeSelector && rangeSelector.dropdown);
|
|
if (rangeSelector && dropdown) {
|
|
chart.setFocusToElement(rangeSelector.buttonGroup, dropdown);
|
|
if (this.removeDropdownKeydownHandler) {
|
|
this.removeDropdownKeydownHandler();
|
|
}
|
|
// Tab-press with dropdown focused does not propagate to chart
|
|
// automatically, so we manually catch and handle it when relevant.
|
|
this.removeDropdownKeydownHandler = addEvent(dropdown, 'keydown', function (e) {
|
|
var isTab = (e.which || e.keyCode) === _this.keyCodes.tab, a11y = chart.accessibility;
|
|
if (isTab) {
|
|
e.preventDefault();
|
|
e.stopPropagation();
|
|
if (a11y) {
|
|
a11y.keyboardNavigation.tabindexContainer.focus();
|
|
a11y.keyboardNavigation.move(e.shiftKey ? -1 : 1);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
};
|
|
/**
|
|
* Get navigation for the range selector buttons.
|
|
* @private
|
|
* @return {Highcharts.KeyboardNavigationHandler} The module object.
|
|
*/
|
|
RangeSelectorComponent.prototype.getRangeSelectorButtonNavigation = function () {
|
|
var chart = this.chart;
|
|
var keys = this.keyCodes;
|
|
var component = this;
|
|
return new KeyboardNavigationHandler(chart, {
|
|
keyCodeMap: [
|
|
[
|
|
[keys.left, keys.right, keys.up, keys.down],
|
|
function (keyCode) {
|
|
return component.onButtonNavKbdArrowKey(this, keyCode);
|
|
}
|
|
],
|
|
[
|
|
[keys.enter, keys.space],
|
|
function () {
|
|
return component.onButtonNavKbdClick(this);
|
|
}
|
|
]
|
|
],
|
|
validate: function () {
|
|
return !!(chart.rangeSelector &&
|
|
chart.rangeSelector.buttons &&
|
|
chart.rangeSelector.buttons.length);
|
|
},
|
|
init: function (direction) {
|
|
var rangeSelector = chart.rangeSelector;
|
|
if (rangeSelector && rangeSelector.hasVisibleDropdown) {
|
|
component.initDropdownNav();
|
|
}
|
|
else if (rangeSelector) {
|
|
var lastButtonIx = rangeSelector.buttons.length - 1;
|
|
chart.highlightRangeSelectorButton(direction > 0 ? 0 : lastButtonIx);
|
|
}
|
|
},
|
|
terminate: function () {
|
|
if (component.removeDropdownKeydownHandler) {
|
|
component.removeDropdownKeydownHandler();
|
|
delete component.removeDropdownKeydownHandler;
|
|
}
|
|
}
|
|
});
|
|
};
|
|
/**
|
|
* Get navigation for the range selector input boxes.
|
|
* @private
|
|
* @return {Highcharts.KeyboardNavigationHandler}
|
|
* The module object.
|
|
*/
|
|
RangeSelectorComponent.prototype.getRangeSelectorInputNavigation = function () {
|
|
var chart = this.chart;
|
|
var component = this;
|
|
return new KeyboardNavigationHandler(chart, {
|
|
keyCodeMap: [],
|
|
validate: function () {
|
|
return shouldRunInputNavigation(chart);
|
|
},
|
|
init: function (direction) {
|
|
component.onInputNavInit(direction);
|
|
},
|
|
terminate: function () {
|
|
component.onInputNavTerminate();
|
|
}
|
|
});
|
|
};
|
|
/**
|
|
* Get keyboard navigation handlers for this component.
|
|
* @return {Array<Highcharts.KeyboardNavigationHandler>}
|
|
* List of module objects.
|
|
*/
|
|
RangeSelectorComponent.prototype.getKeyboardNavigation = function () {
|
|
return [
|
|
this.getRangeSelectorButtonNavigation(),
|
|
this.getRangeSelectorInputNavigation()
|
|
];
|
|
};
|
|
/**
|
|
* Remove component traces
|
|
*/
|
|
RangeSelectorComponent.prototype.destroy = function () {
|
|
if (this.removeDropdownKeydownHandler) {
|
|
this.removeDropdownKeydownHandler();
|
|
}
|
|
if (this.removeInputKeydownHandler) {
|
|
this.removeInputKeydownHandler();
|
|
}
|
|
if (this.announcer) {
|
|
this.announcer.destroy();
|
|
}
|
|
};
|
|
return RangeSelectorComponent;
|
|
}(AccessibilityComponent));
|
|
/* *
|
|
*
|
|
* Class Namespace
|
|
*
|
|
* */
|
|
(function (RangeSelectorComponent) {
|
|
/* *
|
|
*
|
|
* Declarations
|
|
*
|
|
* */
|
|
/* *
|
|
*
|
|
* Constants
|
|
*
|
|
* */
|
|
var composedClasses = [];
|
|
/* *
|
|
*
|
|
* Functions
|
|
*
|
|
* */
|
|
/* eslint-disable valid-jsdoc */
|
|
/**
|
|
* Highlight range selector button by index.
|
|
*
|
|
* @private
|
|
* @function Highcharts.Chart#highlightRangeSelectorButton
|
|
*/
|
|
function chartHighlightRangeSelectorButton(ix) {
|
|
var buttons = (this.rangeSelector &&
|
|
this.rangeSelector.buttons ||
|
|
[]);
|
|
var curHighlightedIx = this.highlightedRangeSelectorItemIx;
|
|
var curSelectedIx = (this.rangeSelector &&
|
|
this.rangeSelector.selected);
|
|
// Deselect old
|
|
if (typeof curHighlightedIx !== 'undefined' &&
|
|
buttons[curHighlightedIx] &&
|
|
curHighlightedIx !== curSelectedIx) {
|
|
buttons[curHighlightedIx].setState(this.oldRangeSelectorItemState || 0);
|
|
}
|
|
// Select new
|
|
this.highlightedRangeSelectorItemIx = ix;
|
|
if (buttons[ix]) {
|
|
this.setFocusToElement(buttons[ix].box, buttons[ix].element);
|
|
if (ix !== curSelectedIx) {
|
|
this.oldRangeSelectorItemState = buttons[ix].state;
|
|
buttons[ix].setState(1);
|
|
}
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
/**
|
|
* @private
|
|
*/
|
|
function compose(ChartClass, RangeSelectorClass) {
|
|
if (composedClasses.indexOf(ChartClass) === -1) {
|
|
composedClasses.push(ChartClass);
|
|
var chartProto = ChartClass.prototype;
|
|
chartProto.highlightRangeSelectorButton = (chartHighlightRangeSelectorButton);
|
|
}
|
|
if (composedClasses.indexOf(RangeSelectorClass) === -1) {
|
|
composedClasses.push(RangeSelectorClass);
|
|
addEvent(RangeSelector, 'afterBtnClick', rangeSelectorAfterBtnClick);
|
|
}
|
|
}
|
|
RangeSelectorComponent.compose = compose;
|
|
/**
|
|
* Range selector does not have destroy-setup for class instance events - so
|
|
* we set it on the class and call the component from here.
|
|
* @private
|
|
*/
|
|
function rangeSelectorAfterBtnClick() {
|
|
var a11y = this.chart.accessibility;
|
|
if (a11y && a11y.components.rangeSelector) {
|
|
return a11y.components.rangeSelector.onAfterBtnClick();
|
|
}
|
|
}
|
|
})(RangeSelectorComponent || (RangeSelectorComponent = {}));
|
|
/* *
|
|
*
|
|
* Export Default
|
|
*
|
|
* */
|
|
export default RangeSelectorComponent;
|