@react-fabric/form 1.0.0-beta.6 → 1.0.0-beta.61

package/src/select/List.tsx

@@ -32,13 +32,21 @@ import {
 import { Chip } from "@react-fabric/core";
 import { isArray, isEmpty } from "@react-fabric/utilities";
 import classNames from "classnames";
-import { Fragment, useCallback, useId, useMemo } from "react";
+import { Fragment, useCallback, useId, useLayoutEffect, useMemo } from "react";
 import { FieldWrapper } from "../internal/FieldWrapper";
 import { InputWrapper } from "../internal/InputWrapper";
 import { type SelectProps } from "../types";
 import { Options } from "./Options";
 import { useSelect } from "./useSelect";
 
+/**
+ * List component for selecting items from a list.
+ * It supports single and multiple selections, searching, creating new options,
+ * and custom rendering of options.
+ *
+ * @param {SelectProps<T>} props - The properties for the List component.
+ * @returns {JSX.Element} The rendered List component.
+ */
 export const List = <T extends AnyObject = string>({
   ref,
   name,
@@ -53,8 +61,11 @@ export const List = <T extends AnyObject = string>({
   groupProperty,
   labelProperty,
   valueProperty,
+  infoProperty,
+  sortProperty,
   multiple,
   allowCreate,
+  searchable,
   createOption,
   matcher,
   renderer,
@@ -62,6 +73,7 @@ export const List = <T extends AnyObject = string>({
   onChange,
   onSelect,
   onEnterPressed,
+  emptyDisplay,
   invalid,
   error,
   allowClear,
@@ -72,7 +84,9 @@ export const List = <T extends AnyObject = string>({
   // @ts-expect-error ignore
   "data-hide-selected": hideSelected,
   ...rest
-}: SelectProps<T> & { height?: string | number }) => {
+}: Omit<SelectProps<T>, "defaultOpen" | "hideHandle"> & {
+  height?: string | number;
+}) => {
   const Wrapper = useMemo(() => (isInner ? Fragment : FieldWrapper), [isInner]);
   const wrapperProps = useMemo(
     () => (isInner ? {} : { ...rest }),
@@ -93,9 +107,11 @@ export const List = <T extends AnyObject = string>({
     value,
     options,
     multiple,
+    alwaysOpen: true,
     groupProperty,
     labelProperty,
     valueProperty,
+    sortProperty,
     allowCreate,
     createOption,
     matcher,
@@ -166,9 +182,12 @@ export const List = <T extends AnyObject = string>({
           }
         } else if (evt.key === "Backspace") {
           !state.query && handleRemove();
-        } else if (["ArrowUp", "ArrowDown"].includes(evt.key)) {
-          if (state.activeIndex === null) {
-            setActiveIndex(state.selectedIndex);
+        } else if (!searchable || ["ArrowUp", "ArrowDown"].includes(evt.key)) {
+          if (
+            ["ArrowUp", "ArrowDown"].includes(evt.key) &&
+            state.activeIndex === null
+          ) {
+            setActiveIndex(state.selectedIndex ?? 0);
           }
           setTimeout(() => {
             props.onKeyDown?.(evt);
@@ -225,6 +244,15 @@ export const List = <T extends AnyObject = string>({
     }
   }, [state.value, state.query, placeholder, renderer]);
 
+  useLayoutEffect(() => {
+    setTimeout(() => {
+      state.selectedIndex &&
+        listRef.current[state.selectedIndex]?.scrollIntoView({
+          block: "center",
+        });
+    }, 100);
+  }, [state.selectedIndex]);
+
   return (
     <Wrapper {...wrapperProps}>
       <InputWrapper
@@ -240,22 +268,34 @@ export const List = <T extends AnyObject = string>({
         wrapperRef={refs.setReference}
       >
         <div
+          role="none"
           data-select-display="true"
-          className="group flex-1 py-1 px-2 truncate text-start flex gap-1 flex-wrap"
+          className={classNames(
+            "group flex-1 py-1 px-2 truncate text-start flex gap-1 relative min-h-5 justify-start",
+            multiple ? "flex-wrap" : "flex-nowrap overflow-hidden",
+          )}
+          {...referenceProps}
+          onMouseUp={(e) =>
+            e.currentTarget.querySelector<HTMLElement>("input")?.focus()
+          }
         >
           {!hideSelected && displayValue}
           <input
+            readOnly={!searchable || readOnly}
             disabled={disabled}
             value={state.query ?? ""}
             aria-invalid={invalid}
             data-testid={name}
             name={name}
+            size={1}
+            ref={ref}
+            autoFocus={autoFocus}
             className={classNames(
               "appearance-none bg-transparent outline-none border-none ring-0 flex-1 min-w-24",
               disabled && "cursor-not-allowed pointer-events-none",
+              multiple && "min-w-24",
             )}
             placeholder={isEmpty(state.value) ? placeholder : ""}
-            {...referenceProps}
             onChange={(evt) => handleQuery(evt.target.value)}
           />
         </div>
@@ -277,10 +317,14 @@ export const List = <T extends AnyObject = string>({
           {...floatingProps}
           items={state.items}
           active={state.activeIndex}
+          valueProperty={valueProperty}
+          labelProperty={labelProperty}
           itemRef={setItemRef}
           itemProps={makeItemProps}
+          empty={emptyDisplay}
+          info={state.activeItem?.[infoProperty ?? "info"]}
         >
-          {(item) => renderer?.(item) ?? item[labelProperty] ?? item}
+          {(item, label) => renderer?.(item) ?? label}
         </Options>
       </FloatingFocusManager>
     </Wrapper>

package/src/select/Options.tsx

@@ -22,8 +22,8 @@
  */
 
 import { EmptyContent } from "@react-fabric/core";
+import { type ReactElement } from "@react-fabric/core/dist/types/types";
 import classNames from "classnames";
-import { type ReactElement, type ReactNode } from "react";
 import { Trans } from "react-i18next";
 
 export const Options = ({
@@ -34,6 +34,7 @@ export const Options = ({
   className,
   itemRef,
   empty,
+  info,
   valueProperty = "id",
   labelProperty = "label",
   itemProps,
@@ -41,6 +42,7 @@ export const Options = ({
   ...rest
 }: {
   ref: AnyObject;
+  info?: AnyObject;
   itemRef: AnyObject;
   style?: AnyObject;
   items: AnyObject[];
@@ -50,34 +52,53 @@ export const Options = ({
   valueProperty?: AnyObject;
   labelProperty?: AnyObject;
   itemProps: (item: AnyObject) => AnyObject;
-  children: (item: AnyObject, label: string) => ReactNode;
+  children: (item: AnyObject, label: string) => React.ReactNode;
 } & KeyValue) => {
   return (
     <div
       ref={ref}
-      className={classNames(
-        "bg-base select-none overflow-x-hidden overflow-y-auto",
-        className,
-      )}
+      className={classNames("bg-base select-none flex flex-col", className)}
       style={style}
       {...rest}
     >
-      {items.length === 0 &&
-        (empty ?? (
-          <EmptyContent message={<Trans i18nKey="form:select.emptyList" />} />
-        ))}
-      {items.map((item, index) => {
-        if (item.___group___)
-          return (
-            <p
-              key={index}
-              className="px-2 py-1 text-muted text-xs sticky -top-px z-2 bg-base border-t"
-            >
-              {item.label}
-            </p>
-          );
+      <div className={classNames("overflow-x-hidden overflow-y-auto flex-1")}>
+        {items.length === 0 &&
+          (empty ?? (
+            <EmptyContent message={<Trans i18nKey="form:select.emptyList" />} />
+          ))}
+        {items.map((item, index) => {
+          if (item.___group___)
+            return (
+              <p
+                key={index}
+                className="px-2 py-1 text-muted text-xs sticky -top-px z-2 bg-base border-t"
+              >
+                {item.label}
+              </p>
+            );
+
+          if (item.___create___)
+            return (
+              <div
+                role="none"
+                key={index}
+                tabIndex={active === index ? 0 : -1}
+                ref={(el: AnyObject) => itemRef(index, el)}
+                data-active={active === index ? true : undefined}
+                className={classNames(
+                  "block text-start truncate px-2 py-1 leading-normal cursor-pointer select-none",
+                  "data-active:bg-primary-200 data-selected:bg-primary-600 data-selected:text-white data-active:data-selected:underline",
+                )}
+                {...itemProps(item)}
+              >
+                <Trans
+                  i18nKey="form:select.createOption"
+                  values={{ query: item.value ?? item }}
+                  components={[<strong key="t0">query</strong>]}
+                />
+              </div>
+            );
 
-        if (item.___create___)
           return (
             <div
               role="none"
@@ -86,36 +107,19 @@ export const Options = ({
               ref={(el: AnyObject) => itemRef(index, el)}
               data-active={active === index ? true : undefined}
               className={classNames(
-                "block text-start truncate px-2 py-1 leading-normal cursor-pointer select-none",
-                "data-[active]:bg-primary-200 data-[selected]:bg-primary-600 data-[selected]:text-white data-[active]:data-[selected]:underline",
+                "block text-start truncate px-2 py-1 leading-normal cursor-pointer",
+                "data-active:bg-primary-200 data-selected:bg-primary-600 data-selected:text-white data-active:data-selected:underline",
               )}
               {...itemProps(item)}
             >
-              <Trans
-                i18nKey="form:select.createOption"
-                values={{ query: item.value }}
-                components={[<strong key="t0">query</strong>]}
-              />
+              {children(item, item[labelProperty] ?? item)}
             </div>
           );
-
-        return (
-          <div
-            role="none"
-            key={index}
-            tabIndex={active === index ? 0 : -1}
-            ref={(el: AnyObject) => itemRef(index, el)}
-            data-active={active === index ? true : undefined}
-            className={classNames(
-              "block text-start truncate px-2 py-1 leading-normal cursor-pointer",
-              "data-[active]:bg-primary-200 data-[selected]:bg-primary-600 data-[selected]:text-white data-[active]:data-[selected]:underline",
-            )}
-            {...itemProps(item)}
-          >
-            {children(item, item[labelProperty] ?? item)}
-          </div>
-        );
-      })}
+        })}
+      </div>
+      {info && (
+        <div className="px-2 py-1 text-sm bg-dimmed text-muted">{info}</div>
+      )}
     </div>
   );
 };

package/src/select/Select.tsx

@@ -35,7 +35,7 @@ import {
   useListNavigation,
   useTypeahead,
 } from "@floating-ui/react";
-import { Chip, CoreIcons, Icon } from "@react-fabric/core";
+import { Chip, Icon } from "@react-fabric/core";
 import { isArray, isEmpty } from "@react-fabric/utilities";
 import classNames from "classnames";
 import { useCallback, useId, useLayoutEffect, useMemo } from "react";
@@ -44,6 +44,14 @@ import { type SelectProps } from "../types";
 import { Options } from "./Options";
 import { useSelect } from "./useSelect";
 
+/**
+ * Select component for selecting items from a dropdown list.
+ * It supports single and multiple selections, searching, creating new options,
+ * and custom rendering of options.
+ *
+ * @param {SelectProps<T>} props - The properties for the Select component.
+ * @returns {JSX.Element} The rendered Select component.
+ */
 export const Select = <T extends AnyObject = string>({
   ref,
   name,
@@ -56,12 +64,17 @@ export const Select = <T extends AnyObject = string>({
   autoFocus,
   error,
   options,
+  defaultOpen,
+  hideHandle,
   groupProperty,
   labelProperty = "label" as AnyObject,
   valueProperty = "id" as AnyObject,
+  sortProperty,
+  infoProperty,
   multiple,
   searchable,
   allowCreate,
+  emptyDisplay,
   createOption,
   matcher,
   renderer,
@@ -86,9 +99,11 @@ export const Select = <T extends AnyObject = string>({
     value,
     options,
     multiple,
+    defaultOpen,
     groupProperty,
     labelProperty,
     valueProperty,
+    sortProperty,
     allowCreate,
     createOption,
     matcher,
@@ -172,6 +187,9 @@ export const Select = <T extends AnyObject = string>({
             return false;
           } else if (state.query) {
             handleQuery("");
+            evt.preventDefault();
+            evt.stopPropagation();
+            return false;
           } else {
             onEnterPressed?.(evt);
           }
@@ -231,7 +249,7 @@ export const Select = <T extends AnyObject = string>({
       ));
     } else if (!isEmpty(state.value) && !state.query) {
       return (
-        <span className="self-center pointer-events-none select-none">
+        <span className="self-center pointer-events-none select-none truncate leading-tight">
           {renderer?.(state.value) ?? state.value[labelProperty] ?? state.value}
         </span>
       );
@@ -263,7 +281,7 @@ export const Select = <T extends AnyObject = string>({
       required={required}
       error={error}
       wrapperRef={refs.setReference}
-      className={state.open ? "!z-[99]" : ""}
+      className={state.open ? "z-99!" : ""}
       {...rest}
     >
       <div
@@ -290,15 +308,15 @@ export const Select = <T extends AnyObject = string>({
           ref={ref}
           autoFocus={autoFocus}
           className={classNames(
-            "appearance-none bg-transparent outline-none border-none ring-0 flex-1",
+            "appearance-none bg-transparent outline-none border-none ring-0 flex-1 peer",
             disabled && "cursor-not-allowed pointer-events-none",
-            multiple && "min-w-24",
+            multiple ? "min-w-24" : "min-w-2",
           )}
           placeholder={isEmpty(state.value) ? placeholder : ""}
           onChange={(evt) => handleQuery(evt.target.value)}
         />
       </div>
-      {!state.loading && (
+      {!state.loading && !hideHandle && (
         <Icon
           className={classNames(
             "flex-content p-2 z-0 order-9 text-muted cursor-pointer self-stretch flex items-center h-auto",
@@ -306,16 +324,15 @@ export const Select = <T extends AnyObject = string>({
             disabled && "pointer-events-none",
           )}
           onClick={() => !disabled && openDropdown()}
-          icon={CoreIcons.chevronDown}
+          icon="icon-[mdi--chevron-down]"
         />
       )}
       {state.loading && (
         <Icon
-          animate="spin"
           className={classNames(
             "flex-content p-2 z-0 order-9 text-muted pointer-events-none",
           )}
-          icon={CoreIcons.spinner}
+          icon="icon-[svg-spinners--eclipse]"
         />
       )}
       {state.open && !state.loading && (
@@ -327,7 +344,7 @@ export const Select = <T extends AnyObject = string>({
           >
             <Options
               ref={refs.setFloating}
-              className="outline shadow-lg max-h-[40vh] z-[var(--z-popover)]"
+              className="outline shadow-lg max-h-[40vh] z-(--z-popover)"
               style={{
                 width: refs.reference.current?.getBoundingClientRect().width,
                 ...floatingStyles,
@@ -339,6 +356,8 @@ export const Select = <T extends AnyObject = string>({
               labelProperty={labelProperty}
               itemRef={setItemRef}
               itemProps={makeItemProps}
+              empty={emptyDisplay}
+              info={state.activeItem?.[infoProperty ?? "info"]}
             >
               {(item, label) => renderer?.(item) ?? label}
             </Options>

package/src/select/useSelect.tsx

@@ -23,6 +23,7 @@
 
 import { useDebounce } from "@react-fabric/core";
 import {
+  compareValues,
   dedupe,
   EMPTY_ARRAY,
   groupBy,
@@ -64,6 +65,7 @@ interface State {
   open: boolean;
   loading: boolean;
   activeIndex: number | null;
+  activeItem: AnyObject;
   selectedIndex: number | null;
   value: AnyObject;
   // filter
@@ -76,11 +78,14 @@ export const useSelect = ({
   options = EMPTY_ARRAY,
   value,
   autoComplete,
+  alwaysOpen = false,
+  defaultOpen = false,
   multiple = false,
   allowCreate = false,
   groupProperty = "",
   valueProperty = "id",
   labelProperty = "label",
+  sortProperty,
   createOption = makeOption,
   matcher,
   onQuery,
@@ -90,10 +95,13 @@ export const useSelect = ({
   value?: AnyObject;
   options?: AnyObject[];
   multiple?: boolean;
+  alwaysOpen?: boolean;
+  defaultOpen?: boolean;
   allowCreate?: boolean;
   groupProperty?: AnyObject;
   valueProperty?: AnyObject;
   labelProperty?: AnyObject;
+  sortProperty?: AnyObject;
   autoComplete?: boolean;
   matcher?: (item: AnyObject, query: string) => boolean;
   createOption?: (query: string) => AnyObject;
@@ -144,12 +152,16 @@ export const useSelect = ({
         };
       }
       if (action.type === "close") {
-        return { ...state, activeIndex: null, open: false };
+        return { ...state, activeIndex: null, activeItem: null, open: false };
       }
       if (action.type === "active" && state.open) {
         if (autoComplete && action.index !== null)
           state.query = state.items[action.index];
-        return { ...state, activeIndex: action.index };
+        return {
+          ...state,
+          activeIndex: action.index,
+          activeItem: state.items[action.index ?? -1],
+        };
       }
       if (action.type === "setValue") {
         return {
@@ -165,6 +177,7 @@ export const useSelect = ({
           ...state,
           value: state.emptyValue,
           activeIndex: null,
+          activeItem: null,
           selectedIndex: autoComplete
             ? state.multiple
               ? action.value?.length
@@ -187,7 +200,7 @@ export const useSelect = ({
             newState.value = action.value;
           }
         }
-        if (!state.multiple) newState.open = false;
+        if (!state.multiple) newState.open = alwaysOpen;
         fireChange(newState.value);
         return newState;
       }
@@ -223,6 +236,8 @@ export const useSelect = ({
         if (autoComplete && action.query !== undefined) {
           optionList = dedupe([action.query, ...optionList]);
         }
+        if (sortProperty)
+          optionList = optionList.sort(compareValues("asc", sortProperty));
         const grouped = groupBy(optionList, groupProperty, "");
         if (action.open) newState.open = true;
         newState.items = [];
@@ -230,7 +245,7 @@ export const useSelect = ({
         if (allowCreate && action.query)
           newState.items.push({
             ___create___: true,
-            value: createOption(action.query),
+            value: action.query,
           });
         Object.entries(grouped).forEach(([key, list]) => {
           if (key) {
@@ -254,9 +269,10 @@ export const useSelect = ({
     {
       multiple,
       emptyValue,
-      open: false,
+      open: alwaysOpen || defaultOpen,
       loading: false,
       activeIndex: null,
+      activeItem: null,
       selectedIndex: null,
       value: emptyValue,
       // filter
@@ -283,7 +299,7 @@ export const useSelect = ({
       dispatch({ type: "options", options: optionsRef.current });
       dispatch({
         type: "setValue",
-        value: hasValue ?? newOption ?? "",
+        value: hasValue ?? newOption ?? deferred,
       });
     }
     if (multiple) {
@@ -295,12 +311,12 @@ export const useSelect = ({
               ? createOption(item)
               : undefined;
           const hasValue = options.find(
-            (opt: AnyObject) => (opt[valueProperty] ?? opt) === deferred,
+            (opt: AnyObject) => (opt[valueProperty] ?? opt) === item,
           );
           if (!hasValue && newOption) {
             optionsRef.current.push(newOption);
           }
-          return hasValue ?? newOption ?? "";
+          return hasValue ?? newOption ?? item;
         },
       );
       optionsRef.current = [...optionsRef.current, ...(options ?? [])];
@@ -334,6 +350,7 @@ export const useSelect = ({
       });
     },
     [onQuery],
+    300,
   );
 
   // handlers
@@ -399,7 +416,7 @@ export const useSelect = ({
   }, []);
 
   const setActiveIndex = useCallback((index: number | null) => {
-    dispatch({ type: "active", index });
+    index && index > -1 && dispatch({ type: "active", index });
   }, []);
 
   return {

package/src/types/index.ts

@@ -22,6 +22,8 @@
  */
 
 import {
+  type NestedKeys,
+  type ReactElement,
   type RefProp,
   type TestProps,
 } from "@react-fabric/core/dist/types/types";
@@ -30,11 +32,15 @@ export interface InputProps<V = string> extends TestProps {
   /**
    * value
    */
-  value?: V;
+  value?: V | null;
+  /**
+   * default value
+   */
+  defaultValue?: V | null;
   /**
    * change handler
    */
-  onChange?: (value?: V) => void;
+  onChange?: (value: V | null) => void;
   /**
    * on focus event handler
    */
@@ -72,11 +78,15 @@ export interface InputProps<V = string> extends TestProps {
    *
    */
   decorateEnd?: JSX.Element | string | number | boolean;
+  decorateEndShowWhenEmpty?: boolean;
+  decorateEndHideWhenEmpty?: boolean;
   /**
    * info label at bottom
    */
   info?: string;
 
+  monospace?: boolean;
+
   /**
    * required
    */
@@ -120,9 +130,15 @@ export interface InputProps<V = string> extends TestProps {
   labelWidth?: string;
 }
 
-export interface BaseSelectProps<T>
-  extends RefProp<HTMLInputElement>,
-    Omit<InputProps, "value" | "onChange"> {
+export interface BaseSelectProps<T extends AnyObject = string> {
+  /**
+   * open dropdown by default
+   */
+  defaultOpen?: boolean;
+  /**
+   * hide dropdown handle
+   */
+  hideHandle?: boolean;
   /**
    * list options
    */
@@ -130,15 +146,23 @@ export interface BaseSelectProps<T>
   /**
    * group by property name
    */
-  groupProperty?: keyof T;
+  groupProperty?: NestedKeys<T>;
   /**
    * label property name
    */
-  labelProperty?: keyof T;
+  labelProperty?: NestedKeys<T>;
+  /**
+   * value property name
+   */
+  valueProperty?: NestedKeys<T>;
+  /**
+   * value property name
+   */
+  infoProperty?: NestedKeys<T>;
   /**
    * value property name
    */
-  valueProperty?: keyof T;
+  sortProperty?: NestedKeys<T> | true;
   /**
    * searchable list
    */
@@ -147,6 +171,10 @@ export interface BaseSelectProps<T>
    * allow create item
    */
   allowCreate?: boolean;
+  /**
+   * empty list display
+   */
+  emptyDisplay?: ReactElement;
   /**
    * create new item object
    */
@@ -158,14 +186,18 @@ export interface BaseSelectProps<T>
   /**
    * item renderer
    */
-  renderer?: (option: T) => React.ReactNode;
+  renderer?: (option: T) => ReactElement;
   /**
    * item matcher
    */
   matcher?: (option: T, query: string) => boolean;
 }
 
-export type SelectProps<T> = BaseSelectProps<T> &
+type BaseSelectType<T> = BaseSelectProps<T> &
+  RefProp<HTMLInputElement> &
+  Omit<InputProps, "value" | "onChange">;
+
+export type SelectProps<T> = BaseSelectType<T> &
   (
     | {
         /**