react-arborist 3.9.0 → 3.10.0

package/README.md

@@ -245,15 +245,17 @@ function App() {
 
 ### Dynamic sizing
 
-You can add a ref to it with this package [ZeeCoder/use-resize-observer](https://github.com/ZeeCoder/use-resize-observer)
+You can add a ref to it with this package [Pmndrs/react-use-measure](https://github.com/pmndrs/react-use-measure)
  
-That hook will return the height and width of the parent whenever it changes. You then pass these numbers to the Tree.
+That hook will measure the boundaries (for instance width, height, top, left) of a view you reference. Then you pass the width and the height to the Tree.
 
 ```js
-const { ref, width, height } = useResizeObserver();
+import useMeasure from "react-use-measure";
+
+const [ref, bounds] = useMeasure();
  
 <div className="parent" ref={ref}>
-  <Tree height={height} width={width} />
+  <Tree height={bounds.height} width={bounds.width} />
 </div>
 ```
 

package/dist/main/components/default-container.js

@@ -18,7 +18,7 @@ let timeoutId = null;
 function DefaultContainer() {
     (0, context_1.useDataUpdates)();
     const tree = (0, context_1.useTreeApi)();
-    return ((0, jsx_runtime_1.jsx)("div", { role: "tree", style: {
+    return ((0, jsx_runtime_1.jsx)("div", { role: "tree", "aria-label": tree.props["aria-label"], "aria-labelledby": tree.props["aria-labelledby"], "aria-multiselectable": !tree.props.disableMultiSelection || undefined, style: {
             height: tree.height,
             width: tree.width,
             minHeight: 0,
@@ -144,16 +144,16 @@ function DefaultContainer() {
                 }
                 return;
             }
-            if (e.key === "a" && e.metaKey && !tree.props.disableMultiSelection) {
+            if (e.key === "a" && (e.metaKey || e.ctrlKey) && !tree.props.disableMultiSelection) {
                 e.preventDefault();
                 tree.selectAll();
                 return;
             }
-            if (e.key === "a" && !e.metaKey && tree.props.onCreate) {
+            if (e.key === "a" && !e.metaKey && !e.ctrlKey && tree.props.onCreate) {
                 tree.createLeaf();
                 return;
             }
-            if (e.key === "A" && !e.metaKey) {
+            if (e.key === "A" && !e.metaKey && !e.ctrlKey) {
                 if (!tree.props.onCreate)
                     return;
                 tree.createInternal();

package/dist/main/components/default-container.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/main/components/default-container.test.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("@testing-library/react");
+const tree_1 = require("./tree");
+const data = [
+    {
+        id: "1",
+        name: "root",
+        children: [
+            { id: "2", name: "a" },
+            { id: "3", name: "b", children: [{ id: "4", name: "c" }] },
+        ],
+    },
+];
+/* #303: multi-select should respond to Ctrl+Click (Windows) as well as
+   Cmd/Meta+Click (macOS). */
+test("Ctrl+Click adds a row to the selection (#303)", () => {
+    (0, react_1.render)((0, jsx_runtime_1.jsx)(tree_1.Tree, { data: data, openByDefault: true }));
+    const [, a, b] = react_1.screen.getAllByRole("treeitem");
+    react_1.fireEvent.click(a);
+    expect(a.getAttribute("aria-selected")).toBe("true");
+    react_1.fireEvent.click(b, { ctrlKey: true });
+    expect(a.getAttribute("aria-selected")).toBe("true");
+    expect(b.getAttribute("aria-selected")).toBe("true");
+});
+test("Ctrl+Click toggles an already-selected row off (#303)", () => {
+    (0, react_1.render)((0, jsx_runtime_1.jsx)(tree_1.Tree, { data: data, openByDefault: true }));
+    const [, a, b] = react_1.screen.getAllByRole("treeitem");
+    react_1.fireEvent.click(a);
+    react_1.fireEvent.click(b, { ctrlKey: true });
+    react_1.fireEvent.click(b, { ctrlKey: true });
+    expect(a.getAttribute("aria-selected")).toBe("true");
+    expect(b.getAttribute("aria-selected")).toBe("false");
+});
+test("Ctrl+Click falls through to a plain select when multi-select is disabled (#303)", () => {
+    (0, react_1.render)((0, jsx_runtime_1.jsx)(tree_1.Tree, { data: data, openByDefault: true, disableMultiSelection: true }));
+    const [, a, b] = react_1.screen.getAllByRole("treeitem");
+    react_1.fireEvent.click(a);
+    react_1.fireEvent.click(b, { ctrlKey: true });
+    expect(a.getAttribute("aria-selected")).toBe("false");
+    expect(b.getAttribute("aria-selected")).toBe("true");
+});
+/* #325: forward an accessible name and multiselectable state onto the
+   role="tree" element. */
+test("forwards aria-label to the role=tree element (#325)", () => {
+    (0, react_1.render)((0, jsx_runtime_1.jsx)(tree_1.Tree, { data: data, "aria-label": "File explorer" }));
+    expect(react_1.screen.getByRole("tree").getAttribute("aria-label")).toBe("File explorer");
+});
+test("forwards aria-labelledby to the role=tree element (#325)", () => {
+    (0, react_1.render)((0, jsx_runtime_1.jsx)(tree_1.Tree, { data: data, "aria-labelledby": "heading-id" }));
+    expect(react_1.screen.getByRole("tree").getAttribute("aria-labelledby")).toBe("heading-id");
+});
+test("marks the tree aria-multiselectable by default (#325)", () => {
+    (0, react_1.render)((0, jsx_runtime_1.jsx)(tree_1.Tree, { data: data }));
+    expect(react_1.screen.getByRole("tree").getAttribute("aria-multiselectable")).toBe("true");
+});
+test("omits aria-multiselectable when multi-select is disabled (#325)", () => {
+    (0, react_1.render)((0, jsx_runtime_1.jsx)(tree_1.Tree, { data: data, disableMultiSelection: true }));
+    expect(react_1.screen.getByRole("tree").hasAttribute("aria-multiselectable")).toBe(false);
+});

package/dist/main/interfaces/node-api.js

@@ -5,7 +5,7 @@ const create_root_1 = require("../data/create-root");
 class NodeApi {
     constructor(params) {
         this.handleClick = (e) => {
-            if (e.metaKey && !this.tree.props.disableMultiSelection) {
+            if ((e.metaKey || e.ctrlKey) && !this.tree.props.disableMultiSelection) {
                 if (this.isSelected)
                     this.deselect();
                 else

package/dist/main/types/tree-props.d.ts

@@ -50,6 +50,8 @@ export interface TreeProps<T> {
     initialOpenState?: OpenMap;
     searchTerm?: string;
     searchMatch?: (node: NodeApi<T>, searchTerm: string) => boolean;
+    "aria-label"?: string;
+    "aria-labelledby"?: string;
     className?: string | undefined;
     rowClassName?: string | undefined;
     dndRootElement?: globalThis.Node | null;

package/dist/module/components/default-container.js

@@ -15,7 +15,7 @@ let timeoutId = null;
 export function DefaultContainer() {
     useDataUpdates();
     const tree = useTreeApi();
-    return (_jsx("div", { role: "tree", style: {
+    return (_jsx("div", { role: "tree", "aria-label": tree.props["aria-label"], "aria-labelledby": tree.props["aria-labelledby"], "aria-multiselectable": !tree.props.disableMultiSelection || undefined, style: {
             height: tree.height,
             width: tree.width,
             minHeight: 0,
@@ -141,16 +141,16 @@ export function DefaultContainer() {
                 }
                 return;
             }
-            if (e.key === "a" && e.metaKey && !tree.props.disableMultiSelection) {
+            if (e.key === "a" && (e.metaKey || e.ctrlKey) && !tree.props.disableMultiSelection) {
                 e.preventDefault();
                 tree.selectAll();
                 return;
             }
-            if (e.key === "a" && !e.metaKey && tree.props.onCreate) {
+            if (e.key === "a" && !e.metaKey && !e.ctrlKey && tree.props.onCreate) {
                 tree.createLeaf();
                 return;
             }
-            if (e.key === "A" && !e.metaKey) {
+            if (e.key === "A" && !e.metaKey && !e.ctrlKey) {
                 if (!tree.props.onCreate)
                     return;
                 tree.createInternal();

package/dist/module/components/default-container.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/module/components/default-container.test.js

@@ -0,0 +1,59 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { fireEvent, render, screen } from "@testing-library/react";
+import { Tree } from "./tree";
+const data = [
+    {
+        id: "1",
+        name: "root",
+        children: [
+            { id: "2", name: "a" },
+            { id: "3", name: "b", children: [{ id: "4", name: "c" }] },
+        ],
+    },
+];
+/* #303: multi-select should respond to Ctrl+Click (Windows) as well as
+   Cmd/Meta+Click (macOS). */
+test("Ctrl+Click adds a row to the selection (#303)", () => {
+    render(_jsx(Tree, { data: data, openByDefault: true }));
+    const [, a, b] = screen.getAllByRole("treeitem");
+    fireEvent.click(a);
+    expect(a.getAttribute("aria-selected")).toBe("true");
+    fireEvent.click(b, { ctrlKey: true });
+    expect(a.getAttribute("aria-selected")).toBe("true");
+    expect(b.getAttribute("aria-selected")).toBe("true");
+});
+test("Ctrl+Click toggles an already-selected row off (#303)", () => {
+    render(_jsx(Tree, { data: data, openByDefault: true }));
+    const [, a, b] = screen.getAllByRole("treeitem");
+    fireEvent.click(a);
+    fireEvent.click(b, { ctrlKey: true });
+    fireEvent.click(b, { ctrlKey: true });
+    expect(a.getAttribute("aria-selected")).toBe("true");
+    expect(b.getAttribute("aria-selected")).toBe("false");
+});
+test("Ctrl+Click falls through to a plain select when multi-select is disabled (#303)", () => {
+    render(_jsx(Tree, { data: data, openByDefault: true, disableMultiSelection: true }));
+    const [, a, b] = screen.getAllByRole("treeitem");
+    fireEvent.click(a);
+    fireEvent.click(b, { ctrlKey: true });
+    expect(a.getAttribute("aria-selected")).toBe("false");
+    expect(b.getAttribute("aria-selected")).toBe("true");
+});
+/* #325: forward an accessible name and multiselectable state onto the
+   role="tree" element. */
+test("forwards aria-label to the role=tree element (#325)", () => {
+    render(_jsx(Tree, { data: data, "aria-label": "File explorer" }));
+    expect(screen.getByRole("tree").getAttribute("aria-label")).toBe("File explorer");
+});
+test("forwards aria-labelledby to the role=tree element (#325)", () => {
+    render(_jsx(Tree, { data: data, "aria-labelledby": "heading-id" }));
+    expect(screen.getByRole("tree").getAttribute("aria-labelledby")).toBe("heading-id");
+});
+test("marks the tree aria-multiselectable by default (#325)", () => {
+    render(_jsx(Tree, { data: data }));
+    expect(screen.getByRole("tree").getAttribute("aria-multiselectable")).toBe("true");
+});
+test("omits aria-multiselectable when multi-select is disabled (#325)", () => {
+    render(_jsx(Tree, { data: data, disableMultiSelection: true }));
+    expect(screen.getByRole("tree").hasAttribute("aria-multiselectable")).toBe(false);
+});

package/dist/module/interfaces/node-api.js

@@ -2,7 +2,7 @@ import { ROOT_ID } from "../data/create-root";
 export class NodeApi {
     constructor(params) {
         this.handleClick = (e) => {
-            if (e.metaKey && !this.tree.props.disableMultiSelection) {
+            if ((e.metaKey || e.ctrlKey) && !this.tree.props.disableMultiSelection) {
                 if (this.isSelected)
                     this.deselect();
                 else

package/dist/module/types/tree-props.d.ts

@@ -50,6 +50,8 @@ export interface TreeProps<T> {
     initialOpenState?: OpenMap;
     searchTerm?: string;
     searchMatch?: (node: NodeApi<T>, searchTerm: string) => boolean;
+    "aria-label"?: string;
+    "aria-labelledby"?: string;
     className?: string | undefined;
     rowClassName?: string | undefined;
     dndRootElement?: globalThis.Node | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-arborist",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "keywords": [
     "arborist",
     "dnd",

package/src/components/default-container.test.tsx

@@ -0,0 +1,74 @@
+import { fireEvent, render, screen } from "@testing-library/react";
+import { Tree } from "./tree";
+
+type Datum = { id: string; name: string; children?: Datum[] };
+
+const data: Datum[] = [
+  {
+    id: "1",
+    name: "root",
+    children: [
+      { id: "2", name: "a" },
+      { id: "3", name: "b", children: [{ id: "4", name: "c" }] },
+    ],
+  },
+];
+
+/* #303: multi-select should respond to Ctrl+Click (Windows) as well as
+   Cmd/Meta+Click (macOS). */
+test("Ctrl+Click adds a row to the selection (#303)", () => {
+  render(<Tree<Datum> data={data} openByDefault />);
+  const [, a, b] = screen.getAllByRole("treeitem");
+
+  fireEvent.click(a);
+  expect(a.getAttribute("aria-selected")).toBe("true");
+
+  fireEvent.click(b, { ctrlKey: true });
+  expect(a.getAttribute("aria-selected")).toBe("true");
+  expect(b.getAttribute("aria-selected")).toBe("true");
+});
+
+test("Ctrl+Click toggles an already-selected row off (#303)", () => {
+  render(<Tree<Datum> data={data} openByDefault />);
+  const [, a, b] = screen.getAllByRole("treeitem");
+
+  fireEvent.click(a);
+  fireEvent.click(b, { ctrlKey: true });
+  fireEvent.click(b, { ctrlKey: true });
+
+  expect(a.getAttribute("aria-selected")).toBe("true");
+  expect(b.getAttribute("aria-selected")).toBe("false");
+});
+
+test("Ctrl+Click falls through to a plain select when multi-select is disabled (#303)", () => {
+  render(<Tree<Datum> data={data} openByDefault disableMultiSelection />);
+  const [, a, b] = screen.getAllByRole("treeitem");
+
+  fireEvent.click(a);
+  fireEvent.click(b, { ctrlKey: true });
+
+  expect(a.getAttribute("aria-selected")).toBe("false");
+  expect(b.getAttribute("aria-selected")).toBe("true");
+});
+
+/* #325: forward an accessible name and multiselectable state onto the
+   role="tree" element. */
+test("forwards aria-label to the role=tree element (#325)", () => {
+  render(<Tree<Datum> data={data} aria-label="File explorer" />);
+  expect(screen.getByRole("tree").getAttribute("aria-label")).toBe("File explorer");
+});
+
+test("forwards aria-labelledby to the role=tree element (#325)", () => {
+  render(<Tree<Datum> data={data} aria-labelledby="heading-id" />);
+  expect(screen.getByRole("tree").getAttribute("aria-labelledby")).toBe("heading-id");
+});
+
+test("marks the tree aria-multiselectable by default (#325)", () => {
+  render(<Tree<Datum> data={data} />);
+  expect(screen.getByRole("tree").getAttribute("aria-multiselectable")).toBe("true");
+});
+
+test("omits aria-multiselectable when multi-select is disabled (#325)", () => {
+  render(<Tree<Datum> data={data} disableMultiSelection />);
+  expect(screen.getByRole("tree").hasAttribute("aria-multiselectable")).toBe(false);
+});

package/src/components/default-container.tsx

@@ -19,6 +19,9 @@ export function DefaultContainer() {
   return (
     <div
       role="tree"
+      aria-label={tree.props["aria-label"]}
+      aria-labelledby={tree.props["aria-labelledby"]}
+      aria-multiselectable={!tree.props.disableMultiSelection || undefined}
       style={{
         height: tree.height,
         width: tree.width,
@@ -133,16 +136,16 @@ export function DefaultContainer() {
           }
           return;
         }
-        if (e.key === "a" && e.metaKey && !tree.props.disableMultiSelection) {
+        if (e.key === "a" && (e.metaKey || e.ctrlKey) && !tree.props.disableMultiSelection) {
           e.preventDefault();
           tree.selectAll();
           return;
         }
-        if (e.key === "a" && !e.metaKey && tree.props.onCreate) {
+        if (e.key === "a" && !e.metaKey && !e.ctrlKey && tree.props.onCreate) {
           tree.createLeaf();
           return;
         }
-        if (e.key === "A" && !e.metaKey) {
+        if (e.key === "A" && !e.metaKey && !e.ctrlKey) {
           if (!tree.props.onCreate) return;
           tree.createInternal();
           return;

package/src/interfaces/node-api.ts

@@ -200,7 +200,7 @@ export class NodeApi<T = any> {
   }
 
   handleClick = (e: React.MouseEvent) => {
-    if (e.metaKey && !this.tree.props.disableMultiSelection) {
+    if ((e.metaKey || e.ctrlKey) && !this.tree.props.disableMultiSelection) {
       if (this.isSelected) this.deselect();
       else this.selectMulti();
     } else if (e.shiftKey && !this.tree.props.disableMultiSelection) {

package/src/types/tree-props.ts

@@ -69,6 +69,10 @@ export interface TreeProps<T> {
   searchTerm?: string;
   searchMatch?: (node: NodeApi<T>, searchTerm: string) => boolean;
 
+  /* Accessibility */
+  "aria-label"?: string;
+  "aria-labelledby"?: string;
+
   /* Extra */
   className?: string | undefined;
   rowClassName?: string | undefined;