feat(ui): #1714: finish the AssetSelector UI component

.changeset/happy-mayflies-destroy.md

@@ -0,0 +1,5 @@
+---
+'@penumbra-zone/ui': minor
+---
+
+Add `AssetSelector` UI component

packages/ui/.storybook/main.js

@@ -32,7 +32,15 @@ const config = {
     getAbsolutePath('@storybook/addon-links'),
     getAbsolutePath('@storybook/addon-essentials'),
     getAbsolutePath('@storybook/addon-interactions'),
-    '@storybook/addon-postcss',
+    {
+      name: '@storybook/addon-postcss',
+      options: {
+        postcssLoaderOptions: {
+          // When using postCSS 8
+          implementation: require('postcss'),
+        },
+      },
+    },
     '@storybook/preview-api',
   ],
   framework: {

packages/ui/.storybook/preview.jsx

@@ -6,6 +6,7 @@ import { PenumbraUIProvider } from '../src/PenumbraUIProvider';
 import { Density } from '../src/Density';
 import { Tabs } from '../src/Tabs';
 import styled from 'styled-components';
+import '../styles/globals.css';
 
 const Column = styled.div`
   display: flex;

packages/ui/src/AssetSelector/Custom.tsx

@@ -0,0 +1,141 @@
+import { ReactNode, useId, useState } from 'react';
+import styled from 'styled-components';
+import { RadioGroup } from '@radix-ui/react-radio-group';
+import { Dialog } from '../Dialog';
+import { IsAnimatingProvider } from '../IsAnimatingProvider';
+import { getHash } from './shared/helpers.ts';
+import { AssetSelectorContext } from './shared/Context.tsx';
+import { AssetSelectorSearchFilter } from './SearchFilter.tsx';
+import { AssetSelectorTrigger } from './Trigger.tsx';
+import { AssetSelectorBaseProps } from './shared/types.ts';
+
+const OptionsWrapper = styled.div`
+  display: flex;
+  flex-direction: column;
+  gap: ${props => props.theme.spacing(1)};
+`;
+
+interface ChildrenArguments {
+  onClose: VoidFunction;
+  /**
+   * Takes the `Metadata` or `BalancesResponse` and returns
+   * a unique key string to be used within map in React
+   */
+  getKeyHash: typeof getHash;
+}
+
+export interface AssetSelectorCustomProps extends AssetSelectorBaseProps {
+  /** A value of the search filter inside the selector dialog */
+  search?: string;
+
+  /** Fires when user inputs the value into the search filter inside the selector dialog */
+  onSearchChange?: (newValue: string) => void;
+
+  /**
+   * Use children as a function to get assistance with keying
+   * the `ListItem`s and implement you own closing logic.
+   *
+   * Example:
+   * ```tsx
+   *  <AssetSelector>
+   *    {({ getKeyHash, onClose }) => (
+   *     <>
+   *       {options.map(option => (
+   *        <AssetSelector.ListItem key={getKeyHash(option)} value={option} />
+   *       ))}
+   *       <Button onClick={onClose}>Close</Button>
+   *     </>
+   *    )}
+   *  </AssetSelector>
+   * ```
+   * */
+  children?: ReactNode | ((args: ChildrenArguments) => ReactNode);
+}
+
+/**
+ * A custom version of the `AssetSelector` that lets you customize the contents of the selector dialog.
+ *
+ * Use `AssetSelector.ListItem` inside the `AssetSelector.Custom` to render the options
+ * of the selector. It is up for you to sort or group the options however you want.
+ *
+ * Example usage:
+ *
+ * ```tsx
+ * const [value, setValue] = useState<Metadata | BalancesResponse>();
+ * const [search, setSearch] = useState('');
+ *
+ * const filteredOptions = useMemo(
+ *   () => mixedOptions.filter(filterMetadataOrBalancesResponseByText(search)),
+ *   [search],
+ * );
+ *
+ * return (
+ *   <AssetSelector
+ *     value={value}
+ *     search={search}
+ *     onChange={setValue}
+ *     onSearchChange={setSearch}
+ *   >
+ *     {({ getKeyHash }) =>
+ *       filteredOptions.map(option => (
+ *         <AssetSelector.ListItem key={getKeyHash(option)} value={option} />
+ *       ))
+ *     }
+ *   </AssetSelector>
+ * );
+ * ```
+ */
+export const AssetSelectorCustom = ({
+  value,
+  onChange,
+  dialogTitle = 'Select Asset',
+  actionType,
+  disabled,
+  children,
+  search,
+  onSearchChange,
+}: AssetSelectorCustomProps) => {
+  const layoutId = useId();
+
+  const [isOpen, setIsOpen] = useState(false);
+
+  const onClose = () => setIsOpen(false);
+
+  return (
+    <Dialog isOpen={isOpen} onClose={() => setIsOpen(false)}>
+      <AssetSelectorContext.Provider value={{ onClose, onChange, value }}>
+        <AssetSelectorTrigger
+          value={value}
+          actionType={actionType}
+          disabled={disabled}
+          layoutId={layoutId}
+          key={layoutId}
+          onClick={() => setIsOpen(true)}
+        />
+
+        <IsAnimatingProvider>
+          {props => (
+            <Dialog.Content
+              title={dialogTitle}
+              motion={{ ...props, layoutId }}
+              key={layoutId}
+              headerChildren={
+                !!onSearchChange && (
+                  <AssetSelectorSearchFilter value={search} onChange={onSearchChange} />
+                )
+              }
+            >
+              <RadioGroup value={value ? getHash(value) : undefined} asChild>
+                <OptionsWrapper>
+                  {typeof children === 'function'
+                    ? children({ onClose, getKeyHash: getHash })
+                    : children}
+                </OptionsWrapper>
+              </RadioGroup>
+            </Dialog.Content>
+          )}
+        </IsAnimatingProvider>
+      </AssetSelectorContext.Provider>
+    </Dialog>
+  );
+};