@factorialco/f0-react 1.360.0 → 1.362.0

package/dist/f0.d.ts

@@ -1263,7 +1263,7 @@ export declare const ChatSpinner: ForwardRefExoticComponent<Omit<SVGProps<SVGSVG
 /**
  * All valid renderIf conditions for checkbox fields
  */
-declare type CheckboxFieldRenderIf = BooleanRenderIfCondition | CommonRenderIfCondition;
+declare type CheckboxFieldRenderIf = BooleanRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 declare interface CheckboxProps extends DataAttributes_2 {
     /**
@@ -1520,7 +1520,7 @@ export declare type CurrentFilters<F extends FilterOptions<string>> = F extends
 /**
  * All valid renderIf conditions for custom fields
  */
-declare type CustomFieldRenderIf = CommonRenderIfCondition;
+declare type CustomFieldRenderIf = CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 /**
  * Props passed to the custom field render function
@@ -1840,7 +1840,7 @@ export declare type DataSourceDefinition<R extends RecordType = RecordType, Filt
 /**
  * All valid renderIf conditions for date fields
  */
-declare type DateFieldRenderIf = DateRenderIfCondition | CommonRenderIfCondition;
+declare type DateFieldRenderIf = DateRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 export declare type DateFilterDefinition = BaseFilterDefinition<"date"> & {
     options?: DateFilterOptions_2;
@@ -1925,7 +1925,7 @@ declare type DateRangeComplete = Required<DateRange>;
 /**
  * All valid renderIf conditions for date range fields
  */
-declare type DateRangeFieldRenderIf = DateRangeRenderIfCondition | CommonRenderIfCondition;
+declare type DateRangeFieldRenderIf = DateRangeRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 /**
  * Base for date range-specific conditions
@@ -2674,9 +2674,9 @@ export declare interface ErrorMessageProps {
 }
 
 /**
- * Evaluate a renderIf condition against the current form values
+ * Evaluate a renderIf property which can be a condition object or a function
  */
-export declare function evaluateRenderIf(condition: RenderIfCondition, values: Record<string, unknown>): boolean;
+export declare function evaluateRenderIf(renderIf: F0BaseFieldRenderIfProp, values: Record<string, unknown>): boolean;
 
 declare type EventCatcherFunction = (eventName: EventName, params: EventParams) => void;
 
@@ -3040,12 +3040,36 @@ export declare interface F0BaseConfig {
     placeholder?: string;
     /** Helper text displayed below the field */
     helpText?: string;
-    /** Whether the field is disabled */
-    disabled?: boolean;
+    /**
+     * Whether the field is disabled.
+     * Can be a boolean or a function that receives form values.
+     * @example
+     * // Static disabled
+     * disabled: true
+     *
+     * // Dynamic disabled based on other field values
+     * disabled: ({ values }) => values.status === 'readonly'
+     */
+    disabled?: F0BaseFieldDisabledProp;
+    /**
+     * When true, resets the field to its default value when it becomes disabled.
+     * Useful for clearing dependent fields when their controlling field changes.
+     * @default false
+     */
+    resetOnDisable?: boolean;
     /** Row ID for horizontal grouping with other fields */
     row?: string;
-    /** Conditional rendering based on another field's value */
-    renderIf?: RenderIfCondition;
+    /**
+     * Conditional rendering based on another field's value.
+     * Can be a condition object or a function that receives form values.
+     * @example
+     * // Condition object
+     * renderIf: { fieldId: 'status', equalsTo: 'active' }
+     *
+     * // Dynamic renderIf based on form values
+     * renderIf: ({ values }) => values.status === 'active'
+     */
+    renderIf?: F0BaseFieldRenderIfProp;
 }
 
 /**
@@ -3062,10 +3086,49 @@ export declare interface F0BaseField {
     helpText?: string;
     /** Placeholder text for the input */
     placeholder?: string;
-    /** Whether the field is disabled */
-    disabled?: boolean;
+    /**
+     * Whether the field is disabled.
+     * Can be a boolean or a function that receives form values.
+     * @example
+     * // Static disabled
+     * disabled: true
+     *
+     * // Dynamic disabled based on other field values
+     * disabled: ({ values }) => values.status === 'readonly'
+     */
+    disabled?: F0BaseFieldDisabledProp;
+    /**
+     * When true, resets the field to its default value when it becomes disabled.
+     * Useful for clearing dependent fields when their controlling field changes.
+     * @default false
+     */
+    resetOnDisable?: boolean;
 }
 
+/**
+ * Function type for dynamic disabled evaluation based on form values
+ */
+declare type F0BaseFieldDisabledFunction = (context: {
+    values: Record<string, unknown>;
+}) => boolean;
+
+/**
+ * Disabled property can be a boolean or a function that receives form values
+ */
+declare type F0BaseFieldDisabledProp = boolean | F0BaseFieldDisabledFunction;
+
+/**
+ * Function type for dynamic renderIf evaluation based on form values
+ */
+declare type F0BaseFieldRenderIfFunction = (context: {
+    values: Record<string, unknown>;
+}) => boolean;
+
+/**
+ * RenderIf property can be a condition object or a function that receives form values
+ */
+declare type F0BaseFieldRenderIfProp = RenderIfCondition | F0BaseFieldRenderIfFunction;
+
 export declare const F0BigNumber: {
     ({ label, ...props }: BigNumberProps_2): JSX_2.Element;
     displayName: string;
@@ -3678,6 +3741,12 @@ declare interface F0FormDefaultSubmitConfig extends F0FormSubmitConfigBase {
      * @default "default"
      */
     type?: "default";
+    /**
+     * When true, hides the submit button.
+     * Useful when using `useF0Form` hook to submit from outside the form.
+     * @default false
+     */
+    hideSubmitButton?: boolean;
 }
 
 /**
@@ -3839,6 +3908,40 @@ export declare interface F0FormProps<TSchema extends z.ZodObject<ZodRawShape>> {
      * Controls section sidebar visibility and box wrapping.
      */
     styling?: F0FormStylingConfig;
+    /**
+     * Ref to control the form programmatically from outside.
+     * Use with the `useF0Form` hook to get a ref and submit/reset functions.
+     *
+     * @example
+     * ```tsx
+     * const { formRef, submit } = useF0Form()
+     *
+     * <F0Form formRef={formRef} ... />
+     * <Button onClick={submit}>Submit</Button>
+     * ```
+     */
+    formRef?: React.MutableRefObject<F0FormRef | null>;
+}
+
+/**
+ * Interface for the F0Form ref methods
+ */
+export declare interface F0FormRef {
+    /**
+     * Programmatically submit the form.
+     * Will only call onSubmit if validation passes.
+     * @returns Promise that resolves when submission completes (or rejects on validation failure)
+     */
+    submit: () => Promise<void>;
+    /**
+     * Reset the form to its default values
+     */
+    reset: () => void;
+    /**
+     * Check if the form has unsaved changes
+     */
+    isDirty: () => boolean;
+    /* Excluded from this release type: _setStateCallback */
 }
 
 /**
@@ -3846,6 +3949,14 @@ export declare interface F0FormProps<TSchema extends z.ZodObject<ZodRawShape>> {
  */
 export declare type F0FormSchema<T extends Record<string, ZodTypeAny>> = z.ZodObject<T>;
 
+/**
+ * Callback to update form state in the hook
+ */
+declare type F0FormStateCallback = (state: {
+    isSubmitting: boolean;
+    hasErrors: boolean;
+}) => void;
+
 /**
  * Styling configuration for the form layout and appearance
  */
@@ -5512,7 +5623,7 @@ export declare interface NextStepsProps {
 /**
  * All valid renderIf conditions for number fields
  */
-declare type NumberFieldRenderIf = NumberRenderIfCondition | CommonRenderIfCondition;
+declare type NumberFieldRenderIf = NumberRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 export declare type NumberFilterDefinition = BaseFilterDefinition<"number"> & {
     options?: NumberFilterOptions_2;
@@ -6212,7 +6323,7 @@ export declare interface ResponsiveStyleProps {
 /**
  * All valid renderIf conditions for richtext fields
  */
-declare type RichTextFieldRenderIf = CommonRenderIfCondition;
+declare type RichTextFieldRenderIf = CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 /**
  * Rich text editor result value type
@@ -6272,7 +6383,7 @@ declare type SecondaryActionsItems = SecondaryActionItem[] | SecondaryActionItem
 /**
  * Conditional rendering for sections - can be a condition object or a function
  */
-export declare type SectionRenderIf = RenderIfCondition | ((values: Record<string, unknown>) => boolean);
+export declare type SectionRenderIf = RenderIfCondition | F0BaseFieldRenderIfFunction;
 
 /**
  * Represents a collection of selected items.
@@ -6315,7 +6426,7 @@ export declare type SelectedState = {
 /**
  * All valid renderIf conditions for select fields
  */
-declare type SelectFieldRenderIf = SelectRenderIfCondition | CommonRenderIfCondition;
+declare type SelectFieldRenderIf = SelectRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 export declare type SelectionId = number | string;
 
@@ -6471,7 +6582,7 @@ declare type SummaryType = "sum";
 /**
  * All valid renderIf conditions for switch fields
  */
-declare type SwitchFieldRenderIf = BooleanRenderIfCondition | CommonRenderIfCondition;
+declare type SwitchFieldRenderIf = BooleanRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 export declare function Table({ children, ...props }: React.HTMLAttributes<HTMLTableElement>): JSX_2.Element;
 
@@ -6745,12 +6856,12 @@ declare type TeamTagProps = ComponentProps<typeof F0TagTeam>;
 /**
  * All valid renderIf conditions for textarea fields
  */
-declare type TextareaFieldRenderIf = TextRenderIfCondition | CommonRenderIfCondition;
+declare type TextareaFieldRenderIf = TextRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 /**
  * All valid renderIf conditions for text fields
  */
-declare type TextFieldRenderIf = TextRenderIfCondition | CommonRenderIfCondition;
+declare type TextFieldRenderIf = TextRenderIfCondition | CommonRenderIfCondition | F0BaseFieldRenderIfFunction;
 
 declare interface TextProps extends Omit<default_2.HTMLAttributes<HTMLElement>, "className">, default_2.RefAttributes<HTMLElement> {
     /**
@@ -7193,6 +7304,79 @@ export declare const useEmojiConfetti: () => {
 
 export declare const useF0Dialog: () => F0DialogContextType;
 
+/**
+ * Hook to control F0Form programmatically.
+ *
+ * Useful when you need to submit the form from outside the component,
+ * such as when the form is inside a dialog and the submit button is
+ * in the dialog's footer.
+ *
+ * @example
+ * ```tsx
+ * import { useF0Form, F0Form } from "@factorialco/factorial-one/experimental"
+ *
+ * function FormInDialog() {
+ *   const { formRef, submit } = useF0Form()
+ *   const [open, setOpen] = useState(false)
+ *
+ *   return (
+ *     <Dialog open={open} onOpenChange={setOpen}>
+ *       <DialogContent>
+ *         <F0Form
+ *           formRef={formRef}
+ *           name="my-form"
+ *           schema={schema}
+ *           defaultValues={defaultValues}
+ *           onSubmit={async (data) => {
+ *             // Handle submission
+ *             setOpen(false)
+ *             return { success: true }
+ *           }}
+ *         />
+ *         <DialogFooter>
+ *           <Button onClick={() => setOpen(false)}>Cancel</Button>
+ *           <Button onClick={submit}>Save</Button>
+ *         </DialogFooter>
+ *       </DialogContent>
+ *     </Dialog>
+ *   )
+ * }
+ * ```
+ */
+export declare function useF0Form(): UseF0FormReturn;
+
+/**
+ * Return type for the useF0Form hook
+ */
+export declare interface UseF0FormReturn {
+    /**
+     * Ref to pass to the F0Form component's `formRef` prop
+     */
+    formRef: React.MutableRefObject<F0FormRef | null>;
+    /**
+     * Programmatically submit the form.
+     * Will only trigger onSubmit if all validations pass.
+     * @returns Promise that resolves when submission completes
+     */
+    submit: () => Promise<void>;
+    /**
+     * Reset the form to its default values
+     */
+    reset: () => void;
+    /**
+     * Check if the form has unsaved changes
+     */
+    isDirty: () => boolean;
+    /**
+     * Whether the form is currently submitting
+     */
+    isSubmitting: boolean;
+    /**
+     * Whether the form has validation errors
+     */
+    hasErrors: boolean;
+}
+
 export declare const useGroups: <R extends RecordType>(groups: GroupRecord<R>[], defaultOpenGroups?: boolean | GroupRecord<R>["key"][]) => {
     openGroups: Record<string, boolean>;
     setGroupOpen: (key: string, open: boolean) => void;