@saas-ui/forms 2.5.4 → 2.6.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @saas-ui/forms
 
+## 2.6.0
+
+### Minor Changes
+
+- 9fe1899: Improved Select types, value type is now string or string[] depending on the multiple prop
+
+### Patch Changes
+
+- Updated dependencies [e75e99b]
+- Updated dependencies [e75e99b]
+  - @saas-ui/core@2.5.0
+
 ## 2.5.4
 
 ### Patch Changes
@@ -1164,12 +1176,12 @@
   Add this somewhere in the root of your project.
 
   ```ts
-  import { Form } from "@saas-ui/react";
-  import { yupResolver, yupFieldResolver } from "@saas-ui/forms/yup"; // yupResolver is exported from here as well for convenience.
-  import { AnyObjectSchema } from "yup";
+  import { Form } from '@saas-ui/react'
+  import { yupResolver, yupFieldResolver } from '@saas-ui/forms/yup' // yupResolver is exported from here as well for convenience.
+  import { AnyObjectSchema } from 'yup'
 
-  Form.getResolver = (schema: AnyObjectSchema) => yupResolver(schema); // @hookform/resolvers
-  Form.getFieldResolver = (schema: AnyObjectSchema) => yupFieldResolver(schema); // AutoForm field resolver
+  Form.getResolver = (schema: AnyObjectSchema) => yupResolver(schema) // @hookform/resolvers
+  Form.getFieldResolver = (schema: AnyObjectSchema) => yupFieldResolver(schema) // AutoForm field resolver
   ```
 
 - 9391c44: Fixed peer dependency issues.

package/dist/index.d.mts

@@ -65,7 +65,7 @@ interface RadioInputProps extends Omit<RadioGroupProps, 'children'>, RadioInputO
 }
 declare const RadioInput: _chakra_ui_react.ComponentWithAs<"div", RadioInputProps>;
 
-interface SelectOptions {
+interface SelectOptions<Multiple extends boolean = false, Value = Multiple extends true ? string[] : string> {
     /**
      * The name of the input field in a native form.
      */
@@ -73,16 +73,16 @@ interface SelectOptions {
     /**
      * The value of the select field.
      */
-    value?: string | string[];
+    value?: Value;
     /**
      * The initial value of the select field.
      */
-    defaultValue?: string | string[];
+    defaultValue?: Value;
     /**
      * The callback invoked when the value of the select field changes.
      * @param value The value of the select field.
      */
-    onChange?: (value: string | string[]) => void;
+    onChange?: (value: Value) => void;
     /**
      * The placeholder text when there's no value.
      */
@@ -99,16 +99,17 @@ interface SelectOptions {
     /**
      * Enable multiple select.
      */
-    multiple?: boolean;
+    multiple?: Multiple;
     /**
      * The function used to render the value of the select field.
      * @param value The value of the select field.
      * @returns The rendered value.
      */
-    renderValue?: (value: string | string[]) => React__default.ReactNode;
+    renderValue?: (value: Value) => React__default.ReactNode;
 }
 
-interface SelectProps extends Omit<MenuProps, 'children' | 'variant' | 'size'>, ThemingProps<'SuiSelect'>, SelectOptions {
+interface SelectProps<Multiple extends boolean = false, Value = Multiple extends true ? string[] : string> extends Omit<MenuProps, 'children' | 'variant' | 'size'>, ThemingProps<'SuiSelect'>, SelectOptions<Multiple, Value> {
+    children: React$1.ReactNode;
 }
 interface SelectButtonProps extends Omit<ButtonProps, 'size' | 'variant'> {
 }
@@ -123,7 +124,11 @@ declare const SelectButton: _chakra_ui_react.ComponentWithAs<"button", SelectBut
  *
  * @see https://saas-ui.dev/docs/components/forms/select
  */
-declare const Select: _chakra_ui_react.ComponentWithAs<"select", SelectProps>;
+declare const Select: (<Multiple extends boolean = false>(props: SelectProps<Multiple> & {
+    ref?: React$1.ForwardedRef<HTMLFormElement>;
+}) => React$1.ReactElement) & {
+    displayName?: string | undefined;
+};
 interface SelectListProps extends MenuListProps {
 }
 /**

package/dist/index.d.ts

@@ -65,7 +65,7 @@ interface RadioInputProps extends Omit<RadioGroupProps, 'children'>, RadioInputO
 }
 declare const RadioInput: _chakra_ui_react.ComponentWithAs<"div", RadioInputProps>;
 
-interface SelectOptions {
+interface SelectOptions<Multiple extends boolean = false, Value = Multiple extends true ? string[] : string> {
     /**
      * The name of the input field in a native form.
      */
@@ -73,16 +73,16 @@ interface SelectOptions {
     /**
      * The value of the select field.
      */
-    value?: string | string[];
+    value?: Value;
     /**
      * The initial value of the select field.
      */
-    defaultValue?: string | string[];
+    defaultValue?: Value;
     /**
      * The callback invoked when the value of the select field changes.
      * @param value The value of the select field.
      */
-    onChange?: (value: string | string[]) => void;
+    onChange?: (value: Value) => void;
     /**
      * The placeholder text when there's no value.
      */
@@ -99,16 +99,17 @@ interface SelectOptions {
     /**
      * Enable multiple select.
      */
-    multiple?: boolean;
+    multiple?: Multiple;
     /**
      * The function used to render the value of the select field.
      * @param value The value of the select field.
      * @returns The rendered value.
      */
-    renderValue?: (value: string | string[]) => React__default.ReactNode;
+    renderValue?: (value: Value) => React__default.ReactNode;
 }
 
-interface SelectProps extends Omit<MenuProps, 'children' | 'variant' | 'size'>, ThemingProps<'SuiSelect'>, SelectOptions {
+interface SelectProps<Multiple extends boolean = false, Value = Multiple extends true ? string[] : string> extends Omit<MenuProps, 'children' | 'variant' | 'size'>, ThemingProps<'SuiSelect'>, SelectOptions<Multiple, Value> {
+    children: React$1.ReactNode;
 }
 interface SelectButtonProps extends Omit<ButtonProps, 'size' | 'variant'> {
 }
@@ -123,7 +124,11 @@ declare const SelectButton: _chakra_ui_react.ComponentWithAs<"button", SelectBut
  *
  * @see https://saas-ui.dev/docs/components/forms/select
  */
-declare const Select: _chakra_ui_react.ComponentWithAs<"select", SelectProps>;
+declare const Select: (<Multiple extends boolean = false>(props: SelectProps<Multiple> & {
+    ref?: React$1.ForwardedRef<HTMLFormElement>;
+}) => React$1.ReactElement) & {
+    displayName?: string | undefined;
+};
 interface SelectListProps extends MenuListProps {
 }
 /**