Hero Hook Form API v2.5.1

Hero Hook Form API / StringFieldConfig

Interface: StringFieldConfig<TFieldValues>

Defined in: types.ts:62 

Extends

• BaseFormFieldConfig<TFieldValues>

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Properties

name

name: Path<TFieldValues>

Defined in: types.ts:41 

Inherited from

BaseFormFieldConfig.name

label?

optional label: string

Defined in: types.ts:42 

Inherited from

BaseFormFieldConfig.label

description?

optional description: string

Defined in: types.ts:43 

Inherited from

BaseFormFieldConfig.description

className?

optional className: string

Defined in: types.ts:44 

Inherited from

BaseFormFieldConfig.className

isDisabled?

optional isDisabled: boolean

Defined in: types.ts:45 

Inherited from

BaseFormFieldConfig.isDisabled

rules?

optional rules: RegisterOptions<TFieldValues, Path<TFieldValues>>

Defined in: types.ts:46 

Inherited from

BaseFormFieldConfig.rules

condition()?

optional condition: (values) => boolean

Defined in: types.ts:49 

Parameters

values

Partial<TFieldValues>

Returns

boolean

Inherited from

BaseFormFieldConfig.condition

dependsOn?

optional dependsOn: Path<TFieldValues>

Defined in: types.ts:50 

Inherited from

BaseFormFieldConfig.dependsOn

dependsOnValue?

optional dependsOnValue: unknown

Defined in: types.ts:51 

Inherited from

BaseFormFieldConfig.dependsOnValue

group?

optional group: string

Defined in: types.ts:54 

Inherited from

BaseFormFieldConfig.group

ariaLabel?

optional ariaLabel: string

Defined in: types.ts:57 

Inherited from

BaseFormFieldConfig.ariaLabel

ariaDescribedBy?

optional ariaDescribedBy: string

Defined in: types.ts:58 

Inherited from

BaseFormFieldConfig.ariaDescribedBy

type

type: "input" | "textarea" | "select" | "autocomplete"

Defined in: types.ts:64 

defaultValue?

optional defaultValue: string

Defined in: types.ts:65 

inputProps?

optional inputProps: Omit<MergeWithAs<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, Omit<Omit<any, "ref">, never>, InputProps, As<any>>, "label" | "value" | "isDisabled" | "isInvalid" | "errorMessage" | "onValueChange">

Defined in: types.ts:66 

textareaProps?

optional textareaProps: Omit<MergeWithAs<Omit<DetailedHTMLProps<TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement>, "ref">, Omit<Omit<any, "ref">, never>, TextAreaProps, As<any>>, "label" | "value" | "isDisabled" | "isInvalid" | "errorMessage" | "onValueChange">

Defined in: types.ts:75 

selectProps?

optional selectProps: Omit<SelectProps<object>, "label" | "isDisabled" | "isInvalid" | "errorMessage" | "onSelectionChange" | "selectedKeys">

Defined in: types.ts:84 

autocompleteProps?

optional autocompleteProps: Omit<AutocompleteProps<object>, "label" | "children" | "isDisabled" | "isInvalid" | "errorMessage" | "onSelectionChange" | "items" | "selectedKey" | "inputValue" | "onInputChange">

Defined in: types.ts:93 

options?

optional options: object[]

Defined in: types.ts:106 

label

label: string

value

value: string | number