Skip to content

API Reference / @gtkx/forms / RegisterOptions

Type Alias: RegisterOptions<TFieldValues, TFieldName>

RegisterOptions<TFieldValues, TFieldName> = Partial<{ deps: FieldPath<TFieldValues> | FieldPath<TFieldValues>[]; disabled: boolean; max: ValidationRule<number | string>; maxLength: ValidationRule<number>; min: ValidationRule<number | string>; minLength: ValidationRule<number>; onBlur?: (event) => void; onChange?: (event) => void; required: Message | ValidationRule<boolean>; setValueAs: (value) => any; shouldUnregister?: boolean; validate: Validate<FieldPathValue<TFieldValues, TFieldName>, TFieldValues> | Record<string, Validate<FieldPathValue<TFieldValues, TFieldName>, TFieldValues>>; value: FieldPathValue<TFieldValues, TFieldName>; }> & { pattern?: ValidationRule<RegExp>; valueAsDate?: false; valueAsNumber?: false; } | { pattern?: undefined; valueAsDate?: true; valueAsNumber?: false; } | { pattern?: undefined; valueAsDate?: false; valueAsNumber?: true; }

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/validator.d.ts:25

Type Parameters

TFieldValues

TFieldValues extends FieldValues = FieldValues

TFieldName

TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>

Released under the MPL-2.0 License.