forms
FormErrorProps
Defined in: src/forms/FormError/FormError.tsx:17
Extends
Omit<ErrorStateProps,"children"|"prefix"|"entityName">
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
variant? | | "default" | "secondary" | "success" | "successLight" | "warning" | "warningLight" | "destructive" | "destructiveLight" | "outline" | null | Controls the visual variant of the badge. - default: filled with primary color. - secondary: filled with secondary color. - success: filled with success color. Should be used for indicating positive and successful statues. - successLight: filled with success color of reduced opacity. Should be used for indicating positive and successful statues. - warning: filled with warning color. Should be used for bringing users' attention to potential upcoming problems or semi-success statuses. - warningLight: filled with warning color of reduced opacity. Should be used for bringing users' attention to potential upcoming problems or semi-negative statuses. - destructive: filled with destructive color. Should be used for indicating negative and unsuccessful statues. - destructiveLight: filled with destructive color of reduced opacity. Should be used for indicating negative and unsuccessful statues. - outline: bordered, transparent fill Default "default" | Omit.variant | src/components/Badge/Badge.tsx:39 |
size? | "sm" | "lg" | null | Affects padding, font size, border radius and gap. - sm - lg Default "sm" | Omit.size | src/components/Badge/Badge.tsx:63 |
asChild? | boolean | - | ErrorStateProps.asChild | src/components/Badge/Badge.tsx:78 |
formError | ReactNode | ErrorOption | - | - | src/forms/FormError/FormError.tsx:19 |
prefix? | ReactNode | - | - | src/forms/FormError/FormError.tsx:20 |
key? | Key | null | - | ButtonProps.key | node_modules/@types/react/index.d.ts:250 |
ref? | Ref<HTMLDivElement> | Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref). See React Docs | Omit.ref | node_modules/@types/react/index.d.ts:292 |
dangerouslySetInnerHTML? | object | - | Omit.dangerouslySetInnerHTML | node_modules/@types/react/index.d.ts:2231 |
dangerouslySetInnerHTML.__html | string | TrustedHTML | - | - | node_modules/@types/react/index.d.ts:2234 |
onCopy? | ClipboardEventHandler<HTMLDivElement> | - | Omit.onCopy | node_modules/@types/react/index.d.ts:2238 |
onCopyCapture? | ClipboardEventHandler<HTMLDivElement> | - | Omit.onCopyCapture | node_modules/@types/react/index.d.ts:2239 |
onCut? | ClipboardEventHandler<HTMLDivElement> | - | Omit.onCut | node_modules/@types/react/index.d.ts:2240 |
onCutCapture? | ClipboardEventHandler<HTMLDivElement> | - | Omit.onCutCapture | node_modules/@types/react/index.d.ts:2241 |
onPaste? | ClipboardEventHandler<HTMLDivElement> | - | Omit.onPaste | node_modules/@types/react/index.d.ts:2242 |
onPasteCapture? | ClipboardEventHandler<HTMLDivElement> | - | Omit.onPasteCapture | node_modules/@types/react/index.d.ts:2243 |
onCompositionEnd? | CompositionEventHandler<HTMLDivElement> | - | Omit.onCompositionEnd | node_modules/@types/react/index.d.ts:2246 |
onCompositionEndCapture? | CompositionEventHandler<HTMLDivElement> | - | Omit.onCompositionEndCapture | node_modules/@types/react/index.d.ts:2247 |
onCompositionStart? | CompositionEventHandler<HTMLDivElement> | - | Omit.onCompositionStart | node_modules/@types/react/index.d.ts:2248 |
onCompositionStartCapture? | CompositionEventHandler<HTMLDivElement> | - | Omit.onCompositionStartCapture | node_modules/@types/react/index.d.ts:2249 |
onCompositionUpdate? | CompositionEventHandler<HTMLDivElement> | - | Omit.onCompositionUpdate | node_modules/@types/react/index.d.ts:2250 |
onCompositionUpdateCapture? | CompositionEventHandler<HTMLDivElement> | - | Omit.onCompositionUpdateCapture | node_modules/@types/react/index.d.ts:2251 |
onFocus? | FocusEventHandler<HTMLDivElement> | - | Omit.onFocus | node_modules/@types/react/index.d.ts:2254 |
onFocusCapture? | FocusEventHandler<HTMLDivElement> | - | Omit.onFocusCapture | node_modules/@types/react/index.d.ts:2255 |
onBlur? | FocusEventHandler<HTMLDivElement> | - | Omit.onBlur | node_modules/@types/react/index.d.ts:2256 |
onBlurCapture? | FocusEventHandler<HTMLDivElement> | - | Omit.onBlurCapture | node_modules/@types/react/index.d.ts:2257 |
onChange? | FormEventHandler<HTMLDivElement> | - | Omit.onChange | node_modules/@types/react/index.d.ts:2260 |
onChangeCapture? | FormEventHandler<HTMLDivElement> | - | Omit.onChangeCapture | node_modules/@types/react/index.d.ts:2261 |
onBeforeInput? | InputEventHandler<HTMLDivElement> | - | Omit.onBeforeInput | node_modules/@types/react/index.d.ts:2262 |
onBeforeInputCapture? | FormEventHandler<HTMLDivElement> | - | Omit.onBeforeInputCapture | node_modules/@types/react/index.d.ts:2263 |
onInput? | FormEventHandler<HTMLDivElement> | - | Omit.onInput | node_modules/@types/react/index.d.ts:2264 |
onInputCapture? | FormEventHandler<HTMLDivElement> | - | Omit.onInputCapture | node_modules/@types/react/index.d.ts:2265 |
onReset? | FormEventHandler<HTMLDivElement> | - | Omit.onReset | node_modules/@types/react/index.d.ts:2266 |
onResetCapture? | FormEventHandler<HTMLDivElement> | - | Omit.onResetCapture | node_modules/@types/react/index.d.ts:2267 |
onSubmit? | FormEventHandler<HTMLDivElement> | - | Omit.onSubmit | node_modules/@types/react/index.d.ts:2268 |
onSubmitCapture? | FormEventHandler<HTMLDivElement> | - | Omit.onSubmitCapture | node_modules/@types/react/index.d.ts:2269 |
onInvalid? | FormEventHandler<HTMLDivElement> | - | Omit.onInvalid | node_modules/@types/react/index.d.ts:2270 |
onInvalidCapture? | FormEventHandler<HTMLDivElement> | - | Omit.onInvalidCapture | node_modules/@types/react/index.d.ts:2271 |
onLoad? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoad | node_modules/@types/react/index.d.ts:2274 |
onLoadCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoadCapture | node_modules/@types/react/index.d.ts:2275 |
onError? | ReactEventHandler<HTMLDivElement> | - | Omit.onError | node_modules/@types/react/index.d.ts:2276 |
onErrorCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onErrorCapture | node_modules/@types/react/index.d.ts:2277 |
onKeyDown? | KeyboardEventHandler<HTMLDivElement> | - | Omit.onKeyDown | node_modules/@types/react/index.d.ts:2280 |
onKeyDownCapture? | KeyboardEventHandler<HTMLDivElement> | - | Omit.onKeyDownCapture | node_modules/@types/react/index.d.ts:2281 |
onKeyPress? | KeyboardEventHandler<HTMLDivElement> | Deprecated Use onKeyUp or onKeyDown instead | Omit.onKeyPress | node_modules/@types/react/index.d.ts:2283 |
onKeyPressCapture? | KeyboardEventHandler<HTMLDivElement> | Deprecated Use onKeyUpCapture or onKeyDownCapture instead | Omit.onKeyPressCapture | node_modules/@types/react/index.d.ts:2285 |
onKeyUp? | KeyboardEventHandler<HTMLDivElement> | - | Omit.onKeyUp | node_modules/@types/react/index.d.ts:2286 |
onKeyUpCapture? | KeyboardEventHandler<HTMLDivElement> | - | Omit.onKeyUpCapture | node_modules/@types/react/index.d.ts:2287 |
onAbort? | ReactEventHandler<HTMLDivElement> | - | Omit.onAbort | node_modules/@types/react/index.d.ts:2290 |
onAbortCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onAbortCapture | node_modules/@types/react/index.d.ts:2291 |
onCanPlay? | ReactEventHandler<HTMLDivElement> | - | Omit.onCanPlay | node_modules/@types/react/index.d.ts:2292 |
onCanPlayCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onCanPlayCapture | node_modules/@types/react/index.d.ts:2293 |
onCanPlayThrough? | ReactEventHandler<HTMLDivElement> | - | Omit.onCanPlayThrough | node_modules/@types/react/index.d.ts:2294 |
onCanPlayThroughCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onCanPlayThroughCapture | node_modules/@types/react/index.d.ts:2295 |
onDurationChange? | ReactEventHandler<HTMLDivElement> | - | Omit.onDurationChange | node_modules/@types/react/index.d.ts:2296 |
onDurationChangeCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onDurationChangeCapture | node_modules/@types/react/index.d.ts:2297 |
onEmptied? | ReactEventHandler<HTMLDivElement> | - | Omit.onEmptied | node_modules/@types/react/index.d.ts:2298 |
onEmptiedCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onEmptiedCapture | node_modules/@types/react/index.d.ts:2299 |
onEncrypted? | ReactEventHandler<HTMLDivElement> | - | Omit.onEncrypted | node_modules/@types/react/index.d.ts:2300 |
onEncryptedCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onEncryptedCapture | node_modules/@types/react/index.d.ts:2301 |
onEnded? | ReactEventHandler<HTMLDivElement> | - | Omit.onEnded | node_modules/@types/react/index.d.ts:2302 |
onEndedCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onEndedCapture | node_modules/@types/react/index.d.ts:2303 |
onLoadedData? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoadedData | node_modules/@types/react/index.d.ts:2304 |
onLoadedDataCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoadedDataCapture | node_modules/@types/react/index.d.ts:2305 |
onLoadedMetadata? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoadedMetadata | node_modules/@types/react/index.d.ts:2306 |
onLoadedMetadataCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoadedMetadataCapture | node_modules/@types/react/index.d.ts:2307 |
onLoadStart? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoadStart | node_modules/@types/react/index.d.ts:2308 |
onLoadStartCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onLoadStartCapture | node_modules/@types/react/index.d.ts:2309 |
onPause? | ReactEventHandler<HTMLDivElement> | - | Omit.onPause | node_modules/@types/react/index.d.ts:2310 |
onPauseCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onPauseCapture | node_modules/@types/react/index.d.ts:2311 |
onPlay? | ReactEventHandler<HTMLDivElement> | - | Omit.onPlay | node_modules/@types/react/index.d.ts:2312 |
onPlayCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onPlayCapture | node_modules/@types/react/index.d.ts:2313 |
onPlaying? | ReactEventHandler<HTMLDivElement> | - | Omit.onPlaying | node_modules/@types/react/index.d.ts:2314 |
onPlayingCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onPlayingCapture | node_modules/@types/react/index.d.ts:2315 |
onProgress? | ReactEventHandler<HTMLDivElement> | - | Omit.onProgress | node_modules/@types/react/index.d.ts:2316 |
onProgressCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onProgressCapture | node_modules/@types/react/index.d.ts:2317 |
onRateChange? | ReactEventHandler<HTMLDivElement> | - | Omit.onRateChange | node_modules/@types/react/index.d.ts:2318 |
onRateChangeCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onRateChangeCapture | node_modules/@types/react/index.d.ts:2319 |
onSeeked? | ReactEventHandler<HTMLDivElement> | - | Omit.onSeeked | node_modules/@types/react/index.d.ts:2320 |
onSeekedCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onSeekedCapture | node_modules/@types/react/index.d.ts:2321 |
onSeeking? | ReactEventHandler<HTMLDivElement> | - | Omit.onSeeking | node_modules/@types/react/index.d.ts:2322 |
onSeekingCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onSeekingCapture | node_modules/@types/react/index.d.ts:2323 |
onStalled? | ReactEventHandler<HTMLDivElement> | - | Omit.onStalled | node_modules/@types/react/index.d.ts:2324 |
onStalledCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onStalledCapture | node_modules/@types/react/index.d.ts:2325 |
onSuspend? | ReactEventHandler<HTMLDivElement> | - | Omit.onSuspend | node_modules/@types/react/index.d.ts:2326 |
onSuspendCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onSuspendCapture | node_modules/@types/react/index.d.ts:2327 |
onTimeUpdate? | ReactEventHandler<HTMLDivElement> | - | Omit.onTimeUpdate | node_modules/@types/react/index.d.ts:2328 |
onTimeUpdateCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onTimeUpdateCapture | node_modules/@types/react/index.d.ts:2329 |
onVolumeChange? | ReactEventHandler<HTMLDivElement> | - | Omit.onVolumeChange | node_modules/@types/react/index.d.ts:2330 |
onVolumeChangeCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onVolumeChangeCapture | node_modules/@types/react/index.d.ts:2331 |
onWaiting? | ReactEventHandler<HTMLDivElement> | - | Omit.onWaiting | node_modules/@types/react/index.d.ts:2332 |
onWaitingCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onWaitingCapture | node_modules/@types/react/index.d.ts:2333 |
onAuxClick? | MouseEventHandler<HTMLDivElement> | - | Omit.onAuxClick | node_modules/@types/react/index.d.ts:2336 |
onAuxClickCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onAuxClickCapture | node_modules/@types/react/index.d.ts:2337 |
onClick? | MouseEventHandler<HTMLDivElement> | - | Omit.onClick | node_modules/@types/react/index.d.ts:2338 |
onClickCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onClickCapture | node_modules/@types/react/index.d.ts:2339 |
onContextMenu? | MouseEventHandler<HTMLDivElement> | - | Omit.onContextMenu | node_modules/@types/react/index.d.ts:2340 |
onContextMenuCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onContextMenuCapture | node_modules/@types/react/index.d.ts:2341 |
onDoubleClick? | MouseEventHandler<HTMLDivElement> | - | Omit.onDoubleClick | node_modules/@types/react/index.d.ts:2342 |
onDoubleClickCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onDoubleClickCapture | node_modules/@types/react/index.d.ts:2343 |
onDrag? | DragEventHandler<HTMLDivElement> | - | Omit.onDrag | node_modules/@types/react/index.d.ts:2344 |
onDragCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDragCapture | node_modules/@types/react/index.d.ts:2345 |
onDragEnd? | DragEventHandler<HTMLDivElement> | - | Omit.onDragEnd | node_modules/@types/react/index.d.ts:2346 |
onDragEndCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDragEndCapture | node_modules/@types/react/index.d.ts:2347 |
onDragEnter? | DragEventHandler<HTMLDivElement> | - | Omit.onDragEnter | node_modules/@types/react/index.d.ts:2348 |
onDragEnterCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDragEnterCapture | node_modules/@types/react/index.d.ts:2349 |
onDragExit? | DragEventHandler<HTMLDivElement> | - | Omit.onDragExit | node_modules/@types/react/index.d.ts:2350 |
onDragExitCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDragExitCapture | node_modules/@types/react/index.d.ts:2351 |
onDragLeave? | DragEventHandler<HTMLDivElement> | - | Omit.onDragLeave | node_modules/@types/react/index.d.ts:2352 |
onDragLeaveCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDragLeaveCapture | node_modules/@types/react/index.d.ts:2353 |
onDragOver? | DragEventHandler<HTMLDivElement> | - | Omit.onDragOver | node_modules/@types/react/index.d.ts:2354 |
onDragOverCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDragOverCapture | node_modules/@types/react/index.d.ts:2355 |
onDragStart? | DragEventHandler<HTMLDivElement> | - | Omit.onDragStart | node_modules/@types/react/index.d.ts:2356 |
onDragStartCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDragStartCapture | node_modules/@types/react/index.d.ts:2357 |
onDrop? | DragEventHandler<HTMLDivElement> | - | Omit.onDrop | node_modules/@types/react/index.d.ts:2358 |
onDropCapture? | DragEventHandler<HTMLDivElement> | - | Omit.onDropCapture | node_modules/@types/react/index.d.ts:2359 |
onMouseDown? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseDown | node_modules/@types/react/index.d.ts:2360 |
onMouseDownCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseDownCapture | node_modules/@types/react/index.d.ts:2361 |
onMouseEnter? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseEnter | node_modules/@types/react/index.d.ts:2362 |
onMouseLeave? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseLeave | node_modules/@types/react/index.d.ts:2363 |
onMouseMove? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseMove | node_modules/@types/react/index.d.ts:2364 |
onMouseMoveCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseMoveCapture | node_modules/@types/react/index.d.ts:2365 |
onMouseOut? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseOut | node_modules/@types/react/index.d.ts:2366 |
onMouseOutCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseOutCapture | node_modules/@types/react/index.d.ts:2367 |
onMouseOver? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseOver | node_modules/@types/react/index.d.ts:2368 |
onMouseOverCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseOverCapture | node_modules/@types/react/index.d.ts:2369 |
onMouseUp? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseUp | node_modules/@types/react/index.d.ts:2370 |
onMouseUpCapture? | MouseEventHandler<HTMLDivElement> | - | Omit.onMouseUpCapture | node_modules/@types/react/index.d.ts:2371 |
onSelect? | ReactEventHandler<HTMLDivElement> | - | Omit.onSelect | node_modules/@types/react/index.d.ts:2374 |
onSelectCapture? | ReactEventHandler<HTMLDivElement> | - | Omit.onSelectCapture | node_modules/@types/react/index.d.ts:2375 |
onTouchCancel? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchCancel | node_modules/@types/react/index.d.ts:2378 |
onTouchCancelCapture? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchCancelCapture | node_modules/@types/react/index.d.ts:2379 |
onTouchEnd? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchEnd | node_modules/@types/react/index.d.ts:2380 |
onTouchEndCapture? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchEndCapture | node_modules/@types/react/index.d.ts:2381 |
onTouchMove? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchMove | node_modules/@types/react/index.d.ts:2382 |
onTouchMoveCapture? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchMoveCapture | node_modules/@types/react/index.d.ts:2383 |
onTouchStart? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchStart | node_modules/@types/react/index.d.ts:2384 |
onTouchStartCapture? | TouchEventHandler<HTMLDivElement> | - | Omit.onTouchStartCapture | node_modules/@types/react/index.d.ts:2385 |
onPointerDown? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerDown | node_modules/@types/react/index.d.ts:2388 |
onPointerDownCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerDownCapture | node_modules/@types/react/index.d.ts:2389 |
onPointerMove? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerMove | node_modules/@types/react/index.d.ts:2390 |
onPointerMoveCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerMoveCapture | node_modules/@types/react/index.d.ts:2391 |
onPointerUp? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerUp | node_modules/@types/react/index.d.ts:2392 |
onPointerUpCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerUpCapture | node_modules/@types/react/index.d.ts:2393 |
onPointerCancel? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerCancel | node_modules/@types/react/index.d.ts:2394 |
onPointerCancelCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerCancelCapture | node_modules/@types/react/index.d.ts:2395 |
onPointerEnter? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerEnter | node_modules/@types/react/index.d.ts:2396 |
onPointerLeave? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerLeave | node_modules/@types/react/index.d.ts:2397 |
onPointerOver? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerOver | node_modules/@types/react/index.d.ts:2398 |
onPointerOverCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerOverCapture | node_modules/@types/react/index.d.ts:2399 |
onPointerOut? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerOut | node_modules/@types/react/index.d.ts:2400 |
onPointerOutCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onPointerOutCapture | node_modules/@types/react/index.d.ts:2401 |
onGotPointerCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onGotPointerCapture | node_modules/@types/react/index.d.ts:2402 |
onGotPointerCaptureCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onGotPointerCaptureCapture | node_modules/@types/react/index.d.ts:2403 |
onLostPointerCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onLostPointerCapture | node_modules/@types/react/index.d.ts:2404 |
onLostPointerCaptureCapture? | PointerEventHandler<HTMLDivElement> | - | Omit.onLostPointerCaptureCapture | node_modules/@types/react/index.d.ts:2405 |
onScroll? | UIEventHandler<HTMLDivElement> | - | Omit.onScroll | node_modules/@types/react/index.d.ts:2408 |
onScrollCapture? | UIEventHandler<HTMLDivElement> | - | Omit.onScrollCapture | node_modules/@types/react/index.d.ts:2409 |
onScrollEnd? | UIEventHandler<HTMLDivElement> | - | Omit.onScrollEnd | node_modules/@types/react/index.d.ts:2410 |
onScrollEndCapture? | UIEventHandler<HTMLDivElement> | - | Omit.onScrollEndCapture | node_modules/@types/react/index.d.ts:2411 |
onWheel? | WheelEventHandler<HTMLDivElement> | - | Omit.onWheel | node_modules/@types/react/index.d.ts:2414 |
onWheelCapture? | WheelEventHandler<HTMLDivElement> | - | Omit.onWheelCapture | node_modules/@types/react/index.d.ts:2415 |
onAnimationStart? | AnimationEventHandler<HTMLDivElement> | - | Omit.onAnimationStart | node_modules/@types/react/index.d.ts:2418 |
onAnimationStartCapture? | AnimationEventHandler<HTMLDivElement> | - | Omit.onAnimationStartCapture | node_modules/@types/react/index.d.ts:2419 |
onAnimationEnd? | AnimationEventHandler<HTMLDivElement> | - | Omit.onAnimationEnd | node_modules/@types/react/index.d.ts:2420 |
onAnimationEndCapture? | AnimationEventHandler<HTMLDivElement> | - | Omit.onAnimationEndCapture | node_modules/@types/react/index.d.ts:2421 |
onAnimationIteration? | AnimationEventHandler<HTMLDivElement> | - | Omit.onAnimationIteration | node_modules/@types/react/index.d.ts:2422 |
onAnimationIterationCapture? | AnimationEventHandler<HTMLDivElement> | - | Omit.onAnimationIterationCapture | node_modules/@types/react/index.d.ts:2423 |
onToggle? | ToggleEventHandler<HTMLDivElement> | - | Omit.onToggle | node_modules/@types/react/index.d.ts:2426 |
onBeforeToggle? | ToggleEventHandler<HTMLDivElement> | - | Omit.onBeforeToggle | node_modules/@types/react/index.d.ts:2427 |
onTransitionCancel? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionCancel | node_modules/@types/react/index.d.ts:2430 |
onTransitionCancelCapture? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionCancelCapture | node_modules/@types/react/index.d.ts:2431 |
onTransitionEnd? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionEnd | node_modules/@types/react/index.d.ts:2432 |
onTransitionEndCapture? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionEndCapture | node_modules/@types/react/index.d.ts:2433 |
onTransitionRun? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionRun | node_modules/@types/react/index.d.ts:2434 |
onTransitionRunCapture? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionRunCapture | node_modules/@types/react/index.d.ts:2435 |
onTransitionStart? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionStart | node_modules/@types/react/index.d.ts:2436 |
onTransitionStartCapture? | TransitionEventHandler<HTMLDivElement> | - | Omit.onTransitionStartCapture | node_modules/@types/react/index.d.ts:2437 |
aria-activedescendant? | string | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | ButtonProps.aria-activedescendant | node_modules/@types/react/index.d.ts:2454 |
aria-atomic? | Booleanish | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | ButtonProps.aria-atomic | node_modules/@types/react/index.d.ts:2456 |
aria-autocomplete? | "none" | "list" | "inline" | "both" | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | ButtonProps.aria-autocomplete | node_modules/@types/react/index.d.ts:2461 |
aria-braillelabel? | string | Defines a string value that labels the current element, which is intended to be converted into Braille. See aria-label. | ButtonProps.aria-braillelabel | node_modules/@types/react/index.d.ts:2467 |
aria-brailleroledescription? | string | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. See aria-roledescription. | ButtonProps.aria-brailleroledescription | node_modules/@types/react/index.d.ts:2472 |
aria-busy? | Booleanish | - | ButtonProps.aria-busy | node_modules/@types/react/index.d.ts:2473 |
aria-checked? | boolean | "true" | "false" | "mixed" | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See - aria-pressed - aria-selected. | ButtonProps.aria-checked | node_modules/@types/react/index.d.ts:2478 |
aria-colcount? | number | Defines the total number of columns in a table, grid, or treegrid. See aria-colindex. | ButtonProps.aria-colcount | node_modules/@types/react/index.d.ts:2483 |
aria-colindex? | number | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. See - aria-colcount - aria-colspan. | ButtonProps.aria-colindex | node_modules/@types/react/index.d.ts:2488 |
aria-colindextext? | string | Defines a human readable text alternative of aria-colindex. See aria-rowindextext. | ButtonProps.aria-colindextext | node_modules/@types/react/index.d.ts:2493 |
aria-colspan? | number | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. See - aria-colindex - aria-rowspan. | ButtonProps.aria-colspan | node_modules/@types/react/index.d.ts:2498 |
aria-controls? | string | Identifies the element (or elements) whose contents or presence are controlled by the current element. See aria-owns. | ButtonProps.aria-controls | node_modules/@types/react/index.d.ts:2503 |
aria-current? | boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date" | Indicates the element that represents the current item within a container or set of related elements. | ButtonProps.aria-current | node_modules/@types/react/index.d.ts:2505 |
aria-describedby? | string | Identifies the element (or elements) that describes the object. See aria-labelledby | ButtonProps.aria-describedby | node_modules/@types/react/index.d.ts:2510 |
aria-description? | string | Defines a string value that describes or annotates the current element. See related aria-describedby. | ButtonProps.aria-description | node_modules/@types/react/index.d.ts:2515 |
aria-details? | string | Identifies the element that provides a detailed, extended description for the object. See aria-describedby. | ButtonProps.aria-details | node_modules/@types/react/index.d.ts:2520 |
aria-disabled? | Booleanish | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See - aria-hidden - aria-readonly. | ButtonProps.aria-disabled | node_modules/@types/react/index.d.ts:2525 |
aria-dropeffect? | "link" | "none" | "copy" | "execute" | "move" | "popup" | Indicates what functions can be performed when a dragged object is released on the drop target. Deprecated in ARIA 1.1 | ButtonProps.aria-dropeffect | node_modules/@types/react/index.d.ts:2530 |
aria-errormessage? | string | Identifies the element that provides an error message for the object. See - aria-invalid - aria-describedby. | ButtonProps.aria-errormessage | node_modules/@types/react/index.d.ts:2535 |
aria-expanded? | Booleanish | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | ButtonProps.aria-expanded | node_modules/@types/react/index.d.ts:2537 |
aria-flowto? | string | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | ButtonProps.aria-flowto | node_modules/@types/react/index.d.ts:2542 |
aria-grabbed? | Booleanish | Indicates an element's "grabbed" state in a drag-and-drop operation. Deprecated in ARIA 1.1 | ButtonProps.aria-grabbed | node_modules/@types/react/index.d.ts:2547 |
aria-haspopup? | | boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree" | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ButtonProps.aria-haspopup | node_modules/@types/react/index.d.ts:2549 |
aria-hidden? | Booleanish | Indicates whether the element is exposed to an accessibility API. See aria-disabled. | ButtonProps.aria-hidden | node_modules/@types/react/index.d.ts:2554 |
aria-invalid? | boolean | "true" | "false" | "grammar" | "spelling" | Indicates the entered value does not conform to the format expected by the application. See aria-errormessage. | ButtonProps.aria-invalid | node_modules/@types/react/index.d.ts:2559 |
aria-keyshortcuts? | string | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | ButtonProps.aria-keyshortcuts | node_modules/@types/react/index.d.ts:2561 |
aria-label? | string | Defines a string value that labels the current element. See aria-labelledby. | ButtonProps.aria-label | node_modules/@types/react/index.d.ts:2566 |
aria-labelledby? | string | Identifies the element (or elements) that labels the current element. See aria-describedby. | ButtonProps.aria-labelledby | node_modules/@types/react/index.d.ts:2571 |
aria-level? | number | Defines the hierarchical level of an element within a structure. | ButtonProps.aria-level | node_modules/@types/react/index.d.ts:2573 |
aria-live? | "off" | "polite" | "assertive" | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | ButtonProps.aria-live | node_modules/@types/react/index.d.ts:2575 |
aria-modal? | Booleanish | Indicates whether an element is modal when displayed. | ButtonProps.aria-modal | node_modules/@types/react/index.d.ts:2577 |
aria-multiline? | Booleanish | Indicates whether a text box accepts multiple lines of input or only a single line. | ButtonProps.aria-multiline | node_modules/@types/react/index.d.ts:2579 |
aria-multiselectable? | Booleanish | Indicates that the user may select more than one item from the current selectable descendants. | ButtonProps.aria-multiselectable | node_modules/@types/react/index.d.ts:2581 |
aria-orientation? | "horizontal" | "vertical" | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | ButtonProps.aria-orientation | node_modules/@types/react/index.d.ts:2583 |
aria-owns? | string | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. See aria-controls. | ButtonProps.aria-owns | node_modules/@types/react/index.d.ts:2589 |
aria-placeholder? | string | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | ButtonProps.aria-placeholder | node_modules/@types/react/index.d.ts:2594 |
aria-posinset? | number | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See aria-setsize. | ButtonProps.aria-posinset | node_modules/@types/react/index.d.ts:2599 |
aria-pressed? | boolean | "true" | "false" | "mixed" | Indicates the current "pressed" state of toggle buttons. See - aria-checked - aria-selected. | ButtonProps.aria-pressed | node_modules/@types/react/index.d.ts:2604 |
aria-readonly? | Booleanish | Indicates that the element is not editable, but is otherwise operable. See aria-disabled. | ButtonProps.aria-readonly | node_modules/@types/react/index.d.ts:2609 |
aria-relevant? | | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See aria-atomic. | ButtonProps.aria-relevant | node_modules/@types/react/index.d.ts:2614 |
aria-required? | Booleanish | Indicates that user input is required on the element before a form may be submitted. | ButtonProps.aria-required | node_modules/@types/react/index.d.ts:2627 |
aria-roledescription? | string | Defines a human-readable, author-localized description for the role of an element. | ButtonProps.aria-roledescription | node_modules/@types/react/index.d.ts:2629 |
aria-rowcount? | number | Defines the total number of rows in a table, grid, or treegrid. See aria-rowindex. | ButtonProps.aria-rowcount | node_modules/@types/react/index.d.ts:2634 |
aria-rowindex? | number | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. See - aria-rowcount - aria-rowspan. | ButtonProps.aria-rowindex | node_modules/@types/react/index.d.ts:2639 |
aria-rowindextext? | string | Defines a human readable text alternative of aria-rowindex. See aria-colindextext. | ButtonProps.aria-rowindextext | node_modules/@types/react/index.d.ts:2644 |
aria-rowspan? | number | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. See - aria-rowindex - aria-colspan. | ButtonProps.aria-rowspan | node_modules/@types/react/index.d.ts:2649 |
aria-selected? | Booleanish | Indicates the current "selected" state of various widgets. See - aria-checked - aria-pressed. | ButtonProps.aria-selected | node_modules/@types/react/index.d.ts:2654 |
aria-setsize? | number | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See aria-posinset. | ButtonProps.aria-setsize | node_modules/@types/react/index.d.ts:2659 |
aria-sort? | "none" | "ascending" | "descending" | "other" | Indicates if items in a table or grid are sorted in ascending or descending order. | ButtonProps.aria-sort | node_modules/@types/react/index.d.ts:2661 |
aria-valuemax? | number | Defines the maximum allowed value for a range widget. | ButtonProps.aria-valuemax | node_modules/@types/react/index.d.ts:2663 |
aria-valuemin? | number | Defines the minimum allowed value for a range widget. | ButtonProps.aria-valuemin | node_modules/@types/react/index.d.ts:2665 |
aria-valuenow? | number | Defines the current value for a range widget. See aria-valuetext. | ButtonProps.aria-valuenow | node_modules/@types/react/index.d.ts:2670 |
aria-valuetext? | string | Defines the human readable text alternative of aria-valuenow for a range widget. | ButtonProps.aria-valuetext | node_modules/@types/react/index.d.ts:2672 |
defaultChecked? | boolean | - | ButtonProps.defaultChecked | node_modules/@types/react/index.d.ts:2750 |
defaultValue? | string | number | readonly string[] | - | ButtonProps.defaultValue | node_modules/@types/react/index.d.ts:2751 |
suppressContentEditableWarning? | boolean | - | ButtonProps.suppressContentEditableWarning | node_modules/@types/react/index.d.ts:2752 |
suppressHydrationWarning? | boolean | - | ButtonProps.suppressHydrationWarning | node_modules/@types/react/index.d.ts:2753 |
accessKey? | string | - | ButtonProps.accessKey | node_modules/@types/react/index.d.ts:2756 |
autoCapitalize? | | "off" | "none" | "on" | "sentences" | "words" | "characters" | string & object | - | ButtonProps.autoCapitalize | node_modules/@types/react/index.d.ts:2757 |
autoFocus? | boolean | - | ButtonProps.autoFocus | node_modules/@types/react/index.d.ts:2758 |
className? | string | - | ButtonProps.className | node_modules/@types/react/index.d.ts:2759 |
contentEditable? | Booleanish | "inherit" | "plaintext-only" | - | ButtonProps.contentEditable | node_modules/@types/react/index.d.ts:2760 |
contextMenu? | string | - | ButtonProps.contextMenu | node_modules/@types/react/index.d.ts:2761 |
dir? | string | - | ButtonProps.dir | node_modules/@types/react/index.d.ts:2762 |
draggable? | Booleanish | - | ButtonProps.draggable | node_modules/@types/react/index.d.ts:2763 |
enterKeyHint? | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | - | ButtonProps.enterKeyHint | node_modules/@types/react/index.d.ts:2764 |
hidden? | boolean | - | ButtonProps.hidden | node_modules/@types/react/index.d.ts:2765 |
id? | string | - | ButtonProps.id | node_modules/@types/react/index.d.ts:2766 |
lang? | string | - | ButtonProps.lang | node_modules/@types/react/index.d.ts:2767 |
nonce? | string | - | ButtonProps.nonce | node_modules/@types/react/index.d.ts:2768 |
slot? | string | - | ButtonProps.slot | node_modules/@types/react/index.d.ts:2769 |
spellCheck? | Booleanish | - | ButtonProps.spellCheck | node_modules/@types/react/index.d.ts:2770 |
style? | CSSProperties | - | ButtonProps.style | node_modules/@types/react/index.d.ts:2771 |
tabIndex? | number | - | ButtonProps.tabIndex | node_modules/@types/react/index.d.ts:2772 |
title? | string | - | ButtonProps.title | node_modules/@types/react/index.d.ts:2773 |
translate? | "yes" | "no" | - | ButtonProps.translate | node_modules/@types/react/index.d.ts:2774 |
radioGroup? | string | - | ButtonProps.radioGroup | node_modules/@types/react/index.d.ts:2777 |
role? | AriaRole | - | ButtonProps.role | node_modules/@types/react/index.d.ts:2780 |
about? | string | - | ButtonProps.about | node_modules/@types/react/index.d.ts:2783 |
content? | string | - | ButtonProps.content | node_modules/@types/react/index.d.ts:2784 |
datatype? | string | - | ButtonProps.datatype | node_modules/@types/react/index.d.ts:2785 |
inlist? | any | - | ButtonProps.inlist | node_modules/@types/react/index.d.ts:2786 |
property? | string | - | ButtonProps.property | node_modules/@types/react/index.d.ts:2788 |
rel? | string | - | ButtonProps.rel | node_modules/@types/react/index.d.ts:2789 |
resource? | string | - | ButtonProps.resource | node_modules/@types/react/index.d.ts:2790 |
rev? | string | - | ButtonProps.rev | node_modules/@types/react/index.d.ts:2791 |
typeof? | string | - | ButtonProps.typeof | node_modules/@types/react/index.d.ts:2792 |
vocab? | string | - | ButtonProps.vocab | node_modules/@types/react/index.d.ts:2793 |
autoCorrect? | string | - | ButtonProps.autoCorrect | node_modules/@types/react/index.d.ts:2796 |
autoSave? | string | - | ButtonProps.autoSave | node_modules/@types/react/index.d.ts:2797 |
color? | string | - | ButtonProps.color | node_modules/@types/react/index.d.ts:2798 |
itemProp? | string | - | ButtonProps.itemProp | node_modules/@types/react/index.d.ts:2799 |
itemScope? | boolean | - | ButtonProps.itemScope | node_modules/@types/react/index.d.ts:2800 |
itemType? | string | - | ButtonProps.itemType | node_modules/@types/react/index.d.ts:2801 |
itemID? | string | - | ButtonProps.itemID | node_modules/@types/react/index.d.ts:2802 |
itemRef? | string | - | ButtonProps.itemRef | node_modules/@types/react/index.d.ts:2803 |
results? | number | - | ButtonProps.results | node_modules/@types/react/index.d.ts:2804 |
security? | string | - | ButtonProps.security | node_modules/@types/react/index.d.ts:2805 |
unselectable? | "off" | "on" | - | ButtonProps.unselectable | node_modules/@types/react/index.d.ts:2806 |
popover? | "" | "auto" | "manual" | "hint" | - | ButtonProps.popover | node_modules/@types/react/index.d.ts:2809 |
popoverTargetAction? | "toggle" | "show" | "hide" | - | ButtonProps.popoverTargetAction | node_modules/@types/react/index.d.ts:2810 |
popoverTarget? | string | - | ButtonProps.popoverTarget | node_modules/@types/react/index.d.ts:2811 |
inert? | boolean | See https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert | ButtonProps.inert | node_modules/@types/react/index.d.ts:2817 |
inputMode? | | "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal" | Hints at the type of data that might be entered by the user while editing the element or its contents See https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute | ButtonProps.inputMode | node_modules/@types/react/index.d.ts:2822 |
is? | string | Specify that a standard HTML element should behave like a defined custom built-in element See https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is | ButtonProps.is | node_modules/@types/react/index.d.ts:2827 |
exportparts? | string | See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts | ButtonProps.exportparts | node_modules/@types/react/index.d.ts:2831 |
part? | string | See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part | ButtonProps.part | node_modules/@types/react/index.d.ts:2835 |
FieldProps
type FieldProps<TFieldValues, TName> = Omit<ControllerProps<TFieldValues, TName>, "render"> & object;
Defined in: src/forms/Field/Field.tsx:24
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
render() | ({ field, fieldState, formState, }) => ReactElement | Render function that receives field state and props and renders form input element. | src/forms/Field/Field.tsx:31 |
label? | ReactNode | Label text for the field | src/forms/Field/Field.tsx:47 |
className? | string | - | src/forms/Field/Field.tsx:48 |
checkEmptyError? | boolean | Whether to check for empty errors. For more details, refer to the ErrorProps#checkEmpty|checkEmpty property of the Error component. | src/forms/Field/Field.tsx:53 |
error? | ErrorOption | Custom error message | src/forms/Field/Field.tsx:57 |
tooltip? | ReactNode | Tooltip content on top of the field, helpful for explaining details. | src/forms/Field/Field.tsx:61 |
Type Parameters
| Type Parameter | Default type |
|---|---|
TFieldValues extends FieldValues | FieldValues |
TName extends FieldPath<TFieldValues> | FieldPath<TFieldValues> |
FORM_ERROR_KEY
const FORM_ERROR_KEY: "FORM_ERROR" = "FORM_ERROR";
Defined in: src/forms/useForm/useForm.ts:30
Special key used for form-level errors.
Field()
function Field<TFieldValues, TName>(__namedParameters): Element;
Defined in: src/forms/Field/Field.tsx:88
A form field component that integrates with React Hook Form. Provides consistent field rendering with label, error handling, and accessibility features.
Features:
- Automatic error handling
- Label integration
- Tooltip support
- Accessibility attributes
- Empty state checking
Type Parameters
| Type Parameter | Default type |
|---|---|
TFieldValues extends FieldValues | FieldValues |
TName extends string | FieldPath<TFieldValues> |
Parameters
| Parameter | Type |
|---|---|
__namedParameters | FieldProps<TFieldValues, TName> |
Returns
Element
Example
const form = useForm({ formSchema });
<Field
control={form.control}
name="email"
label="Email"
render={({ field }) => (
<Input {...field} type="email" />
)}
/>
FormError()
function FormError(__namedParameters): Element | null;
Defined in: src/forms/FormError/FormError.tsx:28
Exposes form error if it exists.
Use it for exposing form-wide errors, like server errors.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | FormErrorProps |
Returns
Element | null
useForm()
function useForm<Schema, Context>(__namedParameters): object;
Defined in: src/forms/useForm/useForm.ts:66
Enhanced version of react-hook-form's useForm. Provides Zod schema validation and additional utilities for form handling.
Features:
- Zod schema validation
- Form-level error handling
- Async submission handling
- Submit button state management
Type Parameters
| Type Parameter |
|---|
Schema extends ZodType<FieldValues, FieldValues, $ZodTypeInternals<FieldValues, FieldValues>> |
Context |
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Partial<{ mode: "onBlur" | "onChange" | "onSubmit" | "all" | "onTouched"; disabled: boolean; reValidateMode: "onBlur" | "onChange" | "onSubmit"; defaultValues: | AsyncDefaultValues<input<Schema>> | DefaultValues<input<Schema>>; values: input; errors: FieldErrors<input<Schema>>; resetOptions: | Partial<{ keepDirtyValues: boolean; keepErrors: boolean; keepDirty: boolean; keepValues: boolean; keepDefaultValues: boolean; keepIsSubmitted: boolean; keepIsSubmitSuccessful: boolean; keepTouched: boolean; keepIsValidating: boolean; keepIsValid: boolean; keepSubmitCount: boolean; keepFieldsRef: boolean; }> | undefined; resolver: Resolver<input<Schema>, Context, output<Schema>>; context: Context; shouldFocusError: boolean; shouldUnregister: boolean; shouldUseNativeValidation: boolean; progressive: boolean; criteriaMode: CriteriaMode; delayError: number; formControl?: Omit<UseFormReturn<input<Schema>, Context, output<Schema>>, "formState">; }> & object |
Returns
| Name | Type | Description | Defined in |
|---|---|---|---|
submitAsync() | () => Promise<output<Schema>> | Function to get form's data, but only if it actually passes validation. Useful when needed to combine multiple useForms into one. Prevents callback hell and wrong execution flow if one of forms is not valid. | src/forms/useForm/useForm.ts:145 |
formError | ErrorOption | undefined | - | src/forms/useForm/useForm.ts:146 |
setFormError() | (error, options?) => void | Utility that helps to handle form errors. Respects form state, resets on submitting. Handles both known string errors and unknown error objects. | src/forms/useForm/useForm.ts:147 |
isSubmitDisabled | boolean | - | src/forms/useForm/useForm.ts:148 |
handleSubmit | UseFormHandleSubmit<input<Schema>, output<Schema>> | Wraps react-hook-form's handleSubmit to automatically set form errors for caught exceptions. This adds error handling without requiring try/catch blocks in form handlers. | src/forms/useForm/useForm.ts:149 |
watch | UseFormWatch<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:672 |
getValues | UseFormGetValues<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:673 |
getFieldState | UseFormGetFieldState<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:674 |
setError | UseFormSetError<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:675 |
clearErrors | UseFormClearErrors<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:676 |
setValue | UseFormSetValue<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:677 |
trigger | UseFormTrigger<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:678 |
formState | FormState<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:679 |
resetField | UseFormResetField<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:680 |
reset | UseFormReset<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:681 |
unregister | UseFormUnregister<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:683 |
control | Control<input<Schema>, Context, output<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:684 |
register | UseFormRegister<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:685 |
setFocus | UseFormSetFocus<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:686 |
subscribe | UseFormSubscribe<input<Schema>> | - | node_modules/react-hook-form/dist/types/form.d.ts:687 |
Example
const form = useForm({
formSchema: z.object({
email: z.email(),
password: z.string().min(8)
})
});