@pingux/astro 2.13.0-alpha.3 → 2.13.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/components/HelpHint/HelpHint.js +145 -27
- package/lib/cjs/components/HelpHint/HelpHint.mdx +2 -2
- package/lib/cjs/components/HelpHint/HelpHint.stories.js +40 -7
- package/lib/cjs/components/HelpHint/HelpHint.styles.js +9 -1
- package/lib/cjs/components/HelpHint/HelpHint.test.js +213 -30
- package/lib/cjs/components/Link/Link.styles.js +10 -0
- package/lib/cjs/components/TooltipTrigger/Tooltip.styles.js +2 -1
- package/lib/cjs/components/TooltipTrigger/TooltipTrigger.js +2 -0
- package/lib/cjs/components/TooltipTrigger/TooltipTrigger.mdx +2 -0
- package/lib/cjs/components/TooltipTrigger/TooltipTrigger.test.js +47 -1
- package/lib/cjs/utils/designUtils/figmaLinks.js +2 -1
- package/lib/components/HelpHint/HelpHint.js +148 -30
- package/lib/components/HelpHint/HelpHint.mdx +2 -2
- package/lib/components/HelpHint/HelpHint.stories.js +37 -6
- package/lib/components/HelpHint/HelpHint.styles.js +9 -1
- package/lib/components/HelpHint/HelpHint.test.js +213 -30
- package/lib/components/Link/Link.styles.js +10 -0
- package/lib/components/TooltipTrigger/Tooltip.styles.js +1 -1
- package/lib/components/TooltipTrigger/TooltipTrigger.js +2 -0
- package/lib/components/TooltipTrigger/TooltipTrigger.mdx +2 -0
- package/lib/components/TooltipTrigger/TooltipTrigger.test.js +48 -2
- package/lib/utils/designUtils/figmaLinks.js +2 -1
- package/package.json +2 -2
@@ -12,7 +12,7 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
|
|
12
12
|
_Object$defineProperty(exports, "__esModule", {
|
13
13
|
value: true
|
14
14
|
});
|
15
|
-
exports["default"] = exports.button = void 0;
|
15
|
+
exports["default"] = exports.container = exports.button = void 0;
|
16
16
|
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
|
17
17
|
var _Badge = require("../Badge/Badge.styles");
|
18
18
|
var _Buttons = require("../Button/Buttons.styles");
|
@@ -33,6 +33,7 @@ var container = {
|
|
33
33
|
WebkitLineClamp: '4'
|
34
34
|
}
|
35
35
|
};
|
36
|
+
exports.container = container;
|
36
37
|
var badge = _objectSpread(_objectSpread({}, _Badge.baseBadge), {}, {
|
37
38
|
cursor: 'default',
|
38
39
|
'&.is-hovered, &.is-pressed': {
|
@@ -100,6 +100,8 @@ TooltipTrigger.propTypes = {
|
|
100
100
|
/** The additional offset applied along the cross axis
|
101
101
|
* between the element and its anchor element. */
|
102
102
|
crossOffset: _propTypes["default"].number,
|
103
|
+
/** Amount of time before the tooltip disappears */
|
104
|
+
closeDelay: _propTypes["default"].number,
|
103
105
|
/** Amount of time before the tooltip shows */
|
104
106
|
delay: _propTypes["default"].number,
|
105
107
|
/** Where the popover menu opens relative to its trigger. */
|
@@ -10,6 +10,8 @@ This component is typically used as a design fallback for contextual information
|
|
10
10
|
This component should provide useful, supplementary information or clarification regarding the element it points to.
|
11
11
|
It shouldn’t contain essential content, error or feedback messages, or action items.
|
12
12
|
|
13
|
+
Tooltips cannot contain interactive content (links, buttons) according to the [ARIA Authoring Practices Guide](https://www.w3.org/WAI/ARIA/apg/patterns/tooltip/).
|
14
|
+
|
13
15
|
### Required Components
|
14
16
|
|
15
17
|
This component requires the [Button](./?path=/docs/components-button--default) and Tooltip components.
|
@@ -1,6 +1,17 @@
|
|
1
1
|
"use strict";
|
2
2
|
|
3
|
+
var _typeof = require("@babel/runtime-corejs3/helpers/typeof");
|
4
|
+
var _Symbol = require("@babel/runtime-corejs3/core-js-stable/symbol");
|
5
|
+
var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
|
6
|
+
var _Object$create = require("@babel/runtime-corejs3/core-js-stable/object/create");
|
7
|
+
var _Object$getPrototypeOf = require("@babel/runtime-corejs3/core-js-stable/object/get-prototype-of");
|
8
|
+
var _forEachInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/for-each");
|
9
|
+
var _Object$setPrototypeOf = require("@babel/runtime-corejs3/core-js-stable/object/set-prototype-of");
|
10
|
+
var _Promise = require("@babel/runtime-corejs3/core-js-stable/promise");
|
11
|
+
var _reverseInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/reverse");
|
12
|
+
var _sliceInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/slice");
|
3
13
|
var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
|
14
|
+
var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/asyncToGenerator"));
|
4
15
|
var _react = _interopRequireDefault(require("react"));
|
5
16
|
var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
|
6
17
|
var _index = require("../../index");
|
@@ -8,6 +19,7 @@ var _theme = _interopRequireDefault(require("../../styles/theme"));
|
|
8
19
|
var _testAxe = _interopRequireDefault(require("../../utils/testUtils/testAxe"));
|
9
20
|
var _testWrapper = require("../../utils/testUtils/testWrapper");
|
10
21
|
var _react2 = require("@emotion/react");
|
22
|
+
function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, $Symbol = "function" == typeof _Symbol ? _Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return _Object$defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = _Object$create(protoGenerator.prototype), context = new Context(tryLocsList || []); return generator._invoke = function (innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; }(innerFn, self, context), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = _Object$getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = _Object$create(IteratorPrototype); function defineIteratorMethods(prototype) { var _context2; _forEachInstanceProperty(_context2 = ["next", "throw", "return"]).call(_context2, function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; this._invoke = function (method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); }; } function maybeInvokeDelegate(delegate, context) { var method = delegate.iterator[context.method]; if (undefined === method) { if (context.delegate = null, "throw" === context.method) { if (delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method)) return ContinueSentinel; context.method = "throw", context.arg = new TypeError("The iterator does not provide a 'throw' method"); } return ContinueSentinel; } var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], _forEachInstanceProperty(tryLocsList).call(tryLocsList, pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, define(Gp, "constructor", GeneratorFunctionPrototype), define(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return _Object$setPrototypeOf ? _Object$setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = _Object$create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = _Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (object) { var keys = []; for (var key in object) { keys.push(key); } return _reverseInstanceProperty(keys).call(keys), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { var _context3; if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, _forEachInstanceProperty(_context3 = this.tryEntries).call(_context3, resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+_sliceInstanceProperty(name).call(name, 1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
|
11
23
|
var getComponent = function getComponent() {
|
12
24
|
var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
|
13
25
|
return (0, _testWrapper.render)((0, _react2.jsx)(_index.TooltipTrigger, props, (0, _react2.jsx)(_index.Button, props.buttonProps, "Mock Button"), (0, _react2.jsx)(_index.Tooltip, null, "Tooltip Content")));
|
@@ -81,4 +93,38 @@ test('passing in width applies the correct width to the container', function ()
|
|
81
93
|
});
|
82
94
|
var arrow = _testWrapper.screen.getByTestId('popover-container');
|
83
95
|
expect(arrow).toHaveStyle('width: 100px');
|
84
|
-
});
|
96
|
+
});
|
97
|
+
test('tooltip closes after closeDelay when mouse leaves trigger', /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
|
98
|
+
var closeDelay, button;
|
99
|
+
return _regeneratorRuntime().wrap(function _callee$(_context) {
|
100
|
+
while (1) {
|
101
|
+
switch (_context.prev = _context.next) {
|
102
|
+
case 0:
|
103
|
+
closeDelay = 5000;
|
104
|
+
getComponent({
|
105
|
+
closeDelay: closeDelay
|
106
|
+
});
|
107
|
+
button = _testWrapper.screen.getByRole('button');
|
108
|
+
_testWrapper.fireEvent.mouseEnter(button);
|
109
|
+
expect(_testWrapper.screen.queryByRole('tooltip')).toBeInTheDocument();
|
110
|
+
_testWrapper.fireEvent.mouseLeave(button);
|
111
|
+
_context.next = 8;
|
112
|
+
return (0, _testWrapper.waitFor)(function () {
|
113
|
+
expect(_testWrapper.screen.queryByRole('tooltip')).toBeInTheDocument();
|
114
|
+
}, {
|
115
|
+
timeout: closeDelay / 2 + 100
|
116
|
+
});
|
117
|
+
case 8:
|
118
|
+
_context.next = 10;
|
119
|
+
return (0, _testWrapper.waitFor)(function () {
|
120
|
+
expect(_testWrapper.screen.queryByRole('tooltip')).not.toBeInTheDocument();
|
121
|
+
}, {
|
122
|
+
timeout: closeDelay + 100
|
123
|
+
});
|
124
|
+
case 10:
|
125
|
+
case "end":
|
126
|
+
return _context.stop();
|
127
|
+
}
|
128
|
+
}
|
129
|
+
}, _callee);
|
130
|
+
})));
|
@@ -38,7 +38,8 @@ var FIGMA_LINKS = {
|
|
38
38
|
"default": 'https://www.figma.com/file/bpbEw54gTTcdIiZs4PKK1p/Astro-Specs?type=design&node-id=218-1442&t=8Wwd3tIBh3GEjCJB-0'
|
39
39
|
},
|
40
40
|
helpHint: {
|
41
|
-
"default": 'https://www.figma.com/file/Oa6VYtJcUJzEJuuRp0p4ls/Astro?type=design&node-id=0%3A4534&t=We3h7LaaFJQnxdSy-1'
|
41
|
+
"default": 'https://www.figma.com/file/Oa6VYtJcUJzEJuuRp0p4ls/Astro?type=design&node-id=0%3A4534&t=We3h7LaaFJQnxdSy-1',
|
42
|
+
withLink: 'https://www.figma.com/file/bpbEw54gTTcdIiZs4PKK1p/Astro-Specs?type=design&node-id=28958%3A40081&mode=design&t=WmSYPx1hR8kxFiXf-1'
|
42
43
|
},
|
43
44
|
icon: {
|
44
45
|
"default": 'https://www.figma.com/file/bpbEw54gTTcdIiZs4PKK1p/Astro-Specs?type=design&node-id=24360%3A49754&t=3b86het2R9G2Zyo2-1'
|
@@ -1,14 +1,16 @@
|
|
1
1
|
import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
|
2
|
+
import _slicedToArray from "@babel/runtime-corejs3/helpers/esm/slicedToArray";
|
2
3
|
import _objectWithoutProperties from "@babel/runtime-corejs3/helpers/esm/objectWithoutProperties";
|
3
|
-
var _excluded = ["children", "
|
4
|
-
import
|
5
|
-
import
|
4
|
+
var _excluded = ["align", "arrowCrossOffset", "children", "className", "closeDelay", "direction", "hasNoArrow", "iconButtonProps", "isDarkMode", "isNotFlippable", "offset", "popoverProps"];
|
5
|
+
import _setTimeout from "@babel/runtime-corejs3/core-js-stable/set-timeout";
|
6
|
+
import _concatInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/concat";
|
7
|
+
import React, { forwardRef, useEffect, useImperativeHandle, useRef, useState } from 'react';
|
8
|
+
import { FocusScope, mergeProps, useFocusRing, useFocusWithin, useOverlayPosition, useOverlayTrigger } from 'react-aria';
|
9
|
+
import { useOverlayTriggerState } from 'react-stately';
|
6
10
|
import { useHover } from '@react-aria/interactions';
|
7
11
|
import PropTypes from 'prop-types';
|
8
|
-
import {
|
9
|
-
import {
|
10
|
-
import IconButton from '../IconButton';
|
11
|
-
import TooltipTrigger, { Tooltip } from '../TooltipTrigger';
|
12
|
+
import { Box, Icon, IconButton, PopoverContainer } from '../..';
|
13
|
+
import { useStatusClasses } from '../../hooks';
|
12
14
|
import { jsx as ___EmotionJSX } from "@emotion/react";
|
13
15
|
var HelpIcon = function HelpIcon() {
|
14
16
|
return ___EmotionJSX("svg", {
|
@@ -26,42 +28,158 @@ var HelpIcon = function HelpIcon() {
|
|
26
28
|
}));
|
27
29
|
};
|
28
30
|
var HelpHint = /*#__PURE__*/forwardRef(function (props, ref) {
|
29
|
-
var
|
30
|
-
|
31
|
+
var _context;
|
32
|
+
var align = props.align,
|
33
|
+
arrowCrossOffset = props.arrowCrossOffset,
|
34
|
+
children = props.children,
|
35
|
+
className = props.className,
|
36
|
+
closeDelay = props.closeDelay,
|
37
|
+
direction = props.direction,
|
38
|
+
hasNoArrow = props.hasNoArrow,
|
31
39
|
iconButtonProps = props.iconButtonProps,
|
40
|
+
isDarkMode = props.isDarkMode,
|
41
|
+
isNotFlippable = props.isNotFlippable,
|
42
|
+
offset = props.offset,
|
43
|
+
popoverProps = props.popoverProps,
|
32
44
|
others = _objectWithoutProperties(props, _excluded);
|
33
|
-
var
|
34
|
-
|
45
|
+
var _useState = useState(false),
|
46
|
+
_useState2 = _slicedToArray(_useState, 2),
|
47
|
+
isFocusWithinOverlay = _useState2[0],
|
48
|
+
setIsFocusWithinOverlay = _useState2[1];
|
49
|
+
var _useFocusWithin = useFocusWithin({
|
50
|
+
onFocusWithinChange: function onFocusWithinChange(isFocusWithin) {
|
51
|
+
return setIsFocusWithinOverlay(isFocusWithin);
|
52
|
+
}
|
53
|
+
}),
|
54
|
+
focusWithinProps = _useFocusWithin.focusWithinProps;
|
55
|
+
var overlayRef = useRef();
|
56
|
+
var triggerRef = useRef(null);
|
35
57
|
var _useFocusRing = useFocusRing(),
|
36
58
|
focusProps = _useFocusRing.focusProps,
|
37
59
|
isFocusVisible = _useFocusRing.isFocusVisible;
|
38
60
|
var _useHover = useHover({}),
|
39
61
|
hoverProps = _useHover.hoverProps,
|
40
62
|
isHovered = _useHover.isHovered;
|
41
|
-
var
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
63
|
+
var _useHover2 = useHover({}),
|
64
|
+
overlayHoverProps = _useHover2.hoverProps,
|
65
|
+
isOverlayHovered = _useHover2.isHovered;
|
66
|
+
var popoverState = useOverlayTriggerState({});
|
67
|
+
var open = popoverState.open,
|
68
|
+
close = popoverState.close,
|
69
|
+
isOpen = popoverState.isOpen;
|
70
|
+
var _useOverlayTrigger = useOverlayTrigger({
|
71
|
+
type: 'dialog'
|
72
|
+
}, popoverState, triggerRef),
|
73
|
+
triggerProps = _useOverlayTrigger.triggerProps,
|
74
|
+
overlayProps = _useOverlayTrigger.overlayProps;
|
75
|
+
|
76
|
+
/* istanbul ignore next */
|
77
|
+
useImperativeHandle(ref, function () {
|
78
|
+
return triggerRef.current;
|
79
|
+
});
|
80
|
+
|
81
|
+
// Set a timeout to close the overlay upon hover / focus loss,
|
82
|
+
// but keep it open if the trigger or overlay are hovered again before it closes.
|
83
|
+
useEffect(function () {
|
84
|
+
var timeout;
|
85
|
+
if (isHovered || isOverlayHovered || isFocusWithinOverlay) {
|
86
|
+
open();
|
87
|
+
} else {
|
88
|
+
timeout = _setTimeout(close, closeDelay || 1000);
|
89
|
+
}
|
90
|
+
return function () {
|
91
|
+
clearTimeout(timeout);
|
92
|
+
};
|
93
|
+
}, [isHovered, isOverlayHovered, isFocusWithinOverlay, open, close, closeDelay]);
|
94
|
+
useEffect(function () {
|
95
|
+
if (isOpen) {
|
96
|
+
return triggerRef === null || triggerRef === void 0 ? void 0 : triggerRef.current.setAttribute('aria-expanded', 'true');
|
97
|
+
}
|
98
|
+
return triggerRef === null || triggerRef === void 0 ? void 0 : triggerRef.current.setAttribute('aria-expanded', 'false');
|
99
|
+
}, [isOpen]);
|
100
|
+
var _useOverlayPosition = useOverlayPosition({
|
101
|
+
targetRef: triggerRef,
|
102
|
+
overlayRef: overlayRef,
|
103
|
+
placement: _concatInstanceProperty(_context = "".concat(direction, " ")).call(_context, align),
|
104
|
+
offset: 15,
|
105
|
+
isOpen: isOpen,
|
106
|
+
onClose: close,
|
107
|
+
shouldUpdatePosition: true,
|
108
|
+
shouldFlip: !isNotFlippable
|
109
|
+
}),
|
110
|
+
positionProps = _useOverlayPosition.overlayProps,
|
111
|
+
placement = _useOverlayPosition.placement;
|
112
|
+
var _useStatusClasses = useStatusClasses(className, {
|
113
|
+
isDarkMode: isDarkMode
|
114
|
+
}),
|
115
|
+
classNames = _useStatusClasses.classNames;
|
116
|
+
return ___EmotionJSX(Box, _extends({}, others, {
|
117
|
+
ref: ref
|
118
|
+
}), ___EmotionJSX(IconButton, _extends({
|
119
|
+
ref: triggerRef,
|
50
120
|
"aria-label": "label help hint",
|
51
121
|
"data-testid": "help-hint__button",
|
52
|
-
"
|
53
|
-
}, iconButtonProps,
|
122
|
+
variant: "hintButton"
|
123
|
+
}, mergeProps(triggerProps, iconButtonProps, focusProps, hoverProps)), ___EmotionJSX(Icon, {
|
54
124
|
icon: HelpIcon
|
55
|
-
})), ___EmotionJSX(
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
125
|
+
})), ___EmotionJSX(PopoverContainer, _extends({
|
126
|
+
arrowCrossOffset: arrowCrossOffset,
|
127
|
+
arrowProps: {
|
128
|
+
width: '8px',
|
129
|
+
height: '4px'
|
130
|
+
},
|
131
|
+
className: classNames,
|
132
|
+
direction: direction,
|
133
|
+
hasNoArrow: hasNoArrow,
|
134
|
+
isDismissable: !isOpen,
|
135
|
+
isNonModal: true,
|
136
|
+
isOpen: isOpen,
|
137
|
+
onClose: close,
|
138
|
+
placement: placement,
|
139
|
+
ref: overlayRef
|
140
|
+
}, mergeProps(overlayProps, positionProps, popoverProps, overlayHoverProps), focusWithinProps), ___EmotionJSX(FocusScope, {
|
141
|
+
restoreFocus: true,
|
142
|
+
autoFocus: isFocusVisible
|
143
|
+
}, ___EmotionJSX(Box, {
|
144
|
+
variant: "helpHint.popoverContainer"
|
145
|
+
}, children))));
|
60
146
|
});
|
61
147
|
HelpHint.propTypes = {
|
62
|
-
/** Props object that is spread directly into the
|
63
|
-
|
148
|
+
/** Props object that is spread directly into the popover element. */
|
149
|
+
popoverProps: PropTypes.shape({}),
|
64
150
|
/** Props object that is spread directly into the IconButton element. */
|
65
|
-
iconButtonProps: PropTypes.shape({})
|
151
|
+
iconButtonProps: PropTypes.shape({}),
|
152
|
+
/** Defaults to true, displays dark popover with white text */
|
153
|
+
isDarkMode: PropTypes.bool,
|
154
|
+
/** Where the popover menu opens relative to its trigger. */
|
155
|
+
direction: PropTypes.oneOf(['top', 'right', 'bottom', 'left']),
|
156
|
+
/**
|
157
|
+
* Whether the popover is prevented from flipping directions when insufficient space is
|
158
|
+
* available for the given `direction` placement.
|
159
|
+
*/
|
160
|
+
isNotFlippable: PropTypes.bool,
|
161
|
+
/** Alignment of the popover menu relative to the trigger. */
|
162
|
+
align: PropTypes.oneOf(['start', 'end', 'middle']),
|
163
|
+
/**
|
164
|
+
* Allows to add an arrow to popover container
|
165
|
+
*/
|
166
|
+
hasNoArrow: PropTypes.bool,
|
167
|
+
/** Popover offset relative to its trigger. */
|
168
|
+
offset: PropTypes.number,
|
169
|
+
/** Arrow offset relative to the left of the popover.
|
170
|
+
* Must be passed as a px or percentage. */
|
171
|
+
arrowCrossOffset: PropTypes.string,
|
172
|
+
/** The additional offset applied along the cross axis
|
173
|
+
* between the element and its anchor element. */
|
174
|
+
crossOffset: PropTypes.number,
|
175
|
+
/** Amount of time before the popover closes */
|
176
|
+
closeDelay: PropTypes.number
|
177
|
+
};
|
178
|
+
HelpHint.defaultProps = {
|
179
|
+
align: 'middle',
|
180
|
+
direction: 'top',
|
181
|
+
hasNoArrow: false,
|
182
|
+
isDarkMode: true,
|
183
|
+
isNotFlippable: false
|
66
184
|
};
|
67
185
|
export default HelpHint;
|
@@ -6,7 +6,7 @@ import { Meta } from '@storybook/addon-docs';
|
|
6
6
|
|
7
7
|
HelpHints display information intended to help users enter, select or provide the appropriate information in a field. This component can be customized, and consists of the [TooltipTrigger](./?path=/docs/components-tooltiptrigger--default) and [IconButton](./?path=/docs/components-iconbutton--default).
|
8
8
|
|
9
|
-
When implementing this component, use short, clear language and a text size relative to the trigger button. They should not block important information when the
|
9
|
+
When implementing this component, use short, clear language and a text size relative to the trigger button. They should not block important information when the popover displays, nor should it be used to communicate important information.
|
10
10
|
|
11
11
|
### Required Components
|
12
12
|
|
@@ -27,6 +27,6 @@ These keys provide additional functionality to the component.
|
|
27
27
|
#### Screen Readers
|
28
28
|
|
29
29
|
This component uses the following attributes to assist screen readers:
|
30
|
-
- The trigger button uses
|
30
|
+
- The trigger button uses **`aria-expanded`** to indicate the expansion and collapse of the popover.
|
31
31
|
- The **`aria-live`** attribute announces the dynamic changes in live region content.
|
32
32
|
|
@@ -1,7 +1,9 @@
|
|
1
|
+
import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
|
1
2
|
import React from 'react';
|
2
3
|
import { withDesign } from 'storybook-addon-designs';
|
3
4
|
import DocsLayout from '../../../.storybook/storybookDocsLayout';
|
4
|
-
import { Box, HelpHint } from '../../index';
|
5
|
+
import { Box, HelpHint, Link, Text } from '../../index';
|
6
|
+
import { isSafari } from '../../styles/safariAgent';
|
5
7
|
import { FIGMA_LINKS } from '../../utils/designUtils/figmaLinks.js';
|
6
8
|
import HelpHintReadme from './HelpHint.mdx';
|
7
9
|
import { jsx as ___EmotionJSX } from "@emotion/react";
|
@@ -18,14 +20,14 @@ export default {
|
|
18
20
|
},
|
19
21
|
argTypes: {
|
20
22
|
children: {
|
21
|
-
description: '
|
23
|
+
description: 'Popover content',
|
22
24
|
control: {
|
23
25
|
type: 'text'
|
24
26
|
}
|
25
27
|
}
|
26
28
|
},
|
27
29
|
args: {
|
28
|
-
children: 'Text of the
|
30
|
+
children: 'Text of the popover right here...'
|
29
31
|
}
|
30
32
|
};
|
31
33
|
export var Default = function Default(args) {
|
@@ -39,15 +41,44 @@ Default.parameters = {
|
|
39
41
|
url: FIGMA_LINKS.helpHint["default"]
|
40
42
|
}
|
41
43
|
};
|
42
|
-
export var
|
44
|
+
export var WithPopoverAndIconButtonProps = function WithPopoverAndIconButtonProps() {
|
43
45
|
return ___EmotionJSX(Box, {
|
44
46
|
p: 50
|
45
47
|
}, ___EmotionJSX(HelpHint, {
|
46
|
-
|
48
|
+
popoverProps: {
|
47
49
|
direction: 'bottom'
|
48
50
|
},
|
49
51
|
iconButtonProps: {
|
50
52
|
'aria-label': 'Help hint'
|
51
53
|
}
|
52
|
-
}, "Text of the
|
54
|
+
}, "Text of the popover right here..."));
|
55
|
+
};
|
56
|
+
export var ContentWithLink = function ContentWithLink() {
|
57
|
+
return ___EmotionJSX(Box, {
|
58
|
+
p: 70
|
59
|
+
}, ___EmotionJSX(HelpHint, null, ___EmotionJSX(Text, {
|
60
|
+
variant: "popover"
|
61
|
+
}, "Text of the popover right here... "), isSafari ? ___EmotionJSX(Box, {
|
62
|
+
href: "https://uilibrary.ping-eng.com/",
|
63
|
+
as: "a",
|
64
|
+
pl: "xs"
|
65
|
+
}, ___EmotionJSX(Link, {
|
66
|
+
variant: "popover"
|
67
|
+
}, "Learn More")) : ___EmotionJSX(Link, {
|
68
|
+
variant: "popover",
|
69
|
+
href: "https://uilibrary.ping-eng.com/"
|
70
|
+
}, "Learn More")));
|
71
|
+
};
|
72
|
+
ContentWithLink.parameters = {
|
73
|
+
design: {
|
74
|
+
type: 'figma',
|
75
|
+
url: FIGMA_LINKS.helpHint.withLink
|
76
|
+
}
|
77
|
+
};
|
78
|
+
export var WithDelay = function WithDelay(args) {
|
79
|
+
return ___EmotionJSX(Box, {
|
80
|
+
p: 50
|
81
|
+
}, ___EmotionJSX(HelpHint, _extends({}, args, {
|
82
|
+
closeDelay: 5000
|
83
|
+
})));
|
53
84
|
};
|
@@ -10,6 +10,7 @@ import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
|
|
10
10
|
function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
|
11
11
|
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty(_context = ownKeys(Object(source), !0)).call(_context, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : _forEachInstanceProperty(_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
|
12
12
|
import { defaultFocus } from '../Button/Buttons.styles';
|
13
|
+
import { container } from '../TooltipTrigger/Tooltip.styles.js';
|
13
14
|
export var hintButton = {
|
14
15
|
bg: 'neutral.90',
|
15
16
|
borderColor: 'active',
|
@@ -45,6 +46,13 @@ export var hintButton = {
|
|
45
46
|
}
|
46
47
|
}
|
47
48
|
};
|
49
|
+
var popoverContainer = _objectSpread(_objectSpread({}, container), {}, {
|
50
|
+
p: '10px',
|
51
|
+
fontSize: 'sm',
|
52
|
+
fontWeight: 1,
|
53
|
+
width: '117px'
|
54
|
+
});
|
48
55
|
export default {
|
49
|
-
hintButton: hintButton
|
56
|
+
hintButton: hintButton,
|
57
|
+
popoverContainer: popoverContainer
|
50
58
|
};
|