[terra-folder-tree] Base Component Creation (#1888)

Co-authored-by: Aaron Johnson <[email protected]> Co-authored-by: Vinay Bhargav Arni Ragunathan <[email protected]> Co-authored-by: Saad Adnan <[email protected]> Co-authored-by: ns065186 <[email protected]> Co-authored-by: kenk2 <[email protected]> Co-authored-by: Jessie Randle <[email protected]> Co-authored-by: Eric Wilson <[email protected]>
cerner · Nov 21, 2023 · d4d947c · d4d947c
1 parent c2eadb6
commit d4d947c
Show file tree

Hide file tree

Showing 38 changed files with 518 additions and 65 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/terra-folder-tree/CHANGELOG.md b/packages/terra-folder-tree/CHANGELOG.md
@@ -2,8 +2,10 @@
 
 ## Unreleased
 
+* Added
+  * Created base `terra-folder-tree` component.
+
 ## 0.1.1-alpha.0 - (October 25, 2023)
 
 * Changed
-  * Minor dependency version bump
-
+  * Minor dependency version bump.
diff --git a/packages/terra-folder-tree/package.json b/packages/terra-folder-tree/package.json
@@ -30,7 +30,12 @@
   "dependencies": {
     "classnames": "^2.2.5",
     "keycode-js": "^3.1.0",
-    "prop-types": "^15.5.8"
+    "prop-types": "^15.5.8",
+    "terra-action-header": "^2.85.0",
+    "terra-arrange": "^3.54.0",
+    "terra-icon": "^3.58.0",
+    "terra-spacer": "^3.61.0",
+    "terra-theme-context": "^1.8.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.22.10",

diff --git a/packages/terra-folder-tree/src/FolderTree.jsx b/packages/terra-folder-tree/src/FolderTree.jsx
@@ -1,26 +1,50 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { injectIntl } from 'react-intl';
-// import classNames from 'classnames/bind';
-// import styles from './FolderTree.module.scss';
+import classNames from 'classnames/bind';
 
-// const cx = classNames.bind(styles);
+import ActionHeader from 'terra-action-header';
+
+import FolderTreeItem from './subcomponents/FolderTreeItem';
+import styles from './FolderTree.module.scss';
+
+const cx = classNames.bind(styles);
 
 const propTypes = {
   /**
-   * @private
-   * The intl object containing translations. This is retrieved from the context automatically by injectIntl.
+   * List of FolderTree.Items to be displayed as content within the FolderTree.
+   */
+  children: PropTypes.node.isRequired,
+  /**
+   * The title of the folder tree.
    */
-  intl: PropTypes.shape({ formatMessage: PropTypes.func }).isRequired,
+  title: PropTypes.string.isRequired,
+  /**
+   * The heading level for the title of the folder tree.
+   */
+  headerLevel: PropTypes.number,
 };
 
-const defaultProps = {};
+const defaultProps = {
+  headerLevel: 3,
+};
 
-const FolderTree = () => (
-  <div>test</div>
+const FolderTree = ({ children, title, headerLevel }) => (
+  <>
+    <ActionHeader
+      text={title}
+      level={headerLevel}
+    />
+    <ul
+      className={cx('folder-tree')}
+      role="tree"
+    >
+      {children}
+    </ul>
+  </>
 );
 
 FolderTree.propTypes = propTypes;
 FolderTree.defaultProps = defaultProps;
 
-export default injectIntl(FolderTree);
+FolderTree.Item = FolderTreeItem;
+export default FolderTree;
diff --git a/packages/terra-folder-tree/src/FolderTree.module.scss b/packages/terra-folder-tree/src/FolderTree.module.scss
@@ -1,7 +1,11 @@
-@import '~terra-mixins/lib/Mixins';
-
 // Themes
 @import './orion-fusion-theme/FolderTree.module';
 @import './clinical-lowlight-theme/FolderTree.module';
 
-// :local {}
+:local {
+  .folder-tree {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+  }
+}
diff --git a/packages/terra-folder-tree/src/clinical-lowlight-theme/FolderTree.module.scss b/packages/terra-folder-tree/src/clinical-lowlight-theme/FolderTree.module.scss
@@ -1,3 +1,8 @@
-// :local {
-//   .clinical-lowlight-theme {}
-// }
+:local {
+  .clinical-lowlight-theme {
+    --terra-folder-tree-item-border-bottom: #181b1d;
+    --terra-folder-tree-item-background-color: #1e3a49;
+    --terra-folder-tree-item-hover-background-color: #232a2d;
+    --terra-folder-tree-item-selected-background-color: #232a2d;
+  }
+}
diff --git a/packages/terra-folder-tree/src/orion-fusion-theme/FolderTree.module.scss b/packages/terra-folder-tree/src/orion-fusion-theme/FolderTree.module.scss
@@ -1,3 +1,6 @@
-// :local {
-//   .orion-fusion-theme {}
-// }
+:local {
+  .orion-fusion-theme {
+    --terra-folder-tree-item-background-color-hover: #f4fafe;
+    // --terra-folder-tree-item-background-color-selected: ;
+  }
+}
diff --git a/packages/terra-folder-tree/src/subcomponents/FolderTreeItem.jsx b/packages/terra-folder-tree/src/subcomponents/FolderTreeItem.jsx
@@ -0,0 +1,122 @@
+import React, { useContext } from 'react';
+import PropTypes from 'prop-types';
+import classNames from 'classnames/bind';
+import { injectIntl } from 'react-intl';
+
+import Spacer from 'terra-spacer';
+import Arrange from 'terra-arrange';
+import { IconFolder } from 'terra-icon';
+import ThemeContext from 'terra-theme-context';
+
+import styles from './FolderTreeItem.module.scss';
+
+const cx = classNames.bind(styles);
+
+const propTypes = {
+  /**
+   * The label for the folder tree item.
+   */
+  label: PropTypes.string.isRequired,
+  /**
+   * The icon to display to the left of the name.
+   */
+  icon: PropTypes.element,
+  /**
+   * List of FolderTree.Items to display in a subfolder when this FolderTreeItem is clicked. This makes the item expandable and collapsible. It also makes the item's icon a Folder, overriding anything given as the icon prop.
+   */
+  subfolderItems: PropTypes.arrayOf(PropTypes.element),
+  /**
+   * Whether or not the item is selected. Since this component has the appearance of a radio button group, only one item should be selected at a time.
+   */
+  isSelected: PropTypes.bool,
+  /**
+   * Callback function for click event.
+   */
+  onClick: PropTypes.func,
+  /**
+   * @private
+   * Level of nesting for this item.
+   */
+  level: PropTypes.number,
+  /**
+   * @private
+   * intl object programmatically imported through injectIntl from react-intl.
+   * */
+  intl: PropTypes.shape({ formatMessage: PropTypes.func }).isRequired,
+};
+
+const defaultProps = {
+  isSelected: false,
+  level: 0,
+};
+
+const FolderTreeItem = ({
+  icon,
+  label,
+  subfolderItems,
+  isSelected,
+  onClick,
+  level,
+  intl,
+}) => {
+  const theme = useContext(ThemeContext);
+
+  const subfolder = subfolderItems?.length > 0 ? (
+    <ul
+      className={cx('subfolder')}
+      role="group"
+    >
+      {subfolderItems.map((item) => (
+        <FolderTreeItem
+          {...item.props}
+          intl={intl}
+          level={level + 1}
+        />
+      ))}
+    </ul>
+  ) : null;
+
+  const itemIcon = subfolder ? <IconFolder a11yLabel={intl.formatMessage({ id: 'Terra.folder-tree.folder-icon' })} /> : icon;
+
+  const itemClassNames = classNames(
+    cx(
+      'folder-tree-item',
+      { selected: isSelected },
+      theme.className,
+    ),
+  );
+
+  return (
+    <>
+      <li
+        className={itemClassNames}
+        role="treeitem"
+        aria-selected={isSelected}
+      >
+        <input
+          type="radio"
+          checked={isSelected}
+          onClick={onClick}
+        />
+        {/* eslint-disable-next-line react/forbid-dom-props */}
+        <span style={{ paddingLeft: `${level}rem` }}>
+          <Arrange
+            fitStart={(
+              <Spacer paddingLeft="medium" paddingRight="medium" isInlineBlock>
+                {itemIcon}
+              </Spacer>
+            )}
+            fill={label}
+            alignFitStart="center"
+          />
+        </span>
+      </li>
+      {subfolder}
+    </>
+  );
+};
+
+FolderTreeItem.propTypes = propTypes;
+FolderTreeItem.defaultProps = defaultProps;
+
+export default injectIntl(FolderTreeItem);
diff --git a/packages/terra-folder-tree/src/subcomponents/FolderTreeItem.module.scss b/packages/terra-folder-tree/src/subcomponents/FolderTreeItem.module.scss
@@ -0,0 +1,30 @@
+@import '../clinical-lowlight-theme/FolderTree.module';
+@import '../orion-fusion-theme/FolderTree.module';
+
+:local {
+  .folder-tree-item {
+    align-items: center;
+    background-color: var(--terra-folder-tree-item-background-color, #fff);
+    border-bottom: var(--terra-folder-tree-item-border-bottom, 1px solid #dedfe0);
+    display: flex;
+    margin: 0;
+    min-height: var(--terra-folder-tree-item-min-height, 2.92857rem);
+    overflow-wrap: anywhere;
+    padding: 0;
+    width: 100%;
+
+    &:hover {
+      background-color: var(--terra-folder-tree-item-hover-background-color, #f4fafe);
+    }
+  }
+
+  .selected {
+    background-color: var(--terra-folder-tree-item-selected-background-color, darken(#ebf6fd, 2%));
+  }
+
+  .subfolder {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+  }
+}