@atlaskit/editor-common
Version:
A package that contains common classes and components for editor and renderer
63 lines (58 loc) • 3.43 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof = require("@babel/runtime/helpers/typeof");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
var _react = _interopRequireWildcard(require("react"));
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
// How to use:
// https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions#Preferring_specialized_live_region_roles
// Demo: https://dequeuniversity.com/library/aria/liveregion-playground
// Important: Strongly recommend test your solution in all supported screen readers
// if you use non default value of properties: ariaAtomic, ariaLive, ariaRelevant, role
// Note: Text won't be announced if the text message doesn't change after the render.
// For using a forced announcement in this case, set the 'key' attribute - key={Date.now()}
// Note: Flag 'contentRendered' resolves bug with duplicates messages (NVDA + Firefox)
// https://github.com/nvaccess/nvda/labels/bug%2Fdouble-speaking
var timer;
var Announcer = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
var _ref$ariaAtomic = _ref.ariaAtomic,
ariaAtomic = _ref$ariaAtomic === void 0 ? 'true' : _ref$ariaAtomic,
_ref$ariaLive = _ref.ariaLive,
ariaLive = _ref$ariaLive === void 0 ? 'polite' : _ref$ariaLive,
_ref$ariaRelevant = _ref.ariaRelevant,
ariaRelevant = _ref$ariaRelevant === void 0 ? 'all' : _ref$ariaRelevant,
_ref$role = _ref.role,
role = _ref$role === void 0 ? 'status' : _ref$role,
_ref$text = _ref.text,
text = _ref$text === void 0 ? '' : _ref$text,
_ref$delay = _ref.delay,
delay = _ref$delay === void 0 ? 0 : _ref$delay;
var _useState = (0, _react.useState)(false),
_useState2 = (0, _slicedToArray2.default)(_useState, 2),
contentRendered = _useState2[0],
setContentRendered = _useState2[1];
(0, _react.useEffect)(function () {
clearTimeout(timer);
setContentRendered(false);
timer = setTimeout(function () {
setContentRendered(true);
}, delay);
return function () {
return clearTimeout(timer);
};
}, [text, delay]);
return /*#__PURE__*/_react.default.createElement("div", {
className: "assistive",
ref: ref,
role: role,
"aria-atomic": ariaAtomic,
"aria-relevant": ariaRelevant,
"aria-live": ariaLive
}, contentRendered && /*#__PURE__*/_react.default.createElement("span", null, text));
});
var _default = exports.default = /*#__PURE__*/(0, _react.memo)(Announcer);