4.7.0 • Published 1 year ago

envoc-form

Licence

MIT

Version

4.7.0

Deps

Size

618 kB

Vulns

Weekly

Summary Dependency Versions

envoc-form / Exports

envoc-form

Base form package for envoc projects.

Important naming conventions for our sanity while creating envoc-form types:

TForm = The type of the some form. e.g. LoginDto
TProp = The key / symbol of a individual property of some form. e.g. TProp would be literally "Username" for the prop of the same name for a LoginDto
TValue = The value of an individual property of some form. e.g. a "Username" property would probably have a TValue of string
Field = the abstract thing that deals with some specific TProp. Might represent several composed elements (e.g. label, input, helperText, etc) or may just be a direct component
TRenderComponent = The type of any 'Component' passed to a Field, e.g. 'StandardTextInputGroup' passed to Component means TRenderComponent is typeof(StandardTextInputGroup)
TComponentProps = For any 'Component' passed to a Field as a prop, this represents that Component's props

Interfaces

envoc-form / Exports / AddressInputProps

Interface: AddressInputProps

Properties

fieldBuilder

• fieldBuilder: Pick<FormBuilderProp<AddressDto>, "Field">

Defined in

packages/envoc-form/src/AddressInput/AddressInput.tsx:14

Defined in

packages/envoc-form/src/AddressInput/AddressInput.tsx:15

envoc-form / Exports / BooleanSelectGroupProps

Interface: BooleanSelectGroupProps

Hierarchy

Omit<SelectGroupPropsHelper<boolean | undefined | null>, "options">

↳ BooleanSelectGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | boolean>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | boolean>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

options

• Optional options: SelectOption<boolean>[]

Defined in

packages/envoc-form/src/Select/BooleanSelectGroup.tsx:17

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:38

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / ConfirmBaseFormProps

Interface: ConfirmBaseFormProps

Properties

children
confirmButtonClass
confirmButtonText
handleCancel
request
style
title

Properties

children

• Optional children: ReactNode

Any components to be rendered in between the title and the buttons.

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:23

confirmButtonClass

• Optional confirmButtonClass: string

CSS class for the buttons.

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:21

confirmButtonText

• Optional confirmButtonText: string

Custom confirm button text.

defaultvalue Confirm

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:19

handleCancel

• Optional handleCancel: MouseEventHandler<HTMLButtonElement>

Function to run when cancel button is clicked.

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:10

request

• request: default

Axios request upon confirmation

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:12

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:13

title

• Optional title: string

<h3/> title text on top of the form.

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:15

envoc-form / Exports / ConfirmDeleteFormProps

Interface: ConfirmDeleteFormProps

Hierarchy

Pick<ConfirmBaseFormProps, "style">

↳ ConfirmDeleteFormProps

Properties

children
form
handleComplete
handleError
style
successUrl
title

Properties

children

• Optional children: ReactNode

Any components to be rendered in between the title and the buttons.

Defined in

packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:25

form

• form: string

Form name (key) to apply the confirmation on.

Defined in

packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:15

handleComplete

• Optional handleComplete: Function

Custom function when the axios request succeeds.

Defined in

packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:21

handleError

• Optional handleError: Function

Custom function when the axios request fails.

Defined in

packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:23

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:13

successUrl

• Optional successUrl: string

Url to navigate to on success.

Defined in

packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:13

title

• Optional title: string

Custom message to display.

defaultvalue Are you sure you want to delete this?

Defined in

packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:19

envoc-form / Exports / DatePickerGroupProps

Interface: DatePickerGroupProps<T>

Type parameters

Name
`T`

Hierarchy

InjectedFieldProps<T | undefined | null>
Omit<DatePickerProps, keyof InjectedFieldProps<T> | "name" | "value" | "className">
Omit<GroupProps, keyof InjectedFieldProps<T> | "children">

↳ DatePickerGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

Methods

Parameters

Name	Type
`arg`	`Date`

Defined in

packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:18

envoc-form / Exports / DatePickerHelper

Interface: DatePickerHelper<T>

Type parameters

Name
`T`

Hierarchy

Omit<DatePickerGroupProps<T>, "convert">

↳ DatePickerHelper

↳↳ StringDatePickerGroupProps

↳↳ StringDateOnlyPickerGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

envoc-form / Exports / DateTimePickerGroupProps

Interface: DateTimePickerGroupProps<T>

Type parameters

Name
`T`

Hierarchy

InjectedFieldProps<T | undefined | null>
Omit<DateTimePickerProps, keyof InjectedFieldProps<T> | "name" | "value" | "className">
Omit<GroupProps, keyof InjectedFieldProps<T> | "children">

↳ DateTimePickerGroupProps

Methods

convert
onAbort
onAnimationEnd
onAnimationIteration
onAnimationStart
onBlur
onCanPlay
onCanPlayThrough
onClick
onCompositionEnd
onCompositionStart
onCompositionUpdate
onContextMenu
onCopy
onCut
onDoubleClick
onDrag
onDragEnd
onDragEnter
onDragExit
onDragLeave
onDragOver
onDragStart
onDrop
onDurationChange
onEmptied
onEncrypted
onEnded
onError
onGotPointerCapture
onInput
onInvalid
onKeyDown
onKeyPress
onKeyUp
onLoad
onLoadStart
onLoadedData
onLoadedMetadata
onLostPointerCapture
onMouseDown
onMouseEnter
onMouseLeave
onMouseMove
onMouseOut
onMouseOver
onMouseUp
onPaste
onPause
onPlay
onPlaying
onPointerCancel
onPointerDown
onPointerEnter
onPointerLeave
onPointerMove
onPointerOut
onPointerOver
onPointerUp
onProgress
onRateChange
onReset
onScroll
onSeeked
onSeeking
onSelect
onStalled
onSubmit
onSuspend
onTimeUpdate
onToggle
onTouchCancel
onTouchEnd
onTouchMove
onTouchStart
onTransitionEnd
onVolumeChange
onWaiting
onWheel

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

Methods

Parameters

Name	Type
`date`	`Date`

Defined in

packages/envoc-form/src/DateTimePicker/DateTimePickerGroup.tsx:23

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onAnimationIteration

▸ onAnimationIteration(event): void

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCompositionStart

▸ onCompositionStart(event): void

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCompositionUpdate

▸ onCompositionUpdate(event): void

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onGotPointerCapture

▸ onGotPointerCapture(event): void

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onLostPointerCapture

▸ onLostPointerCapture(event): void

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

envoc-form / Exports / FileGroupProps

Interface: FileGroupProps

Hierarchy

InjectedFieldProps<any | undefined | null>
Omit<GroupProps, keyof InjectedFieldProps<any> | "children">
Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | "children" | "className" | "label">

↳ FileGroupProps

Properties

className
disabled
helpText
input
label
meta
multiple
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<any>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<any>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

multiple

• Optional multiple: boolean

Allow multiple files to be uploaded.

Defined in

packages/envoc-form/src/File/FileGroup.tsx:17

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / FormActionsProps

Interface: FormActionsProps

Properties

allowPristineSubmit

• Optional allowPristineSubmit: boolean

Allow the form to be submitted without any changes. By default this is not allowed.

Defined in

packages/envoc-form/src/FormActions.tsx:7

disabled

• Optional disabled: boolean

Whether both buttons should be disabled.

Defined in

packages/envoc-form/src/FormActions.tsx:13

Methods

handleCancel

▸ Optional handleCancel(): void

The cancel button's onClick.

defaultvalue window.history.back()

Defined in

packages/envoc-form/src/FormActions.tsx:11

envoc-form / Exports / GroupProps

Interface: GroupProps

Hierarchy

InjectedFieldProps<any>

↳ GroupProps

Properties

children
className
disabled
helpText
input
label
meta
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<any>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<any>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / IconInputGroupProps

Interface: IconInputGroupProps

Hierarchy

Omit<InputGroupProps<string | undefined | null>, "onChange" | "type" | "value">

↳ IconInputGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: string

Text to display after the input group to give more information to the user.

Defined in

packages/envoc-form/src/Input/IconInputGroup.tsx:17

icon

• icon: ReactNode

Icon to display on the input group.

Defined in

packages/envoc-form/src/Input/IconInputGroup.tsx:15

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

type

Defined in

packages/envoc-form/src/Input/IconInputGroup.tsx:13

envoc-form / Exports / InjectedFieldProps

Interface: InjectedFieldProps<TValue>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Name
`TValue`

Hierarchy

InjectedFieldProps

↳ DatePickerGroupProps

↳ DateTimePickerGroupProps

↳ FileGroupProps

↳ GroupProps

↳ InputGroupProps

↳ SelectGroupProps

↳ TextAreaGroupProps

Properties

input

• input: CustomFieldInputProps<TValue>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

meta

• meta: CustomFieldMetaProps<TValue>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

envoc-form / Exports / InputGroupProps

Interface: InputGroupProps<TValue>

Type parameters

Name
`TValue`

Hierarchy

InjectedFieldProps<TValue>
Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | "children" | "className" | "label" | "value">
Omit<GroupProps, keyof InjectedFieldProps<any> | "children">

↳ InputGroupProps

Properties

className
helpText
icon
input
label
meta
onChange
value

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:20

input

• input: CustomFieldInputProps<TValue>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<TValue>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

onChange

• onChange: ChangeEventHandler<HTMLInputElement>

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:18

value

• value: undefined | null | string | number

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:19

envoc-form / Exports / MoneyInputGroupProps

Interface: MoneyInputGroupProps

Hierarchy

Omit<InputGroupProps<number | undefined | null>, "onChange" | "type" | "value">

↳ MoneyInputGroupProps

Properties

className
helpText
icon
input
label
meta
parseFunc

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:20

input

• input: CustomFieldInputProps<undefined | null | number>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | number>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

parseFunc

• Optional parseFunc: (string: string, radix?: number) => number | (string: string) => number

Custom parsing function when the value changes.

Defined in

packages/envoc-form/src/Input/MoneyInputGroup.tsx:12

envoc-form / Exports / MultiNumberSelectGroupProps

Interface: MultiNumberSelectGroupProps

Hierarchy

SelectGroupPropsHelper<number[] | undefined | null>

↳ MultiNumberSelectGroupProps

Properties

className
disabled
helpText
input
label
meta
options
placeholder
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | number[]>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | number[]>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

options

Options for the dropdown. Includes the label and value.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:34

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:38

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / MultiStringSelectGroupProps

Interface: MultiStringSelectGroupProps

Hierarchy

SelectGroupPropsHelper<string[]>

↳ MultiStringSelectGroupProps

Properties

className
disabled
helpText
input
label
meta
options
placeholder
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | string[]>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string[]>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

options

• options: SelectOption<string[]>[] | OptionsUseServiceResult<string[]>

Options for the dropdown. Includes the label and value.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:34

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:38

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / NormalizationFunction

Interface: NormalizationFunction<TValue>

Type parameters

Name
`TValue`

Callable

NormalizationFunction

▸ NormalizationFunction(value): TValue

Normalization of values

Parameters

Name	Type
`value`	`TValue`

Defined in

packages/envoc-form/src/Normalization/NormalizationFunction.ts:3

envoc-form / Exports / NumberInputGroupProps

Interface: NumberInputGroupProps

Hierarchy

Omit<InputGroupProps<number | undefined | null>, "onChange" | "type" | "value">

↳ NumberInputGroupProps

Properties

className
helpText
icon
input
label
meta
parseFunc

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:20

input

• input: CustomFieldInputProps<undefined | null | number>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | number>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

parseFunc

• Optional parseFunc: (string: string, radix?: number) => number | (string: string) => number

Custom parsing function when the value changes.

Defined in

packages/envoc-form/src/Input/NumberInputGroup.tsx:12

envoc-form / Exports / ObjectToFormDataCfgProps

Interface: ObjectToFormDataCfgProps

Properties

allowEmptyArrays
booleansAsIntegers
dotNotation
indices
noFileListBrackets
nullsAsUndefineds

Properties

Defined in

packages/envoc-form/src/utils/objectToFormData.ts:18

booleansAsIntegers

• Optional booleansAsIntegers: boolean

Defined in

packages/envoc-form/src/utils/objectToFormData.ts:21

Defined in

packages/envoc-form/src/utils/objectToFormData.ts:17

Defined in

packages/envoc-form/src/utils/objectToFormData.ts:16

Defined in

packages/envoc-form/src/utils/objectToFormData.ts:19

nullsAsUndefineds

• Optional nullsAsUndefineds: boolean

Defined in

packages/envoc-form/src/utils/objectToFormData.ts:20

envoc-form / Exports / PhoneNumberInputGroupProps

Interface: PhoneNumberInputGroupProps

Hierarchy

Omit<InputGroupProps<string | undefined | null>, "onChange" | "type" | "value">

↳ PhoneNumberInputGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:20

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

envoc-form / Exports / SelectGroupProps

Interface: SelectGroupProps<TValue>

Type parameters

Name
`TValue`

Hierarchy

InjectedFieldProps<TValue | undefined | null>
Omit<GroupProps, "input" | "meta" | "children">

↳ SelectGroupProps

Properties

className
disabled
helpText
input
label
meta
multiple
options
placeholder
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | TValue>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | TValue>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

multiple

• multiple: TValue extends any[] ? true : false

Whether the user should be able to have multiple values selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:36

options

• options: SelectOption<TValue>[] | OptionsUseServiceResult<TValue>

Options for the dropdown. Includes the label and value.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:34

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:38

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / SelectGroupPropsHelper

Interface: SelectGroupPropsHelper<T>

Type parameters

Name
`T`

Hierarchy

Omit<SelectGroupProps<T>, "multiple">

↳ SelectGroupPropsHelper

↳↳ MultiNumberSelectGroupProps

↳↳ SingleNumberSelectGroupProps

↳↳ MultiStringSelectGroupProps

↳↳ SingleStringSelectGroupProps

Properties

className
disabled
helpText
input
label
meta
options
placeholder
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | T>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

options

• options: SelectOption<T>[] | OptionsUseServiceResult<T>

Options for the dropdown. Includes the label and value.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:34

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:38

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / SelectOption

Interface: SelectOption<TValue>

Properties

label

• label: string

Label for the select. This is displayed to the user.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:11

value

• value: undefined | TValue extends P[] ? P : TValue

Value for the select. This will be sent to the API.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:9

envoc-form / Exports / ServerErrorContextProps

Interface: ServerErrorContextProps

Properties

Defined in

packages/envoc-form/src/Form/ServerErrorContext.ts:7

Methods

getError

▸ getError(path): undefined | string

Parameters

Name	Type
`path`	`string`

Defined in

packages/envoc-form/src/Form/ServerErrorContext.ts:8

setError

▸ setError(path, errorMessage): void

Parameters

Name	Type
`path`	`string`
`errorMessage`	`undefined` \| `string`

Defined in

packages/envoc-form/src/Form/ServerErrorContext.ts:9

envoc-form / Exports / ServerErrors

Interface: ServerErrors

Indexable

[path: string]: string

envoc-form / Exports / SingleNumberSelectGroupProps

Interface: SingleNumberSelectGroupProps

Hierarchy

SelectGroupPropsHelper<number | undefined | null>

↳ SingleNumberSelectGroupProps

Properties

className
disabled
helpText
input
label
meta
options
placeholder
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | number>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | number>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

options

Options for the dropdown. Includes the label and value.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:34

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:38

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / SingleStringSelectGroupProps

Interface: SingleStringSelectGroupProps

Hierarchy

SelectGroupPropsHelper<string>

↳ SingleStringSelectGroupProps

Properties

className
disabled
helpText
input
label
meta
options
placeholder
required

Properties

className

• Optional className: string

Extra class names to apply.

disabled

• Optional disabled: boolean

Whether the field should be disabled.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

options

• options: SelectOption<string>[] | OptionsUseServiceResult<string>

Options for the dropdown. Includes the label and value.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:34

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:38

Defined in

packages/envoc-form/src/Group.tsx:21

envoc-form / Exports / StandardFormActionsProps

Interface: StandardFormActionsProps

Properties

allowPristineSubmit

• Optional allowPristineSubmit: boolean

Allow the form to be submitted without any changes. By default this is not allowed.

Defined in

packages/envoc-form/src/StandardFormActions.tsx:9

handleCancel

• Optional handleCancel: MouseEventHandler<HTMLButtonElement>

The cancel button's onClick.

defaultvalue window.history.back()

Defined in

packages/envoc-form/src/StandardFormActions.tsx:13

envoc-form / Exports / StringDateOnlyPickerGroupProps

Interface: StringDateOnlyPickerGroupProps

Hierarchy

DatePickerHelper<string | undefined | null>

↳ StringDateOnlyPickerGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

envoc-form / Exports / StringDatePickerGroupProps

Interface: StringDatePickerGroupProps

Hierarchy

DatePickerHelper<string | undefined | null>

↳ StringDatePickerGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

envoc-form / Exports / StringDateTimePickerGroupProps

Interface: StringDateTimePickerGroupProps

Hierarchy

DateTimePickerHelper<string | undefined | null>

↳ StringDateTimePickerGroupProps

Methods

onAbort
onAnimationEnd
onAnimationIteration
onAnimationStart
onBlur
onCanPlay
onCanPlayThrough
onClick
onCompositionEnd
onCompositionStart
onCompositionUpdate
onContextMenu
onCopy
onCut
onDoubleClick
onDrag
onDragEnd
onDragEnter
onDragExit
onDragLeave
onDragOver
onDragStart
onDrop
onDurationChange
onEmptied
onEncrypted
onEnded
onError
onGotPointerCapture
onInput
onInvalid
onKeyDown
onKeyPress
onKeyUp
onLoad
onLoadStart
onLoadedData
onLoadedMetadata
onLostPointerCapture
onMouseDown
onMouseEnter
onMouseLeave
onMouseMove
onMouseOut
onMouseOver
onMouseUp
onPaste
onPause
onPlay
onPlaying
onPointerCancel
onPointerDown
onPointerEnter
onPointerLeave
onPointerMove
onPointerOut
onPointerOver
onPointerUp
onProgress
onRateChange
onReset
onScroll
onSeeked
onSeeking
onSelect
onStalled
onSubmit
onSuspend
onTimeUpdate
onToggle
onTouchCancel
onTouchEnd
onTouchMove
onTouchStart
onTransitionEnd
onVolumeChange
onWaiting
onWheel

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

Methods

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onAnimationIteration

▸ onAnimationIteration(event): void

Parameters

Name	Type
`event`	`any`

Inherited from

DateTimePickerHelper.onAnimationIteration

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCompositionStart

▸ onCompositionStart(event): void

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCompositionUpdate

▸ onCompositionUpdate(event): void

Parameters

Name	Type
`event`	`any`

Inherited from

DateTimePickerHelper.onCompositionUpdate

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onGotPointerCapture

▸ onGotPointerCapture(event): void

Parameters

Name	Type
`event`	`any`

Inherited from

DateTimePickerHelper.onGotPointerCapture

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

onLostPointerCapture

▸ onLostPointerCapture(event): void

Parameters

Name	Type
`event`	`any`

Inherited from

DateTimePickerHelper.onLostPointerCapture

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

Parameters

Name	Type
`event`	`any`

Defined in

common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22

envoc-form / Exports / StringInputGroupProps

Interface: StringInputGroupProps

Hierarchy

Omit<InputGroupProps<string | undefined | null>, "onChange" | "type" | "value">

↳ StringInputGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:20

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

type

Defined in

packages/envoc-form/src/Input/StringInputGroup.tsx:11

envoc-form / Exports / SubmitFormButtonProps

Interface: SubmitFormButtonProps

Hierarchy

Omit<React.HTMLProps<HTMLButtonElement>, "type">

↳ SubmitFormButtonProps

Properties

allowPristineSubmit

• Optional allowPristineSubmit: boolean

Allow the form to be submitted without any changes. By default this is not allowed.

Defined in

packages/envoc-form/src/SubmitFormButton.tsx:9

children

• Optional children: ReactNode

Text to display on the button. Default text is 'Submit'.

Defined in

packages/envoc-form/src/SubmitFormButton.tsx:11

envoc-form / Exports / TextAreaGroupProps

Interface: TextAreaGroupProps

Hierarchy

InjectedFieldProps<string | undefined | null>
Omit<React.HTMLProps<HTMLTextAreaElement>, keyof InjectedFieldProps<any> | "children" | "className" | "label">
Omit<GroupProps, keyof InjectedFieldProps<any> | "children">

↳ TextAreaGroupProps

Properties

className

• Optional className: string

Extra class names to apply.

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Defined in

packages/envoc-form/src/TextArea/TextAreaGroup.tsx:14

input

• input: CustomFieldInputProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:6

label

• Optional label: string

Simple text label before the input.

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Defined in

packages/envoc-form/src/Field/InjectedFieldProps.ts:7

envoc-form / Exports / ValidatedApiResult

Interface: ValidatedApiResult

The root result from a typical envoc API call when forms are returned

Properties

Defined in

packages/envoc-form/src/Validation/ValidatedApiResult.ts:7

validationFailures

• Optional validationFailures: ValidationError[]

Defined in

packages/envoc-form/src/Validation/ValidatedApiResult.ts:6

envoc-form / Exports / ValidationError

Interface: ValidationError

Represents a server side validation failure - only 'standard' for envoc

Properties

Defined in

packages/envoc-form/src/Validation/ValidationError.ts:5

Defined in

packages/envoc-form/src/Validation/ValidationError.ts:4

envoc-form / Exports / ValidationFunction

Interface: ValidationFunction<TValue>

Type parameters

Name
`TValue`

Callable

ValidationFunction

▸ ValidationFunction(value): undefined | string

Client side validation function

Parameters

Name	Type
`value`	`TValue`

Defined in

packages/envoc-form/src/Validation/ValidationFunction.ts:3

envoc-form / Exports / useStandardFieldProps

Interface: useStandardFieldProps<TValue>

Properties

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Defined in

packages/envoc-form/src/Field/useStandardField.ts:16

id

• Optional id: string

Id of the field.

Defined in

packages/envoc-form/src/Field/useStandardField.ts:12

Defined in

packages/envoc-form/src/Field/useStandardField.ts:14

normalize

• Optional normalize: NormalizationFunction<TValue>

Function to modify the field value without making the form dirty. (e.g. phone number)

Defined in

packages/envoc-form/src/Field/useStandardField.ts:20

validate

• Optional validate: ValidationFunction<TValue> | ValidationFunction<TValue>[]

Function to validate the field.

Defined in

packages/envoc-form/src/Field/useStandardField.ts:18

envoc-form / Exports

envoc-form

Ƭ ArrayFormBuilderProp<TValue>: TValue extends infer TForm[] | undefined | null ? TForm extends object ? { Field: <TProp, TRenderComponent>(props: FieldProps<TForm, TProp, TRenderComponent>) => Element ; FieldArray: <TProp>(props: FieldArrayProps<TForm, TProp>) => Element } : never : never

Type parameters

Name	Type
`TValue`	extends `any`[] \| `undefined` \| `null`

Defined in

packages/envoc-form/src/FieldArray/FieldArray.tsx:30

FieldArrayProps

Ƭ FieldArrayProps<TForm, TProp>: TForm[TProp] extends any[] | undefined | null ? { disabled?: boolean ; label?: string ; name: TProp ; validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[] ; children: (formBuilder: ArrayFormBuilderProp<any[any]>) => Element } : never

Type parameters

Name	Type
`TForm`	extends `object`
`TProp`	extends keyof `TForm`

Defined in

packages/envoc-form/src/FieldArray/FieldArray.tsx:9

FieldProps

Ƭ FieldProps<TForm, TProp, TRenderComponent>: { Component: RenderComponent<TForm[TProp], TRenderComponent> ; disabled?: boolean ; id?: string ; name: TProp ; normalize?: NormalizationFunction<TForm[TProp]> ; validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[] } & Omit<RenderComponentProps<TForm[TProp], TRenderComponent>, keyof InjectedFieldProps<TForm[TProp]>>

A specific Field instance to be rendered by the given TRenderComponent or by whatever default is reasonable

Type parameters

Name	Type
`TForm`	extends `object`
`TProp`	extends keyof `TForm`
`TRenderComponent`	extends `ElementType`

Defined in

packages/envoc-form/src/Field/Field.tsx:32

FormBuilderProp

Ƭ FormBuilderProp<TForm>: Object

Type parameters

Name	Type
`TForm`	extends `object`

Type declaration

Name	Type
`Field`	<TProp, TRenderComponent>(`props`: `FieldProps`<`TForm`, `TProp`, `TRenderComponent`>) => `Element`
`FieldArray`	<TProp>(`props`: `FieldArrayProps`<`TForm`, `TProp`>) => `Element`

Defined in

packages/envoc-form/src/Form/Form.tsx:33

FormProps

Ƭ FormProps<TForm>: RequireAtLeastOne<FullFormProps<TForm>, "onSubmit" | "onFormDataSubmit">

Type parameters

Name	Type
`TForm`	extends `object`

Defined in

packages/envoc-form/src/Form/Form.tsx:75

RenderComponent

Ƭ RenderComponent<TValue, TRenderComponent>: Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined | null>> ? TRenderComponent : never

Type parameters

Name	Type
`TValue`	`TValue`
`TRenderComponent`	extends `ElementType`

Defined in

packages/envoc-form/src/Field/Field.tsx:13

RenderComponentProps

Ƭ RenderComponentProps<TValue, TRenderComponent>: Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined | null>> ? ComponentProps<TRenderComponent> : never

Type parameters

Name	Type
`TValue`	`TValue`
`TRenderComponent`	extends `ElementType`

Defined in

packages/envoc-form/src/Field/Field.tsx:22

StandAloneInputProps

Ƭ StandAloneInputProps<TValue, TRenderComponent>: { Component: RenderComponent<TValue, TRenderComponent> ; value: TValue ; onChange: (arg: TValue) => void } & Omit<RenderComponentProps<TValue, TRenderComponent>, keyof InjectedFieldProps<TValue> | "value" | "onChange" | "normalize" | "validate">

Type parameters

Name	Type
`TValue`	`TValue`
`TRenderComponent`	extends `ElementType`

Defined in

packages/envoc-form/src/Field/StandAloneInput.tsx:8

Properties

Field

• Field: <TForm, TProp, TRenderComponent>(__namedParameters: FieldProps<TForm, TProp, TRenderComponent>, ref: LegacyRef<any>) => Element

Type declaration

▸ <TForm, TProp, TRenderComponent>(__namedParameters, ref): Element

Renders whatever Component is passed - injecting the formik values needed to finish wiring up that individual field. Should no Component be used then the default will be provided by the default lookup based on typeof(TForm[TProp])

Type parameters

Name	Type
`TForm`	extends `object`
`TProp`	extends `string` \| `number` \| `symbol`
`TRenderComponent`	extends `ElementType`<`any`>

Parameters

Name	Type
`__namedParameters`	`FieldProps`<`TForm`, `TProp`, `TRenderComponent`>
`ref`	`LegacyRef`<`any`>

Returns

Element

SubmitFormButton

• SubmitFormButton: FunctionComponent<SubmitFormButtonProps>

Variables

FieldNameContext

• Const FieldNameContext: Context<undefined | string>

provides the full, qualified name of the current field name - including nested fields, path/dot delimited

Defined in

packages/envoc-form/src/Field/FieldNameContext.ts:4

FileGroup

• Const FileGroup: ComponentType<FileGroupProps>

File upload input group.

Defined in

packages/envoc-form/src/File/FileGroup.tsx:81

FormDefaults

• Const FormDefaults: Object

envoc-form- CSS class prefix

Type declaration

Name	Type
`cssClassPrefix`	`string`

Defined in

packages/envoc-form/src/FormDefaults.ts:2

IconInputGroup

• Const IconInputGroup: ComponentType<IconInputGroupProps>

Input group with an icon.

Defined in

packages/envoc-form/src/Input/IconInputGroup.tsx:50

MoneyInputGroup

• Const MoneyInputGroup: FunctionComponent<MoneyInputGroupProps>

Input group for inputting money.

Defined in

packages/envoc-form/src/Input/MoneyInputGroup.tsx:46

NumberInputGroup

• Const NumberInputGroup: ComponentType<NumberInputGroupProps>

Standard number input group. By default allows for float values.

Defined in

packages/envoc-form/src/Input/NumberInputGroup.tsx:44

PhoneNumberInputGroup

• Const PhoneNumberInputGroup: ComponentType<PhoneNumberInputGroupProps>

A standard phone number input. Will display to the user in +XXX XXX-XXX-XXXX format as the number is being inputted. The data will get sent in the same format as displayed. Uses normalizers.phoneNumber.

default autoComplete="tel-national"

Defined in

packages/envoc-form/src/Input/PhoneNumberInputGroup.tsx:45

ServerErrorContext

• Const ServerErrorContext: Context<ServerErrorContextProps>

Context to store the API errors from the server for the form.

Defined in

packages/envoc-form/src/Form/ServerErrorContext.ts:12

StringInputGroup

• Const StringInputGroup: ComponentType<StringInputGroupProps>

Standard string input group.

Defined in

packages/envoc-form/src/Input/StringInputGroup.tsx:49

TextAreaGroup

• Const TextAreaGroup: ComponentType<TextAreaGroupProps>

Generic controlled <textarea/> wrapped by a <Group/>

Defined in

packages/envoc-form/src/TextArea/TextAreaGroup.tsx:60

Functions

AddressInput

▸ AddressInput(__namedParameters): Element

Collection of <Field/>s for inputting an address. Includes:

Address 1
Address 2
City
State
Zip

Parameters

Name	Type
`__namedParameters`	`AddressInputProps`

Returns

Element

Defined in

packages/envoc-form/src/AddressInput/AddressInput.tsx:36

BooleanSelectGroup

▸ BooleanSelectGroup(props): Element

A <SelectGroup/> dropdown with two options. Default options are 'Yes' and 'No' with values of true and false.

Parameters

Name	Type
`props`	`BooleanSelectGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/Select/BooleanSelectGroup.tsx:20

ConfirmBaseForm

▸ ConfirmBaseForm(__namedParameters): Element

Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action. Commonly used for confirming delete and archive.

See <ConfirmDeleteForm/> if the confirmation is specifically for deletion.

Parameters

Name	Type
`__namedParameters`	`ConfirmBaseFormProps`

Returns

Element

Defined in

packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:33

ConfirmDeleteForm

▸ ConfirmDeleteForm(__namedParameters): Element

Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.

Wraps <ConfirmBaseForm/>.

Parameters

Name	Type
`__namedParameters`	`ConfirmDeleteFormProps`

Returns

Element

Defined in

packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:33

DatePickerGroup

▸ DatePickerGroup<T>(__namedParameters): Element

Field for inputting dates. Uses <Group/> and <DatePicker/>.

Uses react-date-picker

Type parameters

Name
`T`

Parameters

Name	Type
`__namedParameters`	`DatePickerGroupProps`<`T`>

Returns

Element

Defined in

packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:26

DateTimePickerGroup

▸ DateTimePickerGroup<T>(__namedParameters): Element

Field for inputting date and time. Uses <Group/> and <DateTimePicker/>.

Uses react-datetime-picker

Type parameters

Name
`T`

Parameters

Name	Type
`__namedParameters`	`DateTimePickerGroupProps`<`T`>

Returns

Element

Defined in

packages/envoc-form/src/DateTimePicker/DateTimePickerGroup.tsx:31

FieldArray

▸ FieldArray<TForm, TProp>(__namedParameters): Element

An array of fields that allows the user to add multiple instances of the same field.

Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields.

Type parameters

Name	Type
`TForm`	extends `object`
`TProp`	extends `string` \| `number` \| `symbol`

Parameters

Name	Type
`__namedParameters`	`FieldArrayProps`<`TForm`, `TProp`>

Returns

Element

Defined in

packages/envoc-form/src/FieldArray/FieldArray.tsx:53

FieldErrorScrollTarget

▸ FieldErrorScrollTarget(): null | Element

Hidden <div/> that acts as an anchor to scroll to when a form error occurs.

Returns

null | Element

Defined in

packages/envoc-form/src/Field/FieldErrorScrollTarget.tsx:5

Form

▸ Form<TForm>(__namedParameters): Element

Define a form. Uses formik. Usually contains many <Field/> components.

Type parameters

Name	Type
`TForm`	extends `object`

Parameters

Name	Type
`__namedParameters`	`FormProps`<`TForm`>

Returns

Element

Defined in

packages/envoc-form/src/Form/Form.tsx:81

FormActions

▸ FormActions(__namedParameters): Element

Standard cancel and submit buttons.

Parameters

Name	Type
`__namedParameters`	`FormActionsProps`

Returns

Element

Defined in

packages/envoc-form/src/FormActions.tsx:17

Group

▸ Group(__namedParameters): Element

Contains standard field bits like a label, helper text, error scroll target, validation message container, etc.

Parameters

Name	Type
`__namedParameters`	`GroupProps`

Returns

Element

Defined in

packages/envoc-form/src/Group.tsx:25

InputGroup

▸ Const InputGroup<TValue>(__namedParameters, ref): Element

Generic controlled <input/> wrapped by a <Group/>

Type parameters

Name
`TValue`

Parameters

Name	Type
`__namedParameters`	`InputGroupProps`<`TValue`>
`ref`	`LegacyRef`<`HTMLInputElement`>

Returns

Element

Defined in

packages/envoc-form/src/Input/InputGroup.tsx:70

MultiNumberSelectGroup

▸ MultiNumberSelectGroup(props): Element

A <SelectGroup/> dropdown with values as numbers. Many options can be selected at a time.

Parameters

Name	Type
`props`	`MultiNumberSelectGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/Select/NumberSelectGroup.tsx:7

MultiStringSelectGroup

▸ MultiStringSelectGroup(props): Element

A <SelectGroup/> dropdown with values as strings. Multiple options can be selected at a time.

Parameters

Name	Type
`props`	`MultiStringSelectGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/Select/StringSelectGroup.tsx:7

SelectGroup

▸ SelectGroup<TValue>(__namedParameters): Element

Generic select dropdown. Uses react-select.

Type parameters

Name
`TValue`

Parameters

Name	Type
`__namedParameters`	`SelectGroupProps`<`TValue`>

Returns

Element

Defined in

packages/envoc-form/src/Select/SelectGroup.tsx:43

SingleNumberSelectGroup

▸ SingleNumberSelectGroup(props): Element

A <SelectGroup/> dropdown with values as numbers. Only one option can be selected at a time.

Parameters

Name	Type
`props`	`SingleNumberSelectGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/Select/NumberSelectGroup.tsx:14

SingleStringSelectGroup

▸ SingleStringSelectGroup(props): Element

A <SelectGroup/> dropdown with the value as a string. Only one option can be selected at a time.

Parameters

Name	Type
`props`	`SingleStringSelectGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/Select/StringSelectGroup.tsx:14

StandAloneInput

▸ StandAloneInput<TValue, TComponent>(props): Element

The stand alone version of <Field/>. Can use a type of input component outside of a <Form/>.

Type parameters

Name	Type
`TValue`	`TValue`
`TComponent`	extends `ElementType`<`any`>

Parameters

Name	Type
`props`	`StandAloneInputProps`<`TValue`, `TComponent`>

Returns

Element

Defined in

packages/envoc-form/src/Field/StandAloneInput.tsx:28

StandardFormActions

▸ StandardFormActions(__namedParameters): Element

Standard submit and cancel buttons.

Parameters

Name	Type
`__namedParameters`	`StandardFormActionsProps`

Returns

Element

Defined in

packages/envoc-form/src/StandardFormActions.tsx:17

StringDateOnlyPickerGroup

▸ StringDateOnlyPickerGroup(props): Element

Date picker input that consumes and outputs as a date only string in ISO format YYYY-MM-DD.

Default display to the user is in MM/DD/YYYY format.

Parameters

Name	Type
`props`	`StringDateOnlyPickerGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/DatePicker/StringDateOnlyPickerGroup.tsx:12

StringDatePickerGroup

▸ StringDatePickerGroup(props): Element

Date picker input that consumes and outputs as a date only string in ISO format YYYY-MM-DDTHH:mm:ss.sssZ or ±YYYYYY-MM-DDTHH:mm:ss.sssZ

If you need YYYY-MM-DD format use <StringDateOnlyPickerGroup/>.

Parameters

Name	Type
`props`	`StringDatePickerGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/DatePicker/StringDatePickerGroup.tsx:12

StringDateTimePickerGroup

▸ StringDateTimePickerGroup(props): Element

Date Time picker input that consumes JS Date object and outputs as a date time offset string in ISO format YYYY-MM-DDTHH:mm:ss.sss±hh:mm.

Default display to the user is in MM/DD/YYYY HH:mm:ss AM/PM format.

Parameters

Name	Type
`props`	`StringDateTimePickerGroupProps`

Returns

Element

Defined in

packages/envoc-form/src/DateTimePicker/StringDateTimePickerGroup.tsx:12

convertToTimeZoneInsensitiveISOString

▸ convertToTimeZoneInsensitiveISOString(date): string

Parameters

Name	Type
`date`	`Date`

Returns

string

Defined in

packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:118

isArray

▸ Const isArray(value): boolean

Parameters

Name	Type
`value`	`any`

Returns

boolean

Defined in

packages/envoc-form/src/utils/typeChecks.ts:5

isBlob

▸ Const isBlob(value): any

Parameters

Name	Type
`value`	`any`

Returns

any

Defined in

packages/envoc-form/src/utils/typeChecks.ts:8

isBoolean

▸ Const isBoolean(value): boolean

Parameters

Name	Type
`value`	`any`

Returns

boolean

Defined in

packages/envoc-form/src/utils/typeChecks.ts:3

isDate

▸ Const isDate(value): boolean

Parameters

Name	Type
`value`	`any`

Returns

boolean

Defined in

packages/envoc-form/src/utils/typeChecks.ts:6

isFile

▸ Const isFile(value): any

Parameters

Name	Type
`value`	`any`

Returns

any

Defined in

packages/envoc-form/src/utils/typeChecks.ts:14

isNull

▸ Const isNull(value): boolean

Parameters

Name	Type
`value`	`any`

Returns

boolean

Defined in

packages/envoc-form/src/utils/typeChecks.ts:2

isObject

▸ Const isObject(value): boolean

Parameters

Name	Type
`value`	`any`

Returns

boolean

Defined in

packages/envoc-form/src/utils/typeChecks.ts:4

isUndefined

▸ Const isUndefined(value): boolean

Parameters

Name	Type
`value`	`any`

Returns

boolean

Defined in

packages/envoc-form/src/utils/typeChecks.ts:1

objectContainsNonSerializableProperty

▸ objectContainsNonSerializableProperty(object): boolean

Parameters

Name	Type
`object`	`any`

Returns

boolean

Defined in

packages/envoc-form/src/utils/objectContainsNonSerializableProperty.ts:3

serialize

▸ Const serialize(obj, cfg, fd?, pre?): FormData

Parameters

Name	Type
`obj`	`any`
`cfg`	`ObjectToFormDataCfgProps`
`fd?`	`FormData`
`pre?`	`string`

Returns

FormData

Defined in

packages/envoc-form/src/utils/objectToFormData.ts:25

useStandardField

▸ useStandardField<TValue>(__namedParameters): [CustomFieldInputProps<TValue>, CustomFieldMetaProps<TValue>]

Provides a consistent way to deal with all form fields (non array).

Type parameters

Name
`TValue`

Parameters

Name	Type
`__namedParameters`	`useStandardFieldProps`<`TValue`>

Returns

[CustomFieldInputProps<TValue>, CustomFieldMetaProps<TValue>]

Defined in

packages/envoc-form/src/Field/useStandardField.ts:24

Modules

envoc-form / Exports / Form

Namespace: Form

Variables

DisplayFormState

Variables

DisplayFormState

• DisplayFormState: () => Element

Type declaration

▸ (): Element

Returns

Element

envoc-form / Exports / normalizers

Namespace: normalizers

Functions

phoneNumber
zipCode

Functions

phoneNumber

▸ Const phoneNumber(value): undefined | string

Normalizer for converting a string into a valid phone number.

Parameters

Name	Type
`value`	`undefined` \| `null` \| `string`

Returns

undefined | string

Defined in

packages/envoc-form/src/Normalization/normalizers.ts:2

zipCode

▸ Const zipCode(value): undefined | string

Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format.

Parameters

Name	Type
`value`	`undefined` \| `null` \| `string`

Returns

undefined | string

Defined in

packages/envoc-form/src/Normalization/normalizers.ts:35

envoc-form / Exports / validators

Namespace: validators

Functions

any
integer
length
maxCount
maxLength
maxValue
minCount
minValue
required
zipCode

Functions

any

▸ Const any<TValue>(validatorList): (value: TValue) => undefined | string

One of the validators provided must be true.

Type parameters

Name
`TValue`

Parameters

Name	Type
`validatorList`	`ValidationFunction`<`TValue`>[]

Returns

fn

▸ (value): undefined | string

Parameters

Name	Type
`value`	`TValue`

Returns

undefined | string

Defined in

packages/envoc-form/src/Validation/validators.ts:65

integer

▸ Const integer(val): undefined | "Must be a whole number"

Parameters

Name	Type
`val`	`undefined` \| `null` \| `string` \| `number`

Returns

undefined | "Must be a whole number"

Defined in

packages/envoc-form/src/Validation/validators.ts:19

length

▸ Const length(len): (value: undefined | null | string | number) => undefined | string

Asserts that the value is a certain number of characters. numbers are coerced to a string

Parameters

Name	Type
`len`	`number`

Returns

fn

▸ (value): undefined | string

Parameters

Name	Type
`value`	`undefined` \| `null` \| `string` \| `number`

Returns

undefined | string

Defined in

packages/envoc-form/src/Validation/validators.ts:13

maxCount

▸ Const maxCount(count): (value: undefined | null | { isDeleted?: boolean }[]) => undefined | string

Parameters

Name	Type
`count`	`number`

Returns

fn

▸ (value): undefined | string

Parameters

Name	Type
`value`	`undefined` \| `null` \| { `isDeleted?`: `boolean` }[]

Name	Type
`len`	`number`

Returns

fn

▸ (value): undefined | string

Parameters

Name	Type
`value`	`undefined` \| `null` \| `string` \| `number`

Name	Type
`max`	`number`

Returns

fn

▸ (value): undefined | string

Parameters

Name	Type
`value`	`undefined` \| `null` \| `number`

Name	Type
`count`	`number`

Returns

fn

▸ (value): undefined | string

Parameters

Name	Type
`value`	`undefined` \| `null` \| { `isDeleted?`: `boolean` }[]

Name	Type
`min`	`number`

Returns

fn

▸ (value): undefined | string

Parameters

Name	Type
`value`	`undefined` \| `null` \| `number`

Name	Type
`value`	`any`

Name	Type
`value`	`undefined` \| `null` \| `string`