@pingux/astro 2.32.0-alpha.8 → 2.32.0

package/lib/components/TreeView/TreeView.test.js

@@ -1,9 +1,13 @@
 import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
 import React from 'react';
 import { useTreeData } from 'react-stately';
+import userEvent from '@testing-library/user-event';
+import PropTypes from 'prop-types';
 import { Item } from '../../index';
-import { fireEvent, render, screen } from '../../utils/testUtils/testWrapper';
+import { render, screen } from '../../utils/testUtils/testWrapper';
 import { SectionOrItemRender } from './TreeView';
+import { refArray } from './TreeViewKeyboardDelegate.test';
+import { addRefToArrayHelper, removeRefFromArrayHelper } from './TreeViewSection';
 import TreeView from '.';
 import { jsx as ___EmotionJSX } from "@emotion/react";
 var testId = 'test-TreeView';
@@ -40,9 +44,12 @@ var data = [{
 }, {
   title: 'Single Item'
 }];
+var singleData = [{
+  title: 'Single Item'
+}];
 var TreeViewComponent = function TreeViewComponent(props) {
   var tree = useTreeData({
-    initialItems: data,
+    initialItems: props.data,
     getKey: function getKey(item) {
       return item.title;
     },
@@ -62,6 +69,9 @@ var TreeViewComponent = function TreeViewComponent(props) {
     });
   });
 };
+TreeViewComponent.propTypes = {
+  data: PropTypes.arrayOf(PropTypes.shape({}))
+};
 var offsetWidth;
 var offsetHeight;
 var scrollHeight;
@@ -95,16 +105,20 @@ test('TreeView component does load', function () {
   expect(element).toBeInTheDocument();
 });
 test('Can select an Item using the mouse', function () {
-  render(___EmotionJSX(TreeViewComponent, null));
+  render(___EmotionJSX(TreeViewComponent, {
+    data: data
+  }));
   var element = screen.queryByRole('treegrid');
   expect(element).toBeInTheDocument();
   var peopleElement = screen.queryByText('Single Item');
   expect(peopleElement).not.toHaveClass('is-selected');
-  fireEvent.click(peopleElement);
+  userEvent.click(peopleElement);
   expect(peopleElement).toHaveClass('is-selected');
 });
 test('Renders both Sections and Items', function () {
-  render(___EmotionJSX(TreeViewComponent, null));
+  render(___EmotionJSX(TreeViewComponent, {
+    data: data
+  }));
   var peopleElement = screen.getByText('Single Item');
   expect(peopleElement).toBeInTheDocument();
   var plantElement = screen.getByText('Other');
@@ -113,7 +127,9 @@ test('Renders both Sections and Items', function () {
   expect(allListItems).toHaveLength(3);
 });
 test('Can expand an Item using the mouse', function () {
-  render(___EmotionJSX(TreeViewComponent, null));
+  render(___EmotionJSX(TreeViewComponent, {
+    data: data
+  }));
 
   // The children of collapsed sections will not
   // be rendered by default.
@@ -122,47 +138,91 @@ test('Can expand an Item using the mouse', function () {
   // Clicking the dropdown icon, renders the children
   // of the collapsed section.
   var buttons = screen.queryAllByRole('button');
-  fireEvent.click(buttons[0]);
+  userEvent.click(buttons[0]);
   expect(screen.queryByText(data[0].items[0].title)).toBeInTheDocument();
 });
 test('onExpandedChange change prop calls when used', function () {
   var onPress = jest.fn();
   render(___EmotionJSX(TreeViewComponent, {
+    data: data,
     onExpandedChange: onPress
   }));
   expect(onPress).not.toHaveBeenCalled();
   var buttons = screen.queryAllByRole('button');
-  fireEvent.click(buttons[0]);
+  userEvent.click(buttons[0]);
   expect(onPress).toHaveBeenCalled();
 });
 test('disabledKeys prop disables items in the tree -- rendering them unclickable', function () {
   render(___EmotionJSX(TreeViewComponent, {
+    data: data,
     disabledKeys: ['Single Item']
   }));
   var listItems = screen.queryAllByRole('treeitem');
   var thisItem = listItems[2];
   expect(thisItem).not.toHaveClass('is-selected');
   expect(thisItem).toHaveAttribute('aria-disabled', 'true');
-  fireEvent.mouseDown(thisItem);
-  fireEvent.mouseUp(thisItem);
+  userEvent.click(thisItem);
   expect(thisItem).not.toHaveClass('is-selected');
   expect(thisItem).toHaveAttribute('aria-selected', 'false');
 });
 test('displays correct aria attributes', function () {
-  render(___EmotionJSX(TreeViewComponent, null));
+  render(___EmotionJSX(TreeViewComponent, {
+    data: data
+  }));
   var listItems = screen.getAllByRole('treeitem');
   var lastTreeItem = listItems[2];
   expect(lastTreeItem).toHaveAttribute('aria-level', '1');
   expect(lastTreeItem).toHaveAttribute('aria-posinset', '3');
   expect(lastTreeItem).toHaveAttribute('aria-setsize', '3');
   var buttons = screen.queryAllByRole('button');
-  fireEvent.click(buttons[1]);
+  userEvent.click(buttons[1]);
   var expandedItems = screen.getAllByRole('treeitem');
   var nestedItem = expandedItems[2];
   expect(nestedItem).toHaveAttribute('aria-level', '2');
   expect(nestedItem).toHaveAttribute('aria-posinset', '1');
   expect(nestedItem).toHaveAttribute('aria-setsize', '1');
 });
+test('onKeyDown calls passed in prop call back function', function () {
+  var callback = jest.fn();
+  render(___EmotionJSX(TreeViewComponent, {
+    data: data,
+    onKeyDown: callback
+  }));
+  var listItems = screen.queryAllByRole('treeitem');
+  var thisItem = listItems[0];
+  userEvent.type(thisItem, '{arrowleft}');
+  expect(callback).toHaveBeenCalled();
+});
+test('onKeyDown calls passed in prop call back function', function () {
+  var callback = jest.fn();
+  render(___EmotionJSX(TreeViewComponent, {
+    data: data,
+    onKeyDown: callback
+  }));
+  var listItems = screen.queryAllByRole('treeitem');
+  var thisItem = listItems[2];
+  userEvent.type(thisItem, '{arrowleft}');
+  expect(callback).toHaveBeenCalled();
+});
+test('onKeyDown does not call passed in prop call back function', function () {
+  var callback = jest.fn();
+  render(___EmotionJSX(TreeViewComponent, {
+    data: data
+  }));
+  var listItems = screen.queryAllByRole('treeitem');
+  var thisItem = listItems[2];
+  userEvent.type(thisItem, '{arrowleft}');
+  expect(callback).not.toHaveBeenCalled();
+});
+test('items still render if there is only one provided', function () {
+  var callback = jest.fn();
+  render(___EmotionJSX(TreeViewComponent, {
+    data: singleData,
+    onKeyDown: callback
+  }));
+  var listItem = screen.queryByText('Single Item');
+  expect(listItem).toBeInTheDocument();
+});
 var firstJSX = ___EmotionJSX("p", null, "first");
 var secondJSX = ___EmotionJSX("p", null, "second");
 test('Section or Item Render renders first item if condition is true', function () {
@@ -176,4 +236,24 @@ test('Section or Item Render renders second item if condition is false', functio
   var thisItem = screen.getByText('second');
   expect(thisItem).toBeInTheDocument();
   expect(screen.queryByText('first')).not.toBeInTheDocument();
+});
+test('Handler function removes ref from array', function () {
+  var newArray = removeRefFromArrayHelper(refArray, 'test');
+  expect(newArray).toHaveLength(2);
+});
+test('Handler function does not remove ref from array', function () {
+  var newArray = removeRefFromArrayHelper(refArray, 'anothertest');
+  expect(newArray).toHaveLength(3);
+});
+test('Handler function does add ref to array', function () {
+  var newArray = addRefToArrayHelper(refArray, 'yetanothertest', {
+    current: 'currentlystilltesting'
+  });
+  expect(newArray).toHaveLength(4);
+});
+test('Handler function does not add ref to array', function () {
+  var newArray = addRefToArrayHelper(refArray, 'test', {
+    current: 'currentlystilltesting'
+  });
+  expect(newArray).toHaveLength(3);
 });

package/lib/components/TreeView/TreeViewItem.js

@@ -1,15 +1,61 @@
 import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
-import React, { forwardRef, useImperativeHandle, useRef } from 'react';
+import React, { forwardRef, useEffect, useImperativeHandle, useRef } from 'react';
 import FileIcon from '@pingux/mdi-react/FileIcon';
+import { useFocusRing } from '@react-aria/focus';
 import { useOption } from '@react-aria/listbox';
+import { mergeProps } from '@react-aria/utils';
 import PropTypes from 'prop-types';
 import { useTreeViewContext } from '../../context/TreeViewContext';
+import { useStatusClasses } from '../../hooks';
 import { Box } from '../../index';
+import { itemPressHandlers } from './TreeViewKeyboardDelegate';
 import TreeViewRow from './TreeViewRow';
+import { addRefToArrayHelper, removeRefFromArrayHelper } from './TreeViewSection';
 import { jsx as ___EmotionJSX } from "@emotion/react";
+export var onKeyDownItem = function onKeyDownItem(e, state, key, tree, isSelected, isExpanded, focusManager, flatKeyArray, refArray, pageLength) {
+  switch (e.which) {
+    case 32:
+      itemPressHandlers.onSpacePress(e, tree, key, isSelected);
+      break;
+    case 38:
+      itemPressHandlers.onUpPress(e, key, refArray, flatKeyArray);
+      e.preventDefault();
+      e.stopPropagation();
+      break;
+    case 40:
+      itemPressHandlers.onDownPress(e, key, refArray, flatKeyArray);
+      e.preventDefault();
+      e.stopPropagation();
+      break;
+    case 37:
+    case 39:
+      itemPressHandlers.onRightLeftItemPress(e);
+      break;
+    case 33:
+      itemPressHandlers.onPageUpPress(e, key, flatKeyArray, refArray, pageLength);
+      break;
+    case 34:
+      itemPressHandlers.onPageDownPress(e, key, flatKeyArray, refArray, pageLength);
+      break;
+    case 36:
+      itemPressHandlers.onHomePress(key, flatKeyArray, refArray);
+      e.preventDefault();
+      e.stopPropagation();
+      break;
+    case 35:
+      itemPressHandlers.onEndPress(key, flatKeyArray, refArray);
+      e.preventDefault();
+      e.stopPropagation();
+      break;
+    default:
+      break;
+  }
+};
 var TreeViewItem = /*#__PURE__*/forwardRef(function (props, ref) {
   var item = props.item,
     title = props.title,
+    focusManager = props.focusManager,
+    onKeyDown = props.onKeyDown,
     level = props.level,
     position = props.position,
     setSize = props.setSize;
@@ -19,8 +65,16 @@ var TreeViewItem = /*#__PURE__*/forwardRef(function (props, ref) {
   useImperativeHandle(ref, function () {
     return treeItemRef.current;
   });
+
+  /* istanbul ignore next */
   var _useTreeViewContext = useTreeViewContext(),
-    state = _useTreeViewContext.state;
+    state = _useTreeViewContext.state,
+    tree = _useTreeViewContext.tree,
+    refArray = _useTreeViewContext.refArray,
+    setRefs = _useTreeViewContext.setRefs,
+    flatKeyArray = _useTreeViewContext.flatKeyArray,
+    pageLength = _useTreeViewContext.pageLength,
+    setLastFocusedItem = _useTreeViewContext.setLastFocusedItem;
   var _useOption = useOption({
       key: key
     }, state, treeItemRef),
@@ -28,24 +82,65 @@ var TreeViewItem = /*#__PURE__*/forwardRef(function (props, ref) {
     isSelected = _useOption.isSelected,
     isDisabled = _useOption.isDisabled;
   var isExpanded = state.expandedKeys.has(key);
+  var onKeyDownFunction = function onKeyDownFunction(e) {
+    /* istanbul ignore next */
+    onKeyDownItem(e, state, key, tree, isSelected, isExpanded, focusManager, flatKeyArray, refArray, pageLength);
+    if (onKeyDown) {
+      onKeyDown(e, key);
+    }
+  };
+
+  // ignoring from tests, but this is actually being unit tested
+  /* istanbul ignore next */
+  var removeRefFromArray = function removeRefFromArray() {
+    setRefs(function (prev) {
+      return removeRefFromArrayHelper(prev, key);
+    });
+  };
+  var addRefToArray = function addRefToArray() {
+    setRefs(function (prev) {
+      return addRefToArrayHelper(prev, key, treeItemRef);
+    });
+  };
+
+  // adds and removes refs on mount and dismount
+  /* istanbul ignore next */
+  useEffect(function () {
+    // this  runs on mount
+    addRefToArray();
+    return function () {
+      // this runs on cleanup
+      removeRefFromArray(key, refArray);
+    };
+  }, []);
+  var _useFocusRing = useFocusRing(),
+    isFocusVisible = _useFocusRing.isFocusVisible,
+    focusProps = _useFocusRing.focusProps;
+  var mergedProps = mergeProps(focusProps, optionProps, {
+    onFocus: function onFocus() {
+      return setLastFocusedItem(key);
+    }
+  });
+  var _useStatusClasses = useStatusClasses('', {
+      isFocused: isFocusVisible
+    }),
+    classNames = _useStatusClasses.classNames;
   return ___EmotionJSX(Box, _extends({
     as: "li",
     isRow: true,
     ref: treeItemRef,
-    "aria-disabled": isDisabled,
+    "aria-disabled": isDisabled
+  }, mergedProps, {
+    role: "treeitem",
+    variant: "treeView.wrapper",
+    className: classNames,
+    "aria-selected": isSelected,
     "aria-level": level,
     "aria-posinset": position + 1,
-    "aria-setsize": setSize
-  }, optionProps, {
-    role: "treeitem",
-    sx: {
-      width: '100%',
-      ml: '36px',
-      ':not(:last-child)': {
-        pb: 'sm'
-      }
-    },
-    "aria-selected": isSelected
+    "aria-setsize": setSize,
+    onKeyDown: function onKeyDown(e) {
+      return onKeyDownFunction(e);
+    }
   }), ___EmotionJSX(TreeViewRow, {
     item: item,
     title: title,
@@ -59,8 +154,10 @@ TreeViewItem.propTypes = {
   item: PropTypes.shape({
     key: PropTypes.string
   }),
+  focusManager: PropTypes.shape({}),
   name: PropTypes.string,
   title: PropTypes.string,
+  onKeyDown: PropTypes.func,
   level: PropTypes.number,
   position: PropTypes.number,
   setSize: PropTypes.number

package/lib/components/TreeView/TreeViewKeyboardDelegate.js

@@ -0,0 +1,176 @@
+import _findInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/find";
+import _findIndexInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/find-index";
+var focusPrevious = function focusPrevious(index, refArray, flatKeyList) {
+  if (index !== 0) {
+    var key = flatKeyList[index - 1].key;
+    var _refArray$find = _findInstanceProperty(refArray).call(refArray, function (item) {
+        return item.key === key;
+      }),
+      thisRef = _refArray$find.thisRef;
+    thisRef.current.focus();
+  }
+};
+var focusNext = function focusNext(index, refArray, flatKeyList) {
+  if (index !== flatKeyList.length - 1) {
+    var key = flatKeyList[index + 1].key;
+    var _refArray$find2 = _findInstanceProperty(refArray).call(refArray, function (item) {
+        return item.key === key;
+      }),
+      thisRef = _refArray$find2.thisRef;
+    thisRef.current.focus();
+  }
+};
+export var verifyIndex = function verifyIndex(thisIndex, interval, length) {
+  var newIndex = thisIndex + interval;
+  if (newIndex < 0) {
+    return 0;
+  }
+  if (newIndex >= length) {
+    return length - 1;
+  }
+  return newIndex;
+};
+export var onHomePress = function onHomePress(key, flatKeyArray, refArray) {
+  var _thisRef$current;
+  var firstKey = flatKeyArray[0];
+  if (firstKey.key === key) {
+    return;
+  }
+  var _refArray$find3 = _findInstanceProperty(refArray).call(refArray, function (_item) {
+      return _item.key === firstKey.key;
+    }),
+    thisRef = _refArray$find3.thisRef;
+  (_thisRef$current = thisRef.current) === null || _thisRef$current === void 0 ? void 0 : _thisRef$current.focus();
+};
+export var onEndPress = function onEndPress(key, flatKeyArray, refArray) {
+  var _thisRef$current2;
+  var lastKey = flatKeyArray[flatKeyArray.length - 1];
+  if (lastKey.key === key) {
+    return;
+  }
+  var _refArray$find4 = _findInstanceProperty(refArray).call(refArray, function (_item) {
+      return _item.key === lastKey.key;
+    }),
+    thisRef = _refArray$find4.thisRef;
+  (_thisRef$current2 = thisRef.current) === null || _thisRef$current2 === void 0 ? void 0 : _thisRef$current2.focus();
+};
+export var pageUpOrDown = function pageUpOrDown(key, flatKeyArray, refArray, pageLength) {
+  var _thisRef$current3;
+  var thisIndex = _findIndexInstanceProperty(flatKeyArray).call(flatKeyArray, function (item) {
+    return item.key === key;
+  });
+  var newIndex = verifyIndex(thisIndex, pageLength, flatKeyArray.length);
+  var foundKey = flatKeyArray[newIndex].key;
+  var _refArray$find5 = _findInstanceProperty(refArray).call(refArray, function (_item) {
+      return _item.key === foundKey;
+    }),
+    thisRef = _refArray$find5.thisRef;
+  (_thisRef$current3 = thisRef.current) === null || _thisRef$current3 === void 0 ? void 0 : _thisRef$current3.focus();
+};
+export var onEnterPress = function onEnterPress(e, state, key) {
+  state.toggleKey(key);
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onLeftPress = function onLeftPress(e, focusManager, state, key, isExpanded, refArray) {
+  var isEventTargetAKey = _findInstanceProperty(refArray).call(refArray, function (_item) {
+    return _item.thisRef.current === e.target;
+  });
+  if (isExpanded && isEventTargetAKey) {
+    state.toggleKey(key);
+  }
+  if (isExpanded && !isEventTargetAKey) {
+    focusManager.focusPrevious();
+  }
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onSpacePress = function onSpacePress(e, tree, key, isSelected) {
+  if (isSelected) {
+    tree.setSelectedKeys([]);
+  } else {
+    tree.setSelectedKeys([key]);
+  }
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onUpPress = function onUpPress(e, key, refArray, flatKeyList) {
+  var foundIndex = _findIndexInstanceProperty(flatKeyList).call(flatKeyList, function (item) {
+    return item.key === key;
+  });
+  focusPrevious(foundIndex, refArray, flatKeyList);
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onTabPress = function onTabPress(e, refArray, focusManager, isSection) {
+  var isEventTargetAKey = _findInstanceProperty(refArray).call(refArray, function (_item) {
+    return _item.thisRef.current === e.target;
+  });
+  if (isEventTargetAKey && isSection) {
+    focusManager.focusNext();
+    e.preventDefault();
+    e.stopPropagation();
+  }
+};
+export var onRightPress = function onRightPress(e, focusManager, state, key, isExpanded, refArray) {
+  if (!isExpanded) {
+    state.toggleKey(key);
+    return;
+  }
+  var isEventTargetAKey = _findInstanceProperty(refArray).call(refArray, function (_item) {
+    return _item.thisRef.current === e.target;
+  });
+  if (isExpanded && isEventTargetAKey) {
+    focusManager.focusNext();
+  }
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onDownPress = function onDownPress(e, key, refArray, flatKeyList) {
+  // find the key
+  var foundIndex = _findIndexInstanceProperty(flatKeyList).call(flatKeyList, function (item) {
+    return item.key === key;
+  });
+  focusNext(foundIndex, refArray, flatKeyList);
+  // check if first or last
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onRightLeftItemPress = function onRightLeftItemPress(e) {
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onPageUpPress = function onPageUpPress(e, key, flatKeyArray, refArray, pageLength) {
+  pageUpOrDown(key, flatKeyArray, refArray, -Math.abs(pageLength));
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var onPageDownPress = function onPageDownPress(e, key, flatKeyArray, refArray, pageLength) {
+  pageUpOrDown(key, flatKeyArray, refArray, Math.abs(pageLength));
+  e.preventDefault();
+  e.stopPropagation();
+};
+export var sectionPressHandlers = {
+  onEnterPress: onEnterPress,
+  onSpacePress: onSpacePress,
+  onLeftPress: onLeftPress,
+  onRightPress: onRightPress,
+  onUpPress: onUpPress,
+  onDownPress: onDownPress,
+  onTabPress: onTabPress,
+  onPageUpPress: onPageUpPress,
+  onPageDownPress: onPageDownPress,
+  onHomePress: onHomePress,
+  onEndPress: onEndPress
+};
+export var itemPressHandlers = {
+  onSpacePress: onSpacePress,
+  onDownPress: onDownPress,
+  onUpPress: onUpPress,
+  onRightLeftItemPress: onRightLeftItemPress,
+  onTabPress: onTabPress,
+  onPageUpPress: onPageUpPress,
+  onPageDownPress: onPageDownPress,
+  onHomePress: onHomePress,
+  onEndPress: onEndPress
+};