@trackunit/react-form-components 0.0.288 → 0.0.289

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-form-components",
-  "version": "0.0.288",
+  "version": "0.0.289",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/SelectField/SelectField.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="react" />
+import { CommonProps } from "@trackunit/react-components";
+import { GroupBase } from "react-select";
+import { FormGroupProps } from "../components/FormGroup/FormGroup";
+import { SelectProps } from "../components/Select/useSelect";
+export type BaseOptionType = {
+    label: string;
+    value: string | number;
+};
+type SelectExposedProps<TOptionType extends BaseOptionType> = Omit<SelectProps<TOptionType, false, false, GroupBase<TOptionType>>, "value" | "label" | "onChange" | "defaultValue" | "onBlur">;
+type FormGroupExposedProps = Pick<FormGroupProps, "label" | "tip" | "helpText" | "helpAddon" | "isInvalid">;
+export interface SelectFieldProps<TOptionType extends BaseOptionType> extends CommonProps, FormGroupExposedProps, SelectExposedProps<TOptionType> {
+    onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
+    /**
+     * The options available for the SelectField.
+     */
+    options: TOptionType[];
+    /**
+     * The selected value of the SelectField.
+     */
+    value?: TOptionType["value"];
+    /**
+     * The default selected value of the SelectField.
+     */
+    defaultValue?: TOptionType["value"];
+    /**
+     * The onChange handler for the SelectField.
+     */
+    onChange?: (event: {
+        target: {
+            value?: TOptionType["value"];
+        };
+    }) => void;
+    /**
+     * If a value is set, the field is rendered in its invalid state.
+     */
+    errorMessage?: string;
+}
+/**
+ * The SelectField component is a Select component wrapped in the FromGroup component.
+ *
+ * This means that it can easily be added to any form alongside other Field components.
+ *
+ * This is done to make the field compatible with the React-hook-form library.
+ *
+ * @param {SelectFieldProps} props - The props for the SelectField component
+ * @returns {JSX.Element} SelectField component
+ */
+export declare const SelectField: import("react").ForwardRefExoticComponent<SelectFieldProps<BaseOptionType> & import("react").RefAttributes<HTMLSelectElement>>;
+export {};

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./SelectField/SelectField";
 export * from "./components/ActionButton";
 export * from "./components/BaseInput";
 export * from "./components/Checkbox";