@deephaven/components 0.74.0 → 0.74.1-beta.1

package/dist/spectrum/utils/useStringifiedSelection.d.ts

@@ -0,0 +1,33 @@
+import { Key } from 'react';
+import { ItemKey, NormalizedItem, NormalizedSection } from './itemUtils';
+export interface UseStringifiedSelectionOptions {
+    normalizedItems: (NormalizedItem | NormalizedSection)[];
+    selectedKey: ItemKey | null | undefined;
+    defaultSelectedKey: ItemKey | undefined;
+    disabledKeys: Iterable<ItemKey> | undefined;
+    onChange: ((key: ItemKey) => void) | undefined;
+}
+export interface UseStringifiedSelectionResult {
+    defaultSelectedStringKey?: Key;
+    selectedStringKey?: Key | null;
+    disabledStringKeys?: Set<Key>;
+    onStringSelectionChange: (key: Key) => void;
+}
+/**
+ * Spectrum collection components treat keys as strings if the `key` prop is
+ * explicitly set on `Item` elements. Since we do this in `useRenderNormalizedItem`,
+ * we need to ensure that keys are strings in order for selection to work. We
+ * then need to convert back to the original key types in the onChange handler.
+ * This hook encapsulates converting to and from strings so that keys can match
+ * the original key type.
+ * @param normalizedItems The normalized items to select from.
+ * @param selectedKey The currently selected key in the collection.
+ * @param defaultSelectedKey The initial selected key in the collection.
+ * @param disabledKeys The currently disabled keys in the collection.
+ * @param onChange Handler that is called when the selection changes.
+ * @returns UseStringifiedSelectionResult with stringified key sets and string
+ * key selection change handler.
+ */
+export declare function useStringifiedSelection({ normalizedItems, defaultSelectedKey, selectedKey, disabledKeys, onChange, }: UseStringifiedSelectionOptions): UseStringifiedSelectionResult;
+export default useStringifiedSelection;
+//# sourceMappingURL=useStringifiedSelection.d.ts.map

package/dist/spectrum/utils/useStringifiedSelection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useStringifiedSelection.d.ts","sourceRoot":"","sources":["../../../src/spectrum/utils/useStringifiedSelection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAwB,MAAM,OAAO,CAAC;AAClD,OAAO,EAEL,OAAO,EAEP,cAAc,EACd,iBAAiB,EAClB,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,8BAA8B;IAC7C,eAAe,EAAE,CAAC,cAAc,GAAG,iBAAiB,CAAC,EAAE,CAAC;IACxD,WAAW,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,YAAY,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;CAChD;AAED,MAAM,WAAW,6BAA6B;IAC5C,wBAAwB,CAAC,EAAE,GAAG,CAAC;IAC/B,iBAAiB,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAC/B,kBAAkB,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,uBAAuB,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;CAC7C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,eAAe,EACf,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,QAAQ,GACT,EAAE,8BAA8B,GAAG,6BAA6B,CA6ChE;AAED,eAAe,uBAAuB,CAAC"}

package/dist/spectrum/utils/useStringifiedSelection.js

@@ -0,0 +1,50 @@
+import { useCallback, useMemo } from 'react';
+import { getItemKey, itemSelectionToStringSet } from "./itemUtils.js";
+/**
+ * Spectrum collection components treat keys as strings if the `key` prop is
+ * explicitly set on `Item` elements. Since we do this in `useRenderNormalizedItem`,
+ * we need to ensure that keys are strings in order for selection to work. We
+ * then need to convert back to the original key types in the onChange handler.
+ * This hook encapsulates converting to and from strings so that keys can match
+ * the original key type.
+ * @param normalizedItems The normalized items to select from.
+ * @param selectedKey The currently selected key in the collection.
+ * @param defaultSelectedKey The initial selected key in the collection.
+ * @param disabledKeys The currently disabled keys in the collection.
+ * @param onChange Handler that is called when the selection changes.
+ * @returns UseStringifiedSelectionResult with stringified key sets and string
+ * key selection change handler.
+ */
+export function useStringifiedSelection(_ref) {
+  var {
+    normalizedItems,
+    defaultSelectedKey,
+    selectedKey,
+    disabledKeys,
+    onChange
+  } = _ref;
+  var selectedStringKey = useMemo(() => selectedKey == null ? selectedKey : String(selectedKey), [selectedKey]);
+  var defaultSelectedStringKey = useMemo(() => defaultSelectedKey == null ? defaultSelectedKey : String(defaultSelectedKey), [defaultSelectedKey]);
+  var disabledStringKeys = useMemo(() => itemSelectionToStringSet(disabledKeys), [disabledKeys]);
+  var onStringSelectionChange = useCallback(key => {
+    var _getItemKey;
+    if (onChange == null) {
+      return;
+    }
+
+    // The `key` arg will always be a string due to us setting the `Item` key
+    // prop in `renderItem`. We need to find the matching item to determine
+    // the actual key.
+    var selectedItem = normalizedItems.find(item => String(getItemKey(item)) === key);
+    var actualKey = (_getItemKey = getItemKey(selectedItem)) !== null && _getItemKey !== void 0 ? _getItemKey : key;
+    onChange(actualKey);
+  }, [normalizedItems, onChange]);
+  return {
+    selectedStringKey,
+    defaultSelectedStringKey,
+    disabledStringKeys,
+    onStringSelectionChange
+  };
+}
+export default useStringifiedSelection;
+//# sourceMappingURL=useStringifiedSelection.js.map

package/dist/spectrum/utils/useStringifiedSelection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useStringifiedSelection.js","names":["useCallback","useMemo","getItemKey","itemSelectionToStringSet","useStringifiedSelection","_ref","normalizedItems","defaultSelectedKey","selectedKey","disabledKeys","onChange","selectedStringKey","String","defaultSelectedStringKey","disabledStringKeys","onStringSelectionChange","key","_getItemKey","selectedItem","find","item","actualKey"],"sources":["../../../src/spectrum/utils/useStringifiedSelection.ts"],"sourcesContent":["import { Key, useCallback, useMemo } from 'react';\nimport {\n  getItemKey,\n  ItemKey,\n  itemSelectionToStringSet,\n  NormalizedItem,\n  NormalizedSection,\n} from './itemUtils';\n\nexport interface UseStringifiedSelectionOptions {\n  normalizedItems: (NormalizedItem | NormalizedSection)[];\n  selectedKey: ItemKey | null | undefined;\n  defaultSelectedKey: ItemKey | undefined;\n  disabledKeys: Iterable<ItemKey> | undefined;\n  onChange: ((key: ItemKey) => void) | undefined;\n}\n\nexport interface UseStringifiedSelectionResult {\n  defaultSelectedStringKey?: Key;\n  selectedStringKey?: Key | null;\n  disabledStringKeys?: Set<Key>;\n  onStringSelectionChange: (key: Key) => void;\n}\n\n/**\n * Spectrum collection components treat keys as strings if the `key` prop is\n * explicitly set on `Item` elements. Since we do this in `useRenderNormalizedItem`,\n * we need to ensure that keys are strings in order for selection to work. We\n * then need to convert back to the original key types in the onChange handler.\n * This hook encapsulates converting to and from strings so that keys can match\n * the original key type.\n * @param normalizedItems The normalized items to select from.\n * @param selectedKey The currently selected key in the collection.\n * @param defaultSelectedKey The initial selected key in the collection.\n * @param disabledKeys The currently disabled keys in the collection.\n * @param onChange Handler that is called when the selection changes.\n * @returns UseStringifiedSelectionResult with stringified key sets and string\n * key selection change handler.\n */\nexport function useStringifiedSelection({\n  normalizedItems,\n  defaultSelectedKey,\n  selectedKey,\n  disabledKeys,\n  onChange,\n}: UseStringifiedSelectionOptions): UseStringifiedSelectionResult {\n  const selectedStringKey = useMemo(\n    () => (selectedKey == null ? selectedKey : String(selectedKey)),\n    [selectedKey]\n  );\n\n  const defaultSelectedStringKey = useMemo(\n    () =>\n      defaultSelectedKey == null\n        ? defaultSelectedKey\n        : String(defaultSelectedKey),\n    [defaultSelectedKey]\n  );\n\n  const disabledStringKeys = useMemo(\n    () => itemSelectionToStringSet(disabledKeys),\n    [disabledKeys]\n  );\n\n  const onStringSelectionChange = useCallback(\n    (key: Key): void => {\n      if (onChange == null) {\n        return;\n      }\n\n      // The `key` arg will always be a string due to us setting the `Item` key\n      // prop in `renderItem`. We need to find the matching item to determine\n      // the actual key.\n      const selectedItem = normalizedItems.find(\n        item => String(getItemKey(item)) === key\n      );\n\n      const actualKey = getItemKey(selectedItem) ?? key;\n\n      onChange(actualKey);\n    },\n    [normalizedItems, onChange]\n  );\n\n  return {\n    selectedStringKey,\n    defaultSelectedStringKey,\n    disabledStringKeys,\n    onStringSelectionChange,\n  };\n}\n\nexport default useStringifiedSelection;\n"],"mappings":"AAAA,SAAcA,WAAW,EAAEC,OAAO,QAAQ,OAAO;AAAC,SAEhDC,UAAU,EAEVC,wBAAwB;AAoB1B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CAAAC,IAAA,EAM2B;EAAA,IAN1B;IACtCC,eAAe;IACfC,kBAAkB;IAClBC,WAAW;IACXC,YAAY;IACZC;EAC8B,CAAC,GAAAL,IAAA;EAC/B,IAAMM,iBAAiB,GAAGV,OAAO,CAC/B,MAAOO,WAAW,IAAI,IAAI,GAAGA,WAAW,GAAGI,MAAM,CAACJ,WAAW,CAAE,EAC/D,CAACA,WAAW,CACd,CAAC;EAED,IAAMK,wBAAwB,GAAGZ,OAAO,CACtC,MACEM,kBAAkB,IAAI,IAAI,GACtBA,kBAAkB,GAClBK,MAAM,CAACL,kBAAkB,CAAC,EAChC,CAACA,kBAAkB,CACrB,CAAC;EAED,IAAMO,kBAAkB,GAAGb,OAAO,CAChC,MAAME,wBAAwB,CAACM,YAAY,CAAC,EAC5C,CAACA,YAAY,CACf,CAAC;EAED,IAAMM,uBAAuB,GAAGf,WAAW,CACxCgB,GAAQ,IAAW;IAAA,IAAAC,WAAA;IAClB,IAAIP,QAAQ,IAAI,IAAI,EAAE;MACpB;IACF;;IAEA;IACA;IACA;IACA,IAAMQ,YAAY,GAAGZ,eAAe,CAACa,IAAI,CACvCC,IAAI,IAAIR,MAAM,CAACV,UAAU,CAACkB,IAAI,CAAC,CAAC,KAAKJ,GACvC,CAAC;IAED,IAAMK,SAAS,IAAAJ,WAAA,GAAGf,UAAU,CAACgB,YAAY,CAAC,cAAAD,WAAA,cAAAA,WAAA,GAAID,GAAG;IAEjDN,QAAQ,CAACW,SAAS,CAAC;EACrB,CAAC,EACD,CAACf,eAAe,EAAEI,QAAQ,CAC5B,CAAC;EAED,OAAO;IACLC,iBAAiB;IACjBE,wBAAwB;IACxBC,kBAAkB;IAClBC;EACF,CAAC;AACH;AAEA,eAAeX,uBAAuB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven/components",
-  "version": "0.74.0",
+  "version": "0.74.1-beta.1+5f497611",
   "description": "Deephaven React component library",
   "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
@@ -25,10 +25,10 @@
   },
   "dependencies": {
     "@adobe/react-spectrum": "^3.34.1",
-    "@deephaven/icons": "^0.74.0",
-    "@deephaven/log": "^0.74.0",
-    "@deephaven/react-hooks": "^0.74.0",
-    "@deephaven/utils": "^0.74.0",
+    "@deephaven/icons": "^0.74.1-beta.1+5f497611",
+    "@deephaven/log": "^0.74.1-beta.1+5f497611",
+    "@deephaven/react-hooks": "^0.74.1-beta.1+5f497611",
+    "@deephaven/utils": "^0.74.1-beta.1+5f497611",
     "@fortawesome/fontawesome-svg-core": "^6.2.1",
     "@fortawesome/react-fontawesome": "^0.2.0",
     "@react-spectrum/theme-default": "^3.5.1",
@@ -55,7 +55,7 @@
     "react-dom": ">=16.8.0"
   },
   "devDependencies": {
-    "@deephaven/mocks": "^0.74.0"
+    "@deephaven/mocks": "^0.74.1-beta.1+5f497611"
   },
   "files": [
     "dist",
@@ -69,5 +69,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0dbf17d6c463cb59e4ff4193828fecb346031b3e"
+  "gitHead": "5f4976115bfc016e6d9cbe9fd77413c3fd8f8353"
 }