@scm-manager/ui-forms 2.44.2 → 2.44.3-20230527-064447

package/src/combobox/ComboboxField.tsx

@@ -0,0 +1,62 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import Field from "../base/Field";
+import Label from "../base/label/Label";
+import Help from "../base/help/Help";
+import React from "react";
+import { useGeneratedId } from "@scm-manager/ui-components";
+import { withForwardRef } from "../helpers";
+import Combobox, { ComboboxProps } from "./Combobox";
+import classNames from "classnames";
+
+/**
+ * @beta
+ * @since 2.45.0
+ */
+const ComboboxField = function ComboboxField<T>(
+  {
+    label,
+    helpText,
+    error,
+    className,
+    isLoading,
+    ...props
+  }: ComboboxProps<T> & { label: string; helpText?: string; error?: string; isLoading?: boolean },
+  ref: React.ForwardedRef<HTMLInputElement>
+) {
+  const labelId = useGeneratedId();
+  return (
+    <Field className={className}>
+      <Label id={labelId}>
+        {label}
+        {helpText ? <Help className="ml-1" text={helpText} /> : null}
+      </Label>
+      <div className={classNames("control", { "is-loading": isLoading })}>
+        <Combobox {...props} ref={ref} aria-labelledby={labelId} />
+      </div>
+    </Field>
+  );
+};
+export default withForwardRef(ComboboxField);

package/src/combobox/ControlledComboboxField.tsx

@@ -0,0 +1,96 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import React, { ComponentProps } from "react";
+import { Controller, ControllerRenderProps, Path } from "react-hook-form";
+import { useScmFormContext } from "../ScmFormContext";
+import { useScmFormPathContext } from "../FormPathContext";
+import { defaultOptionFactory, prefixWithoutIndices } from "../helpers";
+import classNames from "classnames";
+import ComboboxField from "./ComboboxField";
+import { Option } from "@scm-manager/ui-types";
+
+type Props<T extends Record<string, unknown>> = Omit<
+  Parameters<typeof ComboboxField>[0],
+  "error" | "label" | keyof ControllerRenderProps
+> & {
+  rules?: ComponentProps<typeof Controller>["rules"];
+  name: Path<T>;
+  label?: string;
+  optionFactory?: (val: any) => Option<unknown>;
+};
+
+/**
+ * @beta
+ * @since 2.45.0
+ */
+function ControlledComboboxField<T extends Record<string, unknown>>({
+  name,
+  label,
+  helpText,
+  rules,
+  testId,
+  defaultValue,
+  readOnly,
+  className,
+  optionFactory = defaultOptionFactory,
+  ...props
+}: Props<T>) {
+  const { control, t, readOnly: formReadonly, formId } = useScmFormContext();
+  const formPathPrefix = useScmFormPathContext();
+  const nameWithPrefix = formPathPrefix ? `${formPathPrefix}.${name}` : name;
+  const prefixedNameWithoutIndices = prefixWithoutIndices(nameWithPrefix);
+  const labelTranslation = label || t(`${prefixedNameWithoutIndices}.label`) || "";
+  const helpTextTranslation = helpText || t(`${prefixedNameWithoutIndices}.helpText`);
+  return (
+    <Controller
+      control={control}
+      name={nameWithPrefix}
+      rules={rules}
+      defaultValue={defaultValue as never}
+      render={({ field: { onChange, value, ...field }, fieldState }) => (
+        // @ts-ignore
+        <ComboboxField
+          form={formId}
+          readOnly={readOnly ?? formReadonly}
+          className={classNames("column", className)}
+          {...props}
+          {...field}
+          label={labelTranslation}
+          helpText={helpTextTranslation}
+          onChange={(e) => onChange(e?.value)}
+          value={optionFactory(value)}
+          error={
+            fieldState.error
+              ? fieldState.error.message || t(`${prefixedNameWithoutIndices}.error.${fieldState.error.type}`)
+              : undefined
+          }
+          testId={testId ?? `select-${nameWithPrefix}`}
+        />
+      )}
+    />
+  );
+}
+
+export default ControlledComboboxField;

package/src/headless-chip-input/ChipInput.tsx

@@ -24,25 +24,71 @@
 
 import React, {
   ButtonHTMLAttributes,
+  ComponentType,
+  Context,
   createContext,
   HTMLAttributes,
-  InputHTMLAttributes,
   KeyboardEventHandler,
   LiHTMLAttributes,
+  ReactElement,
+  RefObject,
   useCallback,
   useContext,
   useMemo,
+  useRef,
 } from "react";
 import { Slot } from "@radix-ui/react-slot";
+import { Option } from "@scm-manager/ui-types";
+import { mergeRefs, withForwardRef } from "../helpers";
 
-type ChipInputContextType = {
-  add(newValue: string): void;
+type ChipInputContextType<T> = {
+  add(newValue: Option<T>): void;
   remove(index: number): void;
+  inputRef: RefObject<HTMLInputElement>;
   disabled?: boolean;
   readOnly?: boolean;
-  value: string[];
 };
-const ChipInputContext = createContext<ChipInputContextType>(null as unknown as ChipInputContextType);
+
+const ChipInputContext = createContext<ChipInputContextType<never>>(null as unknown as ChipInputContextType<never>);
+
+function getChipInputContext<T>() {
+  return ChipInputContext as unknown as Context<ChipInputContextType<T>>;
+}
+
+type CustomNewChipInputProps<T> = {
+  onChange: (newValue: Option<T>) => void;
+  value?: Option<T> | null;
+  readOnly?: boolean;
+  disabled?: boolean;
+  ref?: React.Ref<HTMLInputElement>;
+  className?: string;
+  placeholder?: string;
+  id?: string;
+  "aria-describedby"?: string;
+};
+
+const DefaultNewChipInput = React.forwardRef<HTMLInputElement, CustomNewChipInputProps<string>>(
+  ({ onChange, value, ...props }, ref) => {
+    const handleKeyDown = useCallback<KeyboardEventHandler<HTMLInputElement>>(
+      (e) => {
+        if (e.key === "Enter") {
+          e.preventDefault();
+          if (e.currentTarget.value) {
+            onChange({ label: e.currentTarget.value, value: e.currentTarget.value });
+          }
+          return false;
+        }
+      },
+      [onChange]
+    );
+
+    return (
+      <div className="is-flex-grow-1">
+        <input onKeyDown={handleKeyDown} {...props} ref={ref} />
+      </div>
+    );
+  }
+);
 
 type ChipDeleteProps = {
   asChild?: boolean;
@@ -65,31 +111,33 @@ export const ChipDelete = React.forwardRef<HTMLButtonElement, ChipDeleteProps>((
 });
 
 type NewChipInputProps = {
-  asChild?: boolean;
-} & Omit<InputHTMLAttributes<HTMLInputElement>, "onKeyDown" | "disabled" | "readOnly">;
+  children?: ReactElement | null;
+  ref?: React.Ref<HTMLInputElement>;
+  className?: string;
+  placeholder?: string;
+  id?: string;
+  "aria-describedby"?: string;
+};
 
 /**
  * @beta
  * @since 2.44.0
  */
-export const NewChipInput = React.forwardRef<HTMLInputElement, NewChipInputProps>(({ asChild, ...props }, ref) => {
-  const { add, value, disabled, readOnly } = useContext(ChipInputContext);
-  const handleKeyDown = useCallback<KeyboardEventHandler<HTMLInputElement>>(
-    (e) => {
-      if (e.key === "Enter") {
-        e.preventDefault();
-        const newValue = e.currentTarget.value.trim();
-        if (newValue && !value?.includes(newValue)) {
-          add(newValue);
-          e.currentTarget.value = "";
-        }
-        return false;
-      }
-    },
-    [add, value]
-  );
-  const Comp = asChild ? Slot : "input";
-  return <Comp {...props} onKeyDown={handleKeyDown} readOnly={readOnly} disabled={disabled} ref={ref} />;
+export const NewChipInput = withForwardRef(function NewChipInput<T>(
+  props: NewChipInputProps,
+  ref: React.ForwardedRef<HTMLInputElement>
+) {
+  const { add, disabled, readOnly, inputRef } = useContext(getChipInputContext<T>());
+
+  const Comp = props.children ? Slot : DefaultNewChipInput;
+  return React.createElement(Comp as unknown as ComponentType<CustomNewChipInputProps<T>>, {
+    ...props,
+    onChange: add,
+    readOnly,
+    disabled,
+    value: null,
+    ref: mergeRefs(ref, inputRef),
+  });
 });
 
 type ChipProps = { asChild?: boolean } & LiHTMLAttributes<HTMLLIElement>;
@@ -104,48 +152,68 @@ export const Chip = React.forwardRef<HTMLLIElement, ChipProps>(({ asChild, ...pr
   return <Comp {...props} ref={ref} />;
 });
 
-type Props = {
-  value?: string[];
-  onChange?: (newValue: string[]) => void;
+type Props<T> = {
+  value?: Option<T>[] | null;
+  onChange?: (newValue?: Option<T>[]) => void;
   readOnly?: boolean;
   disabled?: boolean;
+  isNewItemDuplicate?: (existingItem: Option<T>, newItem: Option<T>) => boolean;
 } & Omit<HTMLAttributes<HTMLUListElement>, "onChange">;
 
 /**
  * @beta
  * @since 2.44.0
  */
-const ChipInput = React.forwardRef<HTMLUListElement, Props>(
-  ({ children, value = [], disabled, readOnly, onChange, ...props }, ref) => {
-    const isInactive = useMemo(() => disabled || readOnly, [disabled, readOnly]);
-    const add = useCallback(
-      (newValue: string) => !isInactive && onChange && onChange([...value, newValue]),
-      [isInactive, onChange, value]
-    );
-    const remove = useCallback(
-      (index: number) => !isInactive && onChange && onChange(value?.filter((_, itdx) => itdx !== index)),
-      [isInactive, onChange, value]
-    );
-    return (
-      <ChipInputContext.Provider
-        value={useMemo(
-          () => ({
-            value,
-            disabled,
-            readOnly,
-            add,
-            remove,
-          }),
-          [add, disabled, readOnly, remove, value]
-        )}
-      >
-        <ul {...props} ref={ref}>
-          {children}
-        </ul>
-      </ChipInputContext.Provider>
-    );
-  }
-);
+const ChipInput = withForwardRef(function ChipInput<T>(
+  { children, value = [], disabled, readOnly, onChange, isNewItemDuplicate, ...props }: Props<T>,
+  ref: React.ForwardedRef<HTMLUListElement>
+) {
+  const inputRef = useRef<HTMLInputElement>(null);
+  const isInactive = useMemo(() => disabled || readOnly, [disabled, readOnly]);
+  const add = useCallback<(newValue: Option<T>) => void>(
+    (newItem) => {
+      if (
+        !isInactive &&
+        !value?.some((item) =>
+          isNewItemDuplicate
+            ? isNewItemDuplicate(item, newItem)
+            : item.label === newItem.label || item.value === newItem.value
+        )
+      ) {
+        if (onChange) {
+          onChange([...(value ?? []), newItem]);
+        }
+        if (inputRef.current) {
+          inputRef.current.value = "";
+        }
+      }
+    },
+    [isInactive, isNewItemDuplicate, onChange, value]
+  );
+  const remove = useCallback(
+    (index: number) => !isInactive && onChange && onChange(value?.filter((_, itdx) => itdx !== index)),
+    [isInactive, onChange, value]
+  );
+  const Context = getChipInputContext<T>();
+  return (
+    <Context.Provider
+      value={useMemo(
+        () => ({
+          disabled,
+          readOnly,
+          add,
+          remove,
+          inputRef,
+        }),
+        [add, disabled, readOnly, remove]
+      )}
+    >
+      <ul {...props} ref={ref}>
+        {children}
+      </ul>
+    </Context.Provider>
+  );
+});
 
 export default Object.assign(ChipInput, {
   Chip: Object.assign(Chip, {

package/src/helpers.ts

@@ -23,6 +23,7 @@
  */
 
 import { UseFormReturn } from "react-hook-form";
+import { ForwardedRef, forwardRef, MutableRefObject, Ref, RefCallback } from "react";
 
 export function prefixWithoutIndices(path: string): string {
   return path.replace(/(\.\d+)/g, "");
@@ -49,3 +50,25 @@ export function setValues<T>(newValues: T, setValue: UseFormReturn<T>["setValue"
     }
   }
 }
+
+export function withForwardRef<T extends { name: string }>(component: T): T {
+  return forwardRef(component as unknown as any) as any;
+}
+
+export const defaultOptionFactory = (item: any) =>
+  typeof item === "object" && item !== null && "value" in item && typeof item["label"] === "string"
+    ? item
+    : { label: item as string, value: item };
+
+export function mergeRefs<T>(...refs: Array<RefCallback<T> | MutableRefObject<T> | ForwardedRef<T>>) {
+  return (el: T) =>
+    refs.forEach((ref) => {
+      if (ref) {
+        if (typeof ref === "function") {
+          ref(el);
+        } else {
+          ref.current = el;
+        }
+      }
+    });
+}

package/src/index.ts

@@ -35,10 +35,13 @@ import ControlledTable from "./table/ControlledTable";
 import ControlledColumn from "./table/ControlledColumn";
 import AddListEntryForm from "./AddListEntryForm";
 import { ScmNestedFormPathContextProvider } from "./FormPathContext";
+import ControlledComboboxField from "./combobox/ControlledComboboxField";
 
+export { default as Combobox } from "./combobox/Combobox";
 export { default as ConfigurationForm } from "./ConfigurationForm";
 export { default as SelectField } from "./select/SelectField";
 export { default as ChipInputField } from "./chip-input/ChipInputField";
+export { default as ComboboxField } from "./combobox/ComboboxField";
 export { default as Select } from "./select/Select";
 export * from "./resourceHooks";
 
@@ -56,4 +59,5 @@ export const Form = Object.assign(FormCmp, {
     Column: ControlledColumn,
   }),
   ChipInput: ControlledChipInputField,
+  Combobox: ControlledComboboxField,
 });