@fogpipe/forma-react 0.11.2 → 0.12.0-alpha.2

package/dist/index.d.ts

@@ -34,12 +34,22 @@ interface BaseFieldProps {
     visible: boolean;
     /** Whether field is enabled (inverse of disabled) */
     enabled: boolean;
+    /** Whether field is readonly (visible, not editable, value still submitted) */
+    readonly: boolean;
     /** Display label from field definition */
     label: string;
     /** Help text or description from field definition */
     description?: string;
     /** Placeholder text from field definition */
     placeholder?: string;
+    /** Prefix adorner text (e.g., "$") - only for adornable field types */
+    prefix?: string;
+    /** Suffix adorner text (e.g., "kg") - only for adornable field types */
+    suffix?: string;
+    /** Presentation variant hint (e.g., "slider", "radio", "nps") */
+    variant?: string;
+    /** Variant-specific configuration */
+    variantConfig?: Record<string, unknown>;
 }
 /**
  * Props for text-based fields (text, email, password, url, textarea)
@@ -226,10 +236,25 @@ interface ArrayItemFieldProps extends Omit<BaseFieldProps, "value" | "onChange">
     /** Field name within the item */
     fieldName: string;
 }
+/**
+ * Props for display fields (read-only presentation content)
+ */
+interface DisplayFieldProps extends Omit<BaseFieldProps, "value" | "onChange"> {
+    fieldType: "display";
+    /** Static content (markdown/text) */
+    content?: string;
+    /** Computed source value (resolved by useForma from display field's source property) */
+    sourceValue?: unknown;
+    /** Display format string */
+    format?: string;
+    /** No onChange - display fields are read-only */
+    onChange?: never;
+    value?: never;
+}
 /**
  * Union of all field prop types
  */
-type FieldProps = TextFieldProps | NumberFieldProps | IntegerFieldProps | BooleanFieldProps | DateFieldProps | DateTimeFieldProps | SelectFieldProps | MultiSelectFieldProps | ArrayFieldProps | ObjectFieldProps | ComputedFieldProps;
+type FieldProps = TextFieldProps | NumberFieldProps | IntegerFieldProps | BooleanFieldProps | DateFieldProps | DateTimeFieldProps | SelectFieldProps | MultiSelectFieldProps | ArrayFieldProps | ObjectFieldProps | ComputedFieldProps | DisplayFieldProps;
 /**
  * Map of field types to React components
  * Components receive wrapper props with { field, spec } structure
@@ -250,6 +275,7 @@ interface ComponentMap {
     array?: React.ComponentType<ArrayComponentProps>;
     object?: React.ComponentType<ObjectComponentProps>;
     computed?: React.ComponentType<ComputedComponentProps>;
+    display?: React.ComponentType<DisplayComponentProps>;
     fallback?: React.ComponentType<FieldComponentProps>;
 }
 /**
@@ -338,6 +364,10 @@ interface ComputedComponentProps {
     field: ComputedFieldProps;
     spec: Forma;
 }
+interface DisplayComponentProps {
+    field: DisplayFieldProps;
+    spec: Forma;
+}
 /**
  * Generic field component props (for fallback/dynamic components)
  */
@@ -367,6 +397,8 @@ interface GetFieldPropsResult {
     visible: boolean;
     /** Whether field is enabled (not disabled) */
     enabled: boolean;
+    /** Whether field is readonly (visible, not editable, value still submitted) */
+    readonly: boolean;
     /** Whether field is required (for validation) */
     required: boolean;
     /**
@@ -390,6 +422,14 @@ interface GetFieldPropsResult {
     "aria-required"?: boolean;
     /** Options for select/multiselect fields (filtered by visibleWhen) */
     options?: SelectOption[];
+    /** Prefix adorner text (e.g., "$") */
+    prefix?: string;
+    /** Suffix adorner text (e.g., "kg") */
+    suffix?: string;
+    /** Presentation variant hint */
+    variant?: string;
+    /** Variant-specific configuration */
+    variantConfig?: Record<string, unknown>;
 }
 /**
  * Select field props returned by getSelectFieldProps()
@@ -501,6 +541,8 @@ interface UseFormaReturn {
     required: Record<string, boolean>;
     /** Field enabled state map */
     enabled: Record<string, boolean>;
+    /** Field readonly state map */
+    readonly: Record<string, boolean>;
     /** Visible options for select/multiselect fields, keyed by field path */
     optionsVisibility: OptionsVisibilityResult;
     /** Field touched state map */
@@ -616,7 +658,7 @@ interface FieldRendererProps {
  * <FieldRenderer fieldPath="email" components={componentMap} />
  * ```
  */
-declare function FieldRenderer({ fieldPath, components, className }: FieldRendererProps): react_jsx_runtime.JSX.Element | null;
+declare function FieldRenderer({ fieldPath, components, className, }: FieldRendererProps): react_jsx_runtime.JSX.Element | null;
 
 /**
  * FormaErrorBoundary Component
@@ -680,4 +722,4 @@ declare const FormaContext: React$1.Context<UseFormaReturn | null>;
  */
 declare function useFormaContext(): UseFormaReturn;
 
-export { type ArrayComponentProps, type ArrayFieldProps, type ArrayHelpers, type ArrayItemFieldProps, type ArrayItemFieldPropsResult, type BaseFieldProps, type BooleanComponentProps, type BooleanFieldProps, type ComponentMap, type ComputedComponentProps, type ComputedFieldProps, type DateComponentProps, type DateFieldProps, type DateTimeComponentProps, type DateTimeFieldProps, type FieldComponentProps, type FieldProps, FieldRenderer, type FieldRendererProps, type FieldWrapperProps, FormRenderer, type FormRendererHandle, type FormRendererProps, type UseFormaReturn as FormState, FormaContext, FormaErrorBoundary, type FormaErrorBoundaryProps, type GetArrayHelpersResult, type GetFieldPropsResult, type GetSelectFieldPropsResult, type IntegerComponentProps, type IntegerFieldProps, type LayoutProps, type LegacyFieldProps, type MultiSelectComponentProps, type MultiSelectFieldProps, type NumberComponentProps, type NumberFieldProps, type ObjectComponentProps, type ObjectFieldProps, type PageState, type PageWrapperProps, type SelectComponentProps, type SelectFieldProps, type SelectionFieldProps, type TextComponentProps, type TextFieldProps, type UseFormaOptions, type UseFormaReturn, type WizardHelpers, useForma, useFormaContext };
+export { type ArrayComponentProps, type ArrayFieldProps, type ArrayHelpers, type ArrayItemFieldProps, type ArrayItemFieldPropsResult, type BaseFieldProps, type BooleanComponentProps, type BooleanFieldProps, type ComponentMap, type ComputedComponentProps, type ComputedFieldProps, type DateComponentProps, type DateFieldProps, type DateTimeComponentProps, type DateTimeFieldProps, type DisplayComponentProps, type DisplayFieldProps, type FieldComponentProps, type FieldProps, FieldRenderer, type FieldRendererProps, type FieldWrapperProps, FormRenderer, type FormRendererHandle, type FormRendererProps, type UseFormaReturn as FormState, FormaContext, FormaErrorBoundary, type FormaErrorBoundaryProps, type GetArrayHelpersResult, type GetFieldPropsResult, type GetSelectFieldPropsResult, type IntegerComponentProps, type IntegerFieldProps, type LayoutProps, type LegacyFieldProps, type MultiSelectComponentProps, type MultiSelectFieldProps, type NumberComponentProps, type NumberFieldProps, type ObjectComponentProps, type ObjectFieldProps, type PageState, type PageWrapperProps, type SelectComponentProps, type SelectFieldProps, type SelectionFieldProps, type TextComponentProps, type TextFieldProps, type UseFormaOptions, type UseFormaReturn, type WizardHelpers, useForma, useFormaContext };