release/v2.2.0 (#82)

* Update README prepare release
* Add demo for disabling multi selection
* Fix select all case when multi selection is disabled

Author: jameskerr

.github/workflows/publish.yml

@@ -9,8 +9,8 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: "16.x"
+          registry-url: "https://registry.npmjs.org"
       - run: cp README.md packages/react-arborist/README.md
       - run: yarn
       - run: yarn workspace react-arborist build

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Testing Locally
+
+1. Clone the repo
+2. From the root, run yarn start
+3. Visit localhost:3000
+
+# Publishing a Release
+
+### Release Branch
+
+1. Checkout main locally
+2. Increment the version number in packages/react-arborist/package.json
+3. Create a branch called release/v0.0.0
+4. Open a PR to main
+5. Test, review, and merge
+
+### Create Github Release
+
+1. Create a release based on main
+2. Assign a new tag to be created with v0.0.0
+3. Write release notes
+4. Publish
+
+The Github actions workflow will publish to npm.

README.md

@@ -718,6 +718,4 @@ Returns the root _NodeApi_ instance. Its children are the Node representations o
 
 ## Author
 
-This library was created by James Kerr while working at Brim Data on the [Zui desktop app](https://www.youtube.com/watch?v=I2y663n8d2A). Work with data? Check us out at [brimdata.io](https://www.brimdata.io)
-
-[Follow me on Twitter](https://twitter.com/specialCaseDev) for react-arborist updates.
+[James Kerr](https://twitter.com/specialCaseDev) at [Brim Data](https://brimdata.io) for the [Zui desktop app](https://www.youtube.com/watch?v=I2y663n8d2A).

packages/react-arborist/package.json

@@ -1,13 +1,14 @@
 {
   "name": "react-arborist",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "license": "MIT",
   "source": "src/index.ts",
   "main": "dist/index.js",
   "module": "dist/module.js",
   "types": "dist/index.d.ts",
-  "repository": "https://github.com/brimdata/react-arborist",
+  "repository": "github:brimdata/react-arborist",
   "homepage": "https://react-arborist.netlify.app",
+  "bugs": "https://github.com/brimdata/react-arborist/issues",
   "keywords": [
     "react",
     "arborist",

packages/react-arborist/src/components/default-container.tsx

@@ -132,7 +132,7 @@ export function DefaultContainer() {
           }
           return;
         }
-        if (e.key === "a" && e.metaKey) {
+        if (e.key === "a" && e.metaKey && !tree.props.disableMultiSelection) {
           e.preventDefault();
           tree.selectAll();
           return;

packages/showcase/pages/cities.tsx

@@ -20,6 +20,7 @@ export default function Cities() {
   const [searchTerm, setSearchTerm] = useState("");
   const [count, setCount] = useState(0);
   const [followsFocus, setFollowsFocus] = useState(false);
+  const [disableMulti, setDisableMulti] = useState(false);
 
   useEffect(() => {
     setCount(tree?.visibleNodes.length ?? 0);
@@ -35,6 +36,7 @@ export default function Cities() {
                 {...dimens}
                 initialData={data}
                 selectionFollowsFocus={followsFocus}
+                disableMultiSelection={disableMulti}
                 ref={(t) => setTree(t)}
                 openByDefault={true}
                 searchTerm={searchTerm}
@@ -100,6 +102,16 @@ export default function Cities() {
               onChange={(e) => setFollowsFocus((v) => !v)}
             />
           </section>
+          <section>
+            <label>
+              Demo the <i>disableMultiSelection</i> prop:
+            </label>
+            <input
+              type="checkbox"
+              checked={disableMulti}
+              onChange={(e) => setDisableMulti((v) => !v)}
+            />
+          </section>
           <section>
             <label>
               Demo the <i>tree</i> ref: