envoc-form v5.0.7

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

Table of contents

Properties

• fieldBuilder
• name

Properties

fieldBuilder

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

Defined in

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

name

• name: string

Defined in

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

envoc-form / Exports / BooleanSelectGroupProps

Interface: BooleanSelectGroupProps

Hierarchy

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

  ↳ BooleanSelectGroupProps

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• options
• placeholder
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

Omit.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | boolean>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | boolean>

Inherited from

Omit.meta

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.

Inherited from

Omit.placeholder

Defined in

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

required

• Optional required: boolean

Inherited from

Omit.required

Defined in

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

envoc-form / Exports / CheckboxInputGroupProps

Interface: CheckboxInputGroupProps

Hierarchy

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

  ↳ CheckboxInputGroupProps

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• labelOnLeft
• meta

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

icon

• Optional icon: ReactNode

Inherited from

Omit.icon

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | boolean>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

labelOnLeft

• Optional labelOnLeft: boolean

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | boolean>

Inherited from

Omit.meta

Defined in

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

envoc-form / Exports / ConfirmBaseFormProps

Interface: ConfirmBaseFormProps

Table of contents

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.

Default Value

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

style

• Optional style: CSSProperties

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

Table of contents

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

style

• Optional style: CSSProperties

Inherited from

Pick.style

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.

Default Value

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>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Hierarchy

• InjectedFieldProps<T | undefined | null>

• Omit<DatePickerProps, keyof InjectedFieldProps<T> | "name" | "value" | "className">

• Omit<GroupProps, keyof InjectedFieldProps<T> | "children">

  ↳ DatePickerGroupProps

Table of contents

Properties

• className
• convert
• helpText
• input
• label
• meta

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

convert

• convert: (arg: Date) => T

Type declaration

▸ (arg): T

Parameters

Returns

T

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | T>

Inherited from

InjectedFieldProps.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | T>

Inherited from

InjectedFieldProps.meta

Defined in

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

envoc-form / Exports / DatePickerHelper

Interface: DatePickerHelper<T>

Type parameters

Hierarchy

• Omit<DatePickerGroupProps<T>, "convert">

  ↳ DatePickerHelper

  ↳↳ StringDatePickerGroupProps

  ↳↳ StringDateOnlyPickerGroupProps

Table of contents

Properties

• className
• helpText
• input
• label
• meta

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | T>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | T>

Inherited from

Omit.meta

Defined in

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

envoc-form / Exports / FileGroupProps

Interface: FileGroupProps

Defines what is injected by a Field wrapper of some TRenderComponent

Hierarchy

• InjectedFieldProps<any | undefined | null>

• Omit<GroupProps, keyof InjectedFieldProps<any> | "children">

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

  ↳ FileGroupProps

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• multiple
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

Omit.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

input

• input: CustomFieldInputProps<any>

Inherited from

InjectedFieldProps.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<any>

Inherited from

InjectedFieldProps.meta

Defined in

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

multiple

• Optional multiple: boolean

Allow multiple files to be uploaded.

Overrides

Omit.multiple

Defined in

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

required

• Optional required: boolean

Inherited from

Omit.required

Defined in

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

envoc-form / Exports / FormActionsProps

Interface: FormActionsProps

Table of contents

Properties

• allowPristineSubmit
• disabled
• handleCancel

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

handleCancel

• Optional handleCancel: () => void

Type declaration

▸ (): void

The cancel button's onClick.

Default Value

window.history.back()

Returns

void

Defined in

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

envoc-form / Exports / GroupProps

Interface: GroupProps

Defines what is injected by a Field wrapper of some TRenderComponent

Hierarchy

• InjectedFieldProps<any>

  ↳ GroupProps

Table of contents

Properties

• children
• className
• disabled
• helpText
• input
• label
• meta
• required

Properties

children

• children: ReactNode

Defined in

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

className

• Optional className: string

Extra class names to apply.

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Defined in

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

input

• input: CustomFieldInputProps<any>

Inherited from

InjectedFieldProps.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Defined in

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

meta

• meta: CustomFieldMetaProps<any>

Inherited from

InjectedFieldProps.meta

Defined in

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

required

• Optional required: boolean

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

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• meta
• type

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: string

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

Overrides

Omit.helpText

Defined in

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

icon

• icon: ReactNode

Icon to display on the input group.

Overrides

Omit.icon

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | string>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Inherited from

Omit.meta

Defined in

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

type

• Optional type: "color" | "search" | "text" | "tel" | "url" | "email"

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

Hierarchy

• InjectedFieldProps

  ↳ DatePickerGroupProps

  ↳ FileGroupProps

  ↳ GroupProps

  ↳ InputGroupProps

  ↳ SelectGroupProps

  ↳ TextAreaGroupProps

Table of contents

Properties

• input
• meta

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>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Hierarchy

• InjectedFieldProps<TValue>

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

• Omit<GroupProps, keyof InjectedFieldProps<any> | "children">

  ↳ InputGroupProps

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• meta
• onChange
• value

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

icon

• Optional icon: ReactNode

Defined in

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

input

• input: CustomFieldInputProps<TValue>

Inherited from

InjectedFieldProps.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<TValue>

Inherited from

InjectedFieldProps.meta

Defined in

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

onChange

• onChange: ChangeEventHandler<HTMLInputElement>

Overrides

Omit.onChange

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

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• meta
• parseFunc

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

icon

• Optional icon: ReactNode

Inherited from

Omit.icon

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | number>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | number>

Inherited from

Omit.meta

Defined in

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

parseFunc

• Optional parseFunc: (string: string) => number | (string: string, radix?: number) => 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

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• options
• placeholder
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

SelectGroupPropsHelper.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

SelectGroupPropsHelper.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

SelectGroupPropsHelper.helpText

Defined in

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

input

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

Inherited from

SelectGroupPropsHelper.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

SelectGroupPropsHelper.label

Defined in

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

meta

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

Inherited from

SelectGroupPropsHelper.meta

Defined in

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

options

• options: OptionsUseServiceResult<undefined | null | number[]> | SelectOption<undefined | null | number[]>[]

Options for the dropdown. Includes the label and value.

Inherited from

SelectGroupPropsHelper.options

Defined in

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

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Inherited from

SelectGroupPropsHelper.placeholder

Defined in

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

required

• Optional required: boolean

Inherited from

SelectGroupPropsHelper.required

Defined in

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

envoc-form / Exports / MultiStringSelectGroupProps

Interface: MultiStringSelectGroupProps

Hierarchy

• SelectGroupPropsHelper<string[]>

  ↳ MultiStringSelectGroupProps

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• options
• placeholder
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

SelectGroupPropsHelper.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

SelectGroupPropsHelper.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

SelectGroupPropsHelper.helpText

Defined in

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

input

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

Inherited from

SelectGroupPropsHelper.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

SelectGroupPropsHelper.label

Defined in

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

meta

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

Inherited from

SelectGroupPropsHelper.meta

Defined in

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

options

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

Options for the dropdown. Includes the label and value.

Inherited from

SelectGroupPropsHelper.options

Defined in

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

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Inherited from

SelectGroupPropsHelper.placeholder

Defined in

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

required

• Optional required: boolean

Inherited from

SelectGroupPropsHelper.required

Defined in

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

envoc-form / Exports / NormalizationFunction

Interface: NormalizationFunction<TValue>

Normalization of values

Type parameters

Callable

NormalizationFunction

▸ NormalizationFunction(value): TValue

Parameters

Returns

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

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• meta
• parseFunc

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

icon

• Optional icon: ReactNode

Inherited from

Omit.icon

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | number>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | number>

Inherited from

Omit.meta

Defined in

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

parseFunc

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

Custom parsing function when the value changes.

Defined in

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

envoc-form / Exports / ObjectToFormDataCfgProps

Interface: ObjectToFormDataCfgProps

Table of contents

Properties

• allowEmptyArrays
• booleansAsIntegers
• dotNotation
• indices
• noFileListBrackets
• nullsAsUndefineds

Properties

allowEmptyArrays

• allowEmptyArrays: boolean

Defined in

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

booleansAsIntegers

• Optional booleansAsIntegers: boolean

Defined in

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

dotNotation

• dotNotation: boolean

Defined in

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

indices

• indices: boolean

Defined in

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

noFileListBrackets

• noFileListBrackets: boolean

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

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• meta

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

icon

• Optional icon: ReactNode

Inherited from

Omit.icon

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | string>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Inherited from

Omit.meta

Defined in

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

envoc-form / Exports / SelectGroupProps

Interface: SelectGroupProps<TValue>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Hierarchy

• InjectedFieldProps<TValue | undefined | null>

• Omit<GroupProps, "input" | "meta" | "children">

  ↳ SelectGroupProps

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• multiple
• options
• placeholder
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

Omit.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | TValue>

Inherited from

InjectedFieldProps.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | TValue>

Inherited from

InjectedFieldProps.meta

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: OptionsUseServiceResult<TValue> | SelectOption<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

required

• Optional required: boolean

Inherited from

Omit.required

Defined in

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

envoc-form / Exports / SelectGroupPropsHelper

Interface: SelectGroupPropsHelper<T>

Type parameters

Hierarchy

• Omit<SelectGroupProps<T>, "multiple">

  ↳ SelectGroupPropsHelper

  ↳↳ MultiNumberSelectGroupProps

  ↳↳ SingleNumberSelectGroupProps

  ↳↳ MultiStringSelectGroupProps

  ↳↳ SingleStringSelectGroupProps

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• options
• placeholder
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

Omit.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | T>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | T>

Inherited from

Omit.meta

Defined in

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

options

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

Options for the dropdown. Includes the label and value.

Inherited from

Omit.options

Defined in

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

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Inherited from

Omit.placeholder

Defined in

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

required

• Optional required: boolean

Inherited from

Omit.required

Defined in

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

envoc-form / Exports / SelectOption

Interface: SelectOption<TValue>

Type parameters

Table of contents

Properties

• label
• value

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

Table of contents

Properties

• errors
• getError
• setError

Properties

errors

• errors: ServerErrors

Defined in

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

getError

• getError: (path: string) => undefined | string

Type declaration

▸ (path): undefined | string

Parameters

Returns

undefined | string

Defined in

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

setError

• setError: (path: string, errorMessage: undefined | string) => void

Type declaration

▸ (path, errorMessage): void

Parameters

Returns

void

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

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• options
• placeholder
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

SelectGroupPropsHelper.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

SelectGroupPropsHelper.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

SelectGroupPropsHelper.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | number>

Inherited from

SelectGroupPropsHelper.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

SelectGroupPropsHelper.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | number>

Inherited from

SelectGroupPropsHelper.meta

Defined in

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

options

• options: OptionsUseServiceResult<undefined | null | number> | SelectOption<undefined | null | number>[]

Options for the dropdown. Includes the label and value.

Inherited from

SelectGroupPropsHelper.options

Defined in

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

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Inherited from

SelectGroupPropsHelper.placeholder

Defined in

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

required

• Optional required: boolean

Inherited from

SelectGroupPropsHelper.required

Defined in

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

envoc-form / Exports / SingleStringSelectGroupProps

Interface: SingleStringSelectGroupProps

Hierarchy

• SelectGroupPropsHelper<string>

  ↳ SingleStringSelectGroupProps

Table of contents

Properties

• className
• disabled
• helpText
• input
• label
• meta
• options
• placeholder
• required

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

SelectGroupPropsHelper.className

Defined in

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

disabled

• Optional disabled: boolean

Whether the field should be disabled.

Inherited from

SelectGroupPropsHelper.disabled

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

SelectGroupPropsHelper.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | string>

Inherited from

SelectGroupPropsHelper.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

SelectGroupPropsHelper.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Inherited from

SelectGroupPropsHelper.meta

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.

Inherited from

SelectGroupPropsHelper.options

Defined in

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

placeholder

• Optional placeholder: string

Text diplayed when no value is selected.

Inherited from

SelectGroupPropsHelper.placeholder

Defined in

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

required

• Optional required: boolean

Inherited from

SelectGroupPropsHelper.required

Defined in

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

envoc-form / Exports / StandardFormActionsProps

Interface: StandardFormActionsProps

Table of contents

Properties

• allowPristineSubmit
• handleCancel

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.

Default Value

window.history.back()

Defined in

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

envoc-form / Exports / StringDateOnlyPickerGroupProps

Interface: StringDateOnlyPickerGroupProps

Hierarchy

• DatePickerHelper<string | undefined | null>

  ↳ StringDateOnlyPickerGroupProps

Table of contents

Properties

• className
• helpText
• input
• label
• meta

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

DatePickerHelper.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

DatePickerHelper.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | string>

Inherited from

DatePickerHelper.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

DatePickerHelper.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Inherited from

DatePickerHelper.meta

Defined in

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

envoc-form / Exports / StringDatePickerGroupProps

Interface: StringDatePickerGroupProps

Hierarchy

• DatePickerHelper<string | undefined | null>

  ↳ StringDatePickerGroupProps

Table of contents

Properties

• className
• helpText
• input
• label
• meta

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

DatePickerHelper.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

DatePickerHelper.helpText

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | string>

Inherited from

DatePickerHelper.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

DatePickerHelper.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Inherited from

DatePickerHelper.meta

Defined in

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

envoc-form / Exports / StringInputGroupProps

Interface: StringInputGroupProps

Hierarchy

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

  ↳ StringInputGroupProps

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• meta
• type

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

icon

• Optional icon: ReactNode

Inherited from

Omit.icon

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | string>

Inherited from

Omit.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Inherited from

Omit.meta

Defined in

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

type

• Optional type: "color" | "search" | "textarea" | "text" | "tel" | "url" | "email" | "password"

Defined in

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

envoc-form / Exports / SubmitFormButtonProps

Interface: SubmitFormButtonProps

Hierarchy

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

  ↳ SubmitFormButtonProps

Table of contents

Properties

• allowPristineSubmit
• children

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'.

Overrides

Omit.children

Defined in

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

envoc-form / Exports / TextAreaGroupProps

Interface: TextAreaGroupProps

Defines what is injected by a Field wrapper of some TRenderComponent

Hierarchy

• InjectedFieldProps<string | undefined | null>

• Omit<React.HTMLProps<HTMLTextAreaElement>, keyof InjectedFieldProps<any> | "children" | "className" | "label">

• Omit<GroupProps, keyof InjectedFieldProps<any> | "children">

  ↳ TextAreaGroupProps

Table of contents

Properties

• className
• helpText
• icon
• input
• label
• meta

Properties

className

• Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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

helpText

• Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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

icon

• Optional icon: ReactNode

Defined in

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

input

• input: CustomFieldInputProps<undefined | null | string>

Inherited from

InjectedFieldProps.input

Defined in

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

label

• Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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

meta

• meta: CustomFieldMetaProps<undefined | null | string>

Inherited from

InjectedFieldProps.meta

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

Table of contents

Properties

• hasErrors
• validationFailures

Properties

hasErrors

• Optional hasErrors: boolean

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

Table of contents

Properties

• errorMessage
• propertyName

Properties

errorMessage

• Optional errorMessage: string

Defined in

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

propertyName

• Optional propertyName: string

Defined in

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

envoc-form / Exports / ValidationFunction

Interface: ValidationFunction<TValue>

Client side validation function

Type parameters

Callable

ValidationFunction

▸ ValidationFunction(value): undefined | string

Parameters

Returns

undefined | string

Defined in

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

envoc-form / Exports / useStandardFieldProps

Interface: useStandardFieldProps<TValue>

Type parameters

Table of contents

Properties

• disabled
• id
• name
• normalize
• validate

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

name

• name: string

Name of the field.

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

Table of contents

Namespaces

• Form
• normalizers
• validators

Interfaces

• AddressInputProps
• BooleanSelectGroupProps
• CheckboxInputGroupProps
• ConfirmBaseFormProps
• ConfirmDeleteFormProps
• DatePickerGroupProps
• DatePickerHelper
• FileGroupProps
• FormActionsProps
• GroupProps
• IconInputGroupProps
• InjectedFieldProps
• InputGroupProps
• MoneyInputGroupProps
• MultiNumberSelectGroupProps
• MultiStringSelectGroupProps
• NormalizationFunction
• NumberInputGroupProps
• ObjectToFormDataCfgProps
• PhoneNumberInputGroupProps
• SelectGroupProps
• SelectGroupPropsHelper
• SelectOption
• ServerErrorContextProps
• ServerErrors
• SingleNumberSelectGroupProps
• SingleStringSelectGroupProps
• StandardFormActionsProps
• StringDateOnlyPickerGroupProps
• StringDatePickerGroupProps
• StringInputGroupProps
• SubmitFormButtonProps
• TextAreaGroupProps
• ValidatedApiResult
• ValidationError
• ValidationFunction
• useStandardFieldProps

Type Aliases

• ArrayFormBuilderProp
• FieldArrayProps
• FieldProps
• FormBuilderProp
• FormProps
• RenderComponent
• RenderComponentProps(#rendercomponentpro