Skip to Content
Prism UI
Reference

@prismrepo/adapter-rhf

usePrismForm and PrismField signatures. Full public export list.

Depends on @prismrepo/core and @prismrepo/forms; react-hook-form as a peer (^7.52.0). See React Hook Form Adapter for the full usage guide.

usePrismForm

function usePrismForm<TRegistry extends FieldRegistry, TValues extends FieldValues>(
  definition: FormDefinition<TRegistry, TValues>,
  options?: UseFormProps<TValues>,
): UseFormReturn<TValues> & {
  readonly registry: TRegistry;
  readonly fieldsConfig: FormFieldsConfig<TRegistry, TValues>;
};

PrismField

function PrismField<
  TRegistry extends FieldRegistry,
  TValues extends FieldValues,
  TName extends FieldPath<TValues>,
>(props: {
  form: UsePrismFormReturn<TRegistry, TValues>;
  name: TName;
  rules?: RegisterOptions<TValues, TName>;
}): ReactElement;

Throws PrismConfigurationError if name has no entry in form.fieldsConfig, or if its configured type isn't in form.registry.

On this page