@deque/cauldron-react 4.1.0-canary.d1059d02 → 4.1.0-canary.fcf29799

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/cauldron.css CHANGED
@@ -34,7 +34,8 @@
34
34
  --expandcollapse-panel-color: var(--accent-light);
35
35
  }
36
36
 
37
- a.Button--primary {
37
+ a.Button--primary,
38
+ a.Button--secondary {
38
39
  text-decoration: none;
39
40
  padding: 9px 18px;
40
41
  }
@@ -1,10 +1,11 @@
1
1
  import React from 'react';
2
2
  import PropTypes from 'prop-types';
3
- export interface ClickOutsideListenerProps {
4
- children: React.ReactNode;
3
+ export interface ClickOutsideListenerProps<T extends HTMLElement = HTMLElement> {
4
+ children?: React.ReactNode;
5
5
  onClickOutside: (e: MouseEvent | TouchEvent) => void;
6
6
  mouseEvent?: 'mousedown' | 'click' | 'mouseup' | false;
7
7
  touchEvent?: 'touchstart' | 'touchend' | false;
8
+ target?: T;
8
9
  }
9
10
  export default class ClickOutsideListener extends React.Component<ClickOutsideListenerProps> {
10
11
  static defaultProps: {
@@ -12,7 +13,8 @@ export default class ClickOutsideListener extends React.Component<ClickOutsideLi
12
13
  touchEvent: string;
13
14
  };
14
15
  static propTypes: {
15
- children: PropTypes.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
16
+ children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
17
+ target: PropTypes.Requireable<any>;
16
18
  onClickOutside: PropTypes.Validator<(...args: any[]) => any>;
17
19
  mouseEvent: PropTypes.Requireable<string | boolean>;
18
20
  touchEvent: PropTypes.Requireable<string | boolean>;
@@ -27,5 +29,5 @@ export default class ClickOutsideListener extends React.Component<ClickOutsideLi
27
29
  resolveRef: (node: HTMLElement) => void;
28
30
  render(): React.FunctionComponentElement<{
29
31
  ref: (node: HTMLElement) => void;
30
- }>;
32
+ }> | null;
31
33
  }
@@ -2,7 +2,7 @@ import React from 'react';
2
2
  import PropTypes from 'prop-types';
3
3
  export interface LinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
4
4
  linkRef?: React.Ref<HTMLAnchorElement>;
5
- variant?: 'button';
5
+ variant?: 'button' | 'button-secondary';
6
6
  }
7
7
  declare const Link: {
8
8
  ({ children, linkRef, className, variant, ...other }: LinkProps): JSX.Element;
@@ -1,8 +1,7 @@
1
1
  import React from 'react';
2
2
  import PropTypes from 'prop-types';
3
- interface BaseStepProps {
3
+ interface BaseStepProps extends React.LiHTMLAttributes<HTMLLIElement> {
4
4
  status: 'current' | 'complete' | 'future';
5
- className?: string;
6
5
  }
7
6
  interface StepWithChildren extends BaseStepProps {
8
7
  children: React.ReactNode;
@@ -11,7 +11,7 @@ export interface TooltipProps extends React.HTMLAttributes<HTMLDivElement> {
11
11
  portal?: React.RefObject<HTMLElement> | HTMLElement;
12
12
  hideElementOnHidden?: boolean;
13
13
  }
14
- declare function Tooltip({ id: propId, placement: initialPlacement, children, portal, target, association, variant, show: showProp, hideElementOnHidden, className, ...props }: TooltipProps): React.ReactPortal | null;
14
+ declare function Tooltip({ id: propId, placement: initialPlacement, children, portal, target, association, variant, show: initialShow, hideElementOnHidden, className, ...props }: TooltipProps): React.ReactPortal | null;
15
15
  declare namespace Tooltip {
16
16
  var displayName: string;
17
17
  var propTypes: {
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ interface ColumnGroupHeaderProps extends React.HTMLAttributes<HTMLDivElement> {
3
+ }
4
+ declare const ColumnGroupHeader: React.ForwardRefExoticComponent<ColumnGroupHeaderProps & React.RefAttributes<HTMLDivElement>>;
5
+ export default ColumnGroupHeader;
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ interface ColumnHeaderProps extends React.HTMLAttributes<HTMLDivElement> {
3
+ }
4
+ declare const ColumnHeader: React.ForwardRefExoticComponent<ColumnHeaderProps & React.RefAttributes<HTMLDivElement>>;
5
+ export default ColumnHeader;
@@ -0,0 +1,7 @@
1
+ import React from 'react';
2
+ declare const ColumnLeft: React.ForwardRefExoticComponent<(React.HTMLAttributes<HTMLDivElement> & {
3
+ 'aria-label': string;
4
+ } & React.RefAttributes<HTMLDivElement>) | (React.HTMLAttributes<HTMLDivElement> & {
5
+ 'aria-labelledby': string;
6
+ } & React.RefAttributes<HTMLDivElement>)>;
7
+ export default ColumnLeft;
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ interface ColumnListProps extends React.HTMLAttributes<HTMLDivElement> {
3
+ }
4
+ declare const ColumnList: React.ForwardRefExoticComponent<ColumnListProps & React.RefAttributes<HTMLDivElement>>;
5
+ export default ColumnList;
@@ -0,0 +1,7 @@
1
+ import React from 'react';
2
+ declare const ColumnRight: React.ForwardRefExoticComponent<(React.HTMLAttributes<HTMLDivElement> & {
3
+ 'aria-label': string;
4
+ } & React.RefAttributes<HTMLDivElement>) | (React.HTMLAttributes<HTMLDivElement> & {
5
+ 'aria-labelledby': string;
6
+ } & React.RefAttributes<HTMLDivElement>)>;
7
+ export default ColumnRight;
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ interface TwoColumnPanelProps extends React.HTMLAttributes<HTMLDivElement> {
3
+ initialCollapsed?: boolean;
4
+ showCollapsedPanelLabel?: string;
5
+ hideCollapsedPanelLabel?: string;
6
+ }
7
+ declare const TwoColumnPanel: React.ForwardRefExoticComponent<TwoColumnPanelProps & React.RefAttributes<HTMLDivElement>>;
8
+ export default TwoColumnPanel;
@@ -0,0 +1,6 @@
1
+ export { default } from './TwoColumnPanel';
2
+ export { default as ColumnHeader } from './ColumnHeader';
3
+ export { default as ColumnGroupHeader } from './ColumnGroupHeader';
4
+ export { default as ColumnLeft } from './ColumnLeft';
5
+ export { default as ColumnRight } from './ColumnRight';
6
+ export { default as ColumnList } from './ColumnList';
package/lib/index.d.ts CHANGED
@@ -48,6 +48,7 @@ export { Address, AddressLine, AddressCityStateZip } from './components/Address'
48
48
  export { default as Pagination } from './components/Pagination';
49
49
  export { default as FieldWrap } from './components/FieldWrap';
50
50
  export { default as Breadcrumb, BreadcrumbItem, BreadcrumbLink } from './components/Breadcrumb';
51
+ export { default as TwoColumnPanel, ColumnHeader, ColumnGroupHeader, ColumnLeft, ColumnRight, ColumnList } from './components/TwoColumnPanel';
51
52
  /**
52
53
  * Helpers / Utils
53
54
  */
package/lib/index.js CHANGED
@@ -608,12 +608,13 @@ var ClickOutsideListener = /** @class */ (function (_super) {
608
608
  var _this = _super !== null && _super.apply(this, arguments) || this;
609
609
  _this.handleEvent = function (event) {
610
610
  var _a = _this, nodeRef = _a.nodeRef, props = _a.props;
611
- var onClickOutside = props.onClickOutside;
611
+ var onClickOutside = props.onClickOutside, target = props.target;
612
612
  if (event.defaultPrevented) {
613
613
  return;
614
614
  }
615
- var target = event.target;
616
- if (nodeRef && !nodeRef.contains(target)) {
615
+ var eventTarget = event.target;
616
+ if ((target && !target.contains(eventTarget)) ||
617
+ (nodeRef && !nodeRef.contains(eventTarget))) {
617
618
  onClickOutside(event);
618
619
  }
619
620
  };
@@ -656,16 +657,19 @@ var ClickOutsideListener = /** @class */ (function (_super) {
656
657
  };
657
658
  ClickOutsideListener.prototype.render = function () {
658
659
  var _a = this, props = _a.props, resolveRef = _a.resolveRef;
659
- return React__default.cloneElement(props.children, {
660
- ref: resolveRef
661
- });
660
+ return !props.children
661
+ ? null
662
+ : React__default.cloneElement(props.children, {
663
+ ref: resolveRef
664
+ });
662
665
  };
663
666
  ClickOutsideListener.defaultProps = {
664
667
  mouseEvent: 'click',
665
668
  touchEvent: 'touchend'
666
669
  };
667
670
  ClickOutsideListener.propTypes = {
668
- children: PropTypes.node.isRequired,
671
+ children: PropTypes.node,
672
+ target: PropTypes.any,
669
673
  onClickOutside: PropTypes.func.isRequired,
670
674
  mouseEvent: PropTypes.oneOf(['mousedown', 'click', 'mouseup', false]),
671
675
  touchEvent: PropTypes.oneOf(['touchstart', 'touchend', false])
@@ -1475,15 +1479,14 @@ var fireCustomEvent = function (show, button) {
1475
1479
  };
1476
1480
  function Tooltip(_a) {
1477
1481
  var _this = this;
1478
- var propId = _a.id, _b = _a.placement, initialPlacement = _b === void 0 ? 'auto' : _b, children = _a.children, portal = _a.portal, target = _a.target, _c = _a.association, association = _c === void 0 ? 'aria-describedby' : _c, _d = _a.variant, variant = _d === void 0 ? 'text' : _d, _e = _a.show, showProp = _e === void 0 ? false : _e, _f = _a.hideElementOnHidden, hideElementOnHidden = _f === void 0 ? false : _f, className = _a.className, props = tslib.__rest(_a, ["id", "placement", "children", "portal", "target", "association", "variant", "show", "hideElementOnHidden", "className"]);
1482
+ var propId = _a.id, _b = _a.placement, initialPlacement = _b === void 0 ? 'auto' : _b, children = _a.children, portal = _a.portal, target = _a.target, _c = _a.association, association = _c === void 0 ? 'aria-describedby' : _c, _d = _a.variant, variant = _d === void 0 ? 'text' : _d, _e = _a.show, initialShow = _e === void 0 ? false : _e, _f = _a.hideElementOnHidden, hideElementOnHidden = _f === void 0 ? false : _f, className = _a.className, props = tslib.__rest(_a, ["id", "placement", "children", "portal", "target", "association", "variant", "show", "hideElementOnHidden", "className"]);
1479
1483
  var _g = tslib.__read(propId ? [propId] : nextId.useId(1, 'tooltip'), 1), id = _g[0];
1480
- var hovering = React.useRef(false);
1481
- var _h = tslib.__read(React.useState(initialPlacement), 2), placement = _h[0], setPlacement = _h[1];
1482
- var _j = tslib.__read(React.useState(!!showProp), 2), showTooltip = _j[0], setShowTooltip = _j[1];
1483
- var _k = tslib.__read(React.useState(null), 2), targetElement = _k[0], setTargetElement = _k[1];
1484
- var _l = tslib.__read(React.useState(null), 2), tooltipElement = _l[0], setTooltipElement = _l[1];
1485
- var _m = tslib.__read(React.useState(null), 2), arrowElement = _m[0], setArrowElement = _m[1];
1486
- var _o = reactPopper.usePopper(targetElement, tooltipElement, {
1484
+ var hideTimeoutRef = React.useRef(null);
1485
+ var _h = tslib.__read(React.useState(!!initialShow), 2), showTooltip = _h[0], setShowTooltip = _h[1];
1486
+ var _j = tslib.__read(React.useState(null), 2), targetElement = _j[0], setTargetElement = _j[1];
1487
+ var _k = tslib.__read(React.useState(null), 2), tooltipElement = _k[0], setTooltipElement = _k[1];
1488
+ var _l = tslib.__read(React.useState(null), 2), arrowElement = _l[0], setArrowElement = _l[1];
1489
+ var _m = reactPopper.usePopper(targetElement, tooltipElement, {
1487
1490
  placement: initialPlacement,
1488
1491
  modifiers: [
1489
1492
  { name: 'preventOverflow', options: { padding: 8 } },
@@ -1491,11 +1494,17 @@ function Tooltip(_a) {
1491
1494
  { name: 'offset', options: { offset: [0, 8] } },
1492
1495
  { name: 'arrow', options: { padding: 5, element: arrowElement } }
1493
1496
  ]
1494
- }), styles = _o.styles, attributes = _o.attributes, update = _o.update;
1495
- var show = function () { return tslib.__awaiter(_this, void 0, void 0, function () {
1497
+ }), styles = _m.styles, attributes = _m.attributes, update = _m.update;
1498
+ // Show the tooltip
1499
+ var show = React.useCallback(function () { return tslib.__awaiter(_this, void 0, void 0, function () {
1496
1500
  return tslib.__generator(this, function (_a) {
1497
1501
  switch (_a.label) {
1498
1502
  case 0:
1503
+ // Clear the hide timeout if there was one pending
1504
+ if (hideTimeoutRef.current) {
1505
+ clearTimeout(hideTimeoutRef.current);
1506
+ hideTimeoutRef.current = null;
1507
+ }
1499
1508
  if (!update) return [3 /*break*/, 2];
1500
1509
  return [4 /*yield*/, update()];
1501
1510
  case 1:
@@ -1507,45 +1516,31 @@ function Tooltip(_a) {
1507
1516
  return [2 /*return*/];
1508
1517
  }
1509
1518
  });
1510
- }); };
1511
- var hide = function (_a) {
1512
- var target = _a.target;
1513
- if (document.activeElement !== target) {
1514
- setTimeout(function () {
1515
- if (!hovering.current) {
1516
- setShowTooltip(false);
1517
- fireCustomEvent(false, targetElement);
1518
- }
1519
+ }); }, [
1520
+ targetElement,
1521
+ // update starts off as null
1522
+ update
1523
+ ]);
1524
+ // Hide the tooltip
1525
+ var hide = React.useCallback(function () {
1526
+ if (!hideTimeoutRef.current) {
1527
+ hideTimeoutRef.current = setTimeout(function () {
1528
+ hideTimeoutRef.current = null;
1529
+ setShowTooltip(false);
1530
+ fireCustomEvent(false, targetElement);
1519
1531
  }, TIP_HIDE_DELAY);
1520
1532
  }
1521
- };
1522
- var handleTriggerMouseEnter = function () {
1523
- hovering.current = true;
1524
- show();
1525
- };
1526
- var handleTriggerMouseLeave = function (e) {
1527
- hovering.current = false;
1528
- hide(e);
1529
- };
1530
- var handleTipMouseEnter = function () {
1531
- hovering.current = true;
1532
- };
1533
- var handleTipMouseLeave = function (e) {
1534
- hovering.current = false;
1535
- hide(e);
1536
- };
1533
+ }, [targetElement]);
1534
+ // Keep targetElement in sync with target prop
1537
1535
  React.useEffect(function () {
1538
1536
  var targetElement = target && 'current' in target ? target.current : target;
1539
1537
  setTargetElement(targetElement);
1540
1538
  }, [target]);
1541
- var popperPlacement = (attributes.popper &&
1539
+ // Get popper placement
1540
+ var placement = (attributes.popper &&
1542
1541
  attributes.popper['data-popper-placement']) ||
1543
1542
  initialPlacement;
1544
- React.useEffect(function () {
1545
- if (popperPlacement) {
1546
- setPlacement(popperPlacement);
1547
- }
1548
- }, [popperPlacement]);
1543
+ // Only listen to key ups when the tooltip is visible
1549
1544
  React.useEffect(function () {
1550
1545
  var handleEscape = function (event) {
1551
1546
  if (event.key === 'Escape' ||
@@ -1564,31 +1559,30 @@ function Tooltip(_a) {
1564
1559
  return function () {
1565
1560
  targetElement.removeEventListener('keyup', handleEscape);
1566
1561
  };
1567
- }, [showProp]);
1562
+ }, [showTooltip]);
1563
+ // Handle hover and focus events for the targetElement
1568
1564
  React.useEffect(function () {
1569
- if (typeof showProp !== undefined) {
1570
- targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('mouseenter', handleTriggerMouseEnter);
1571
- targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('mouseleave', handleTriggerMouseLeave);
1572
- targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('focusin', show);
1573
- targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('focusout', hide);
1574
- }
1565
+ targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('mouseenter', show);
1566
+ targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('mouseleave', hide);
1567
+ targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('focusin', show);
1568
+ targetElement === null || targetElement === void 0 ? void 0 : targetElement.addEventListener('focusout', hide);
1575
1569
  return function () {
1576
1570
  targetElement === null || targetElement === void 0 ? void 0 : targetElement.removeEventListener('mouseenter', show);
1577
1571
  targetElement === null || targetElement === void 0 ? void 0 : targetElement.removeEventListener('mouseleave', hide);
1578
1572
  targetElement === null || targetElement === void 0 ? void 0 : targetElement.removeEventListener('focusin', show);
1579
1573
  targetElement === null || targetElement === void 0 ? void 0 : targetElement.removeEventListener('focusout', hide);
1580
1574
  };
1581
- }, [targetElement, showProp]);
1575
+ }, [targetElement, show, hide]);
1576
+ // Handle hover events for the tooltipElement
1582
1577
  React.useEffect(function () {
1583
- if (tooltipElement) {
1584
- tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.addEventListener('mouseenter', handleTipMouseEnter);
1585
- tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.addEventListener('mouseleave', handleTipMouseLeave);
1586
- }
1578
+ tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.addEventListener('mouseenter', show);
1579
+ tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.addEventListener('mouseleave', hide);
1587
1580
  return function () {
1588
- tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.removeEventListener('mouseenter', handleTipMouseEnter);
1589
- tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.removeEventListener('mouseleave', handleTipMouseLeave);
1581
+ tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.removeEventListener('mouseenter', show);
1582
+ tooltipElement === null || tooltipElement === void 0 ? void 0 : tooltipElement.removeEventListener('mouseleave', hide);
1590
1583
  };
1591
- }, [tooltipElement]);
1584
+ }, [tooltipElement, show, hide]);
1585
+ // Keep the target's id in sync
1592
1586
  React.useEffect(function () {
1593
1587
  var attrText = targetElement === null || targetElement === void 0 ? void 0 : targetElement.getAttribute(association);
1594
1588
  if (!(attrText === null || attrText === void 0 ? void 0 : attrText.includes(id || ''))) {
@@ -2022,7 +2016,7 @@ var queryAll = function (selector, context) {
2022
2016
  var typeMap = {
2023
2017
  confirmation: {
2024
2018
  className: 'success',
2025
- icon: 'info-circle'
2019
+ icon: 'check-circle'
2026
2020
  },
2027
2021
  caution: {
2028
2022
  className: 'warning',
@@ -2196,7 +2190,8 @@ var Link = function (_a) {
2196
2190
  var children = _a.children, linkRef = _a.linkRef, className = _a.className, variant = _a.variant, other = tslib.__rest(_a, ["children", "linkRef", "className", "variant"]);
2197
2191
  return (React__default.createElement("a", tslib.__assign({ ref: linkRef, className: classNames(className, {
2198
2192
  Link: !variant,
2199
- 'Button--primary': variant === 'button'
2193
+ 'Button--primary': variant === 'button',
2194
+ 'Button--secondary': variant === 'button-secondary'
2200
2195
  }) }, other), children));
2201
2196
  };
2202
2197
  Link.propTypes = {
@@ -8275,23 +8270,34 @@ var DescriptionDetails = function (_a) {
8275
8270
  DescriptionDetails.displayName = 'DescriptionDetails';
8276
8271
  DescriptionDetails.propTypes = commonPropTypes;
8277
8272
 
8278
- var isTooltip = function (props) {
8273
+ var isTooltipProps = function (props) {
8279
8274
  return !!props.tooltip;
8280
8275
  };
8281
8276
  var Step = function (props) {
8282
- var status = props.status, className = props.className, other = tslib.__rest(props, ["status", "className"]);
8283
- return (React__default.createElement("li", tslib.__assign({ className: classNames('Stepper__step', "Stepper__step--" + status, className), "aria-current": status === 'current' ? 'step' : 'false' }, other),
8277
+ var _a;
8278
+ var children = props.children, status = props.status, className = props.className, other = tslib.__rest(props, ["children", "status", "className"]);
8279
+ var tooltip;
8280
+ var tooltipText;
8281
+ var liProps;
8282
+ var isTooltip = isTooltipProps(other);
8283
+ if (isTooltip) {
8284
+ (_a = other, (tooltip = _a.tooltip, tooltipText = _a.tooltipText, _a), liProps = tslib.__rest(_a, ["tooltip", "tooltipText"]));
8285
+ }
8286
+ else {
8287
+ liProps = other;
8288
+ }
8289
+ return (React__default.createElement("li", tslib.__assign({ className: classNames('Stepper__step', "Stepper__step--" + status, className), "aria-current": status === 'current' ? 'step' : 'false' }, liProps),
8284
8290
  React__default.createElement("div", { className: "Stepper__step-line" }),
8285
- React__default.createElement("div", { className: "Stepper__step-content" }, isTooltip(props) ? (React__default.createElement(TooltipTabstop, { placement: "bottom", tooltip: props.tooltip,
8291
+ React__default.createElement("div", { className: "Stepper__step-content" }, isTooltip ? (React__default.createElement(TooltipTabstop, { placement: "bottom", tooltip: tooltip,
8286
8292
  // the pseudo content (ex: "1") is conveyed
8287
8293
  // by the list item's position in the set of
8288
8294
  // list items, therefore it is safe to clobber
8289
8295
  // it with the contents of the tooltip in the
8290
8296
  // tab stop's accessible name.
8291
- association: "aria-labelledby", "aria-label": isTooltip(props) ? props.tooltipText : undefined },
8297
+ association: "aria-labelledby", "aria-label": tooltipText },
8292
8298
  React__default.createElement("div", { className: "Stepper__step-indicator" }))) : (React__default.createElement(React__default.Fragment, null,
8293
8299
  React__default.createElement("div", { className: "Stepper__step-indicator" }),
8294
- 'children' in props && (React__default.createElement("div", { className: "Stepper__step-label" }, props.children)))))));
8300
+ children ? (React__default.createElement("div", { className: "Stepper__step-label" }, children)) : null)))));
8295
8301
  };
8296
8302
  Step.displayName = 'Step';
8297
8303
  Step.propTypes = {
@@ -8481,6 +8487,172 @@ var BreadcrumbLink = React.forwardRef(function (_a, ref) {
8481
8487
  return (React__default.createElement(ElementType, tslib.__assign({ className: classNames('Link', 'Breadcrumb__Link', className), ref: ref }, props), children));
8482
8488
  });
8483
8489
 
8490
+ var TwoColumnPanel = React.forwardRef(function (_a, ref) {
8491
+ var className = _a.className, children = _a.children, _b = _a.initialCollapsed, initialCollapsed = _b === void 0 ? false : _b, _c = _a.showCollapsedPanelLabel, showCollapsedPanelLabel = _c === void 0 ? 'Show Panel' : _c, _d = _a.hideCollapsedPanelLabel, hideCollapsedPanelLabel = _d === void 0 ? 'Hide Panel' : _d, props = tslib.__rest(_a, ["className", "children", "initialCollapsed", "showCollapsedPanelLabel", "hideCollapsedPanelLabel"]);
8492
+ var _e = tslib.__read(React.useState(initialCollapsed), 2), isCollapsed = _e[0], setCollapsed = _e[1];
8493
+ var _f = tslib.__read(React.useState(false), 2), isFocusTrap = _f[0], setIsFocusTrap = _f[1];
8494
+ var _g = tslib.__read(React.useState(!initialCollapsed), 2), showPanel = _g[0], setShowPanel = _g[1];
8495
+ var togglePanel = function () {
8496
+ if (isCollapsed) {
8497
+ setShowPanel(true);
8498
+ }
8499
+ // Set collapsed state on next tick so css transitions can be applied
8500
+ requestAnimationFrame(function () {
8501
+ var _a, _b;
8502
+ var collapsed = !isCollapsed;
8503
+ setCollapsed(collapsed);
8504
+ if (!collapsed) {
8505
+ (_a = columnLeftRef.current) === null || _a === void 0 ? void 0 : _a.focus();
8506
+ }
8507
+ else {
8508
+ (_b = columnRightRef.current) === null || _b === void 0 ? void 0 : _b.focus();
8509
+ }
8510
+ });
8511
+ };
8512
+ var toggleButtonRef = React.useRef(null);
8513
+ var closeButtonRef = React.useRef(null);
8514
+ var columnLeftRef = React.useRef(null);
8515
+ var columnRightRef = React.useRef(null);
8516
+ var columnLeft = React__default.Children.toArray(children).find(function (child) { return child.type === ColumnLeft; });
8517
+ // The ColumnLeftComponent will end up being a focus trap when < 720px
8518
+ // This component also gets unmounted when not visible meaning that any
8519
+ // aria relationships cannot be set to items inside the component since
8520
+ // they will not be present in the dom
8521
+ var ColumnLeftComponent;
8522
+ var columnLeftId;
8523
+ if (React.isValidElement(columnLeft)) {
8524
+ var ref_1 = columnLeft.props.ref || columnLeftRef;
8525
+ var id = (columnLeftId =
8526
+ columnLeft.props.id || nextId.useId(undefined, 'sidebar-')[0]);
8527
+ var CloseButton = (React__default.createElement("div", { className: "TwoColumnPanel__Close" },
8528
+ React__default.createElement("button", { type: "button", onClick: togglePanel, ref: closeButtonRef, "aria-label": hideCollapsedPanelLabel },
8529
+ React__default.createElement(Icon, { type: "close" })),
8530
+ React__default.createElement(Tooltip, { target: closeButtonRef, association: "aria-labelledby", hideElementOnHidden: true }, hideCollapsedPanelLabel)));
8531
+ var children_1 = tslib.__spread([
8532
+ CloseButton
8533
+ ], React__default.Children.toArray(columnLeft.props.children));
8534
+ ColumnLeftComponent = React.cloneElement(columnLeft, { id: id, ref: ref_1, tabIndex: -1 }, children_1.map(function (child, index) {
8535
+ return React.cloneElement(child, { key: "left-" + index });
8536
+ }));
8537
+ }
8538
+ var columnRight = React__default.Children.toArray(children).find(function (child) { return child.type === ColumnRight; });
8539
+ var ColumnRightComponent;
8540
+ if (React.isValidElement(columnRight)) {
8541
+ var ref_2 = columnRight.props.ref || columnRightRef;
8542
+ var ToggleButton = (React__default.createElement("div", { className: "TwoColumnPanel__ButtonToggle" },
8543
+ React__default.createElement("button", { type: "button", onClick: togglePanel, ref: toggleButtonRef, "aria-label": !isCollapsed ? hideCollapsedPanelLabel : showCollapsedPanelLabel, "aria-expanded": !isCollapsed, "aria-controls": columnLeftId },
8544
+ React__default.createElement(Icon, { type: !isCollapsed ? 'chevron-double-left' : 'chevron-double-right' })),
8545
+ React__default.createElement(Tooltip, { target: toggleButtonRef, association: "aria-labelledby", hideElementOnHidden: true }, !isCollapsed ? hideCollapsedPanelLabel : showCollapsedPanelLabel)));
8546
+ var children_2 = tslib.__spread([
8547
+ ToggleButton
8548
+ ], React__default.Children.toArray(columnRight.props.children));
8549
+ ColumnRightComponent = React.cloneElement(columnRight, { ref: ref_2, tabIndex: -1 }, children_2.map(function (child, index) {
8550
+ return React.cloneElement(child, { key: "right-" + index });
8551
+ }));
8552
+ }
8553
+ React.useLayoutEffect(function () {
8554
+ var _a;
8555
+ var handleTransitionEnd = function () {
8556
+ if (columnLeftRef.current && isCollapsed) {
8557
+ setShowPanel(false);
8558
+ }
8559
+ };
8560
+ (_a = columnLeftRef.current) === null || _a === void 0 ? void 0 : _a.addEventListener('transitionend', handleTransitionEnd);
8561
+ return function () {
8562
+ var _a;
8563
+ (_a = columnLeftRef.current) === null || _a === void 0 ? void 0 : _a.removeEventListener('transitionend', handleTransitionEnd);
8564
+ };
8565
+ }, [columnLeftRef.current, isCollapsed]);
8566
+ // When the collapsable panel starts to overlay content, it needs to become a focus trap and collapsed by default
8567
+ React.useLayoutEffect(function () {
8568
+ var mediaQueryList = matchMedia('(max-width: 45rem)');
8569
+ var handleMatch = function (matches) {
8570
+ setIsFocusTrap(matches);
8571
+ var collapsed = matches ? true : isCollapsed;
8572
+ setCollapsed(collapsed);
8573
+ setShowPanel(!collapsed);
8574
+ };
8575
+ var listener = function (_a) {
8576
+ var matches = _a.matches;
8577
+ return handleMatch(matches);
8578
+ };
8579
+ if (mediaQueryList.matches) {
8580
+ handleMatch(mediaQueryList.matches);
8581
+ }
8582
+ mediaQueryList.addEventListener('change', listener);
8583
+ return function () {
8584
+ mediaQueryList.removeEventListener('change', listener);
8585
+ };
8586
+ }, []);
8587
+ React.useEffect(function () {
8588
+ var handleEscape = function (event) {
8589
+ if (event.key === 'Escape' ||
8590
+ event.key === 'Esc' ||
8591
+ event.keyCode === 27) {
8592
+ setCollapsed(true);
8593
+ }
8594
+ };
8595
+ var targetElement = document.body;
8596
+ if (isFocusTrap) {
8597
+ targetElement.addEventListener('keyup', handleEscape);
8598
+ }
8599
+ else {
8600
+ targetElement.removeEventListener('keyup', handleEscape);
8601
+ }
8602
+ return function () {
8603
+ targetElement.removeEventListener('keyup', handleEscape);
8604
+ };
8605
+ }, [isFocusTrap]);
8606
+ var handleClickOutside = function () {
8607
+ if (!isCollapsed && isFocusTrap) {
8608
+ setCollapsed(true);
8609
+ }
8610
+ };
8611
+ return (React__default.createElement("div", tslib.__assign({ className: classNames('TwoColumnPanel', className, {
8612
+ 'TwoColumnPanel--show': !isCollapsed,
8613
+ 'TwoColumnPanel--hide': isCollapsed
8614
+ }) }, props, { ref: ref }),
8615
+ React__default.createElement(FocusTrap, { active: !isCollapsed && isFocusTrap, focusTrapOptions: {
8616
+ escapeDeactivates: true,
8617
+ allowOutsideClick: true,
8618
+ fallbackFocus: columnLeftRef.current
8619
+ }, containerElements: [columnLeftRef.current] }),
8620
+ React__default.createElement(ClickOutsideListener, { onClickOutside: handleClickOutside, target: columnLeftRef.current }),
8621
+ showPanel ? ColumnLeftComponent : null,
8622
+ ColumnRightComponent));
8623
+ });
8624
+ TwoColumnPanel.displayName = 'TwoColumnPanel';
8625
+
8626
+ var ColumnHeader = React.forwardRef(function (_a, ref) {
8627
+ var className = _a.className, children = _a.children, props = tslib.__rest(_a, ["className", "children"]);
8628
+ return (React__default.createElement("div", tslib.__assign({ className: classNames('TwoColumnPanel__Header', className) }, props, { ref: ref }), children));
8629
+ });
8630
+ ColumnHeader.displayName = 'ColumnHeader';
8631
+
8632
+ var ColumnGroupHeader = React.forwardRef(function (_a, ref) {
8633
+ var className = _a.className, children = _a.children, props = tslib.__rest(_a, ["className", "children"]);
8634
+ return (React__default.createElement("div", tslib.__assign({ className: classNames('TwoColumnPanel__GroupHeader', className) }, props, { ref: ref }), children));
8635
+ });
8636
+ ColumnGroupHeader.displayName = 'ColumnGroupHeader';
8637
+
8638
+ var ColumnLeft = React.forwardRef(function (_a, ref) {
8639
+ var className = _a.className, children = _a.children, props = tslib.__rest(_a, ["className", "children"]);
8640
+ return (React__default.createElement("section", tslib.__assign({ className: classNames('TwoColumnPanel__Left', className) }, props, { ref: ref }), children));
8641
+ });
8642
+ ColumnLeft.displayName = 'ColumnLeft';
8643
+
8644
+ var ColumnRight = React.forwardRef(function (_a, ref) {
8645
+ var className = _a.className, children = _a.children, props = tslib.__rest(_a, ["className", "children"]);
8646
+ return (React__default.createElement("section", tslib.__assign({ className: classNames('TwoColumnPanel__Right', className) }, props, { ref: ref }), children));
8647
+ });
8648
+ ColumnRight.displayName = 'ColumnRight';
8649
+
8650
+ var ColumnList = React.forwardRef(function (_a, ref) {
8651
+ var className = _a.className, children = _a.children, props = tslib.__rest(_a, ["className", "children"]);
8652
+ return (React__default.createElement("div", tslib.__assign({ className: classNames('TwoColumnPanel__List', className) }, props, { ref: ref }), children));
8653
+ });
8654
+ ColumnList.displayName = 'ColumnList';
8655
+
8484
8656
  var LIGHT_THEME_CLASS = 'cauldron--theme-light';
8485
8657
  var DARK_THEME_CLASS = 'cauldron--theme-dark';
8486
8658
  var ThemeContext = React.createContext({});
@@ -8558,6 +8730,11 @@ exports.CardHeader = CardHeader;
8558
8730
  exports.Checkbox = Checkbox;
8559
8731
  exports.ClickOutsideListener = ClickOutsideListener;
8560
8732
  exports.Code = Code;
8733
+ exports.ColumnGroupHeader = ColumnGroupHeader;
8734
+ exports.ColumnHeader = ColumnHeader;
8735
+ exports.ColumnLeft = ColumnLeft;
8736
+ exports.ColumnList = ColumnList;
8737
+ exports.ColumnRight = ColumnRight;
8561
8738
  exports.DescriptionDetails = DescriptionDetails;
8562
8739
  exports.DescriptionList = DescriptionList;
8563
8740
  exports.DescriptionListItem = DescriptionListItem;
@@ -8626,6 +8803,7 @@ exports.TopBar = TopBar$1;
8626
8803
  exports.TopBarItem = MenuItem;
8627
8804
  exports.TopBarMenu = TopBarMenu;
8628
8805
  exports.TopBarTrigger = TopBarTrigger;
8806
+ exports.TwoColumnPanel = TwoColumnPanel;
8629
8807
  exports.Workspace = Workspace;
8630
8808
  exports.focusableSelector = focusableSelector;
8631
8809
  exports.iconTypes = iconTypes;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deque/cauldron-react",
3
- "version": "4.1.0-canary.d1059d02",
3
+ "version": "4.1.0-canary.fcf29799",
4
4
  "description": "Fully accessible react components library for Deque Cauldron",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -23,7 +23,7 @@
23
23
  "dependencies": {
24
24
  "@popperjs/core": "^2.5.4",
25
25
  "classnames": "^2.2.6",
26
- "focus-trap-react": "^3.0.5",
26
+ "focus-trap-react": "^8.9.0",
27
27
  "focusable": "^2.3.0",
28
28
  "keyname": "^0.1.0",
29
29
  "prop-types": "^15.6.0",