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

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

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.

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

Table of contents

Properties

• className
• helpText
• input
• label
• meta

Methods

• convert

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

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

Methods

convert

▸ convert(arg): T

Parameters

| Name | Type | | :------ | :------ | | arg | Date |

Returns

T

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

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 / 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

Table of contents

Properties

• className
• helpText
• input
• label
• meta

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.

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

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

Methods

convert

▸ convert(date): T

Parameters

| Name | Type | | :------ | :------ | | date | Date |

Returns

T

Defined in

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

onAbort

▸ onAbort(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onAbort

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onAnimationEnd

▸ onAnimationEnd(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onAnimationEnd

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onAnimationIteration

▸ onAnimationIteration(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onAnimationIteration

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onAnimationStart

▸ onAnimationStart(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onAnimationStart

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onBlur

▸ onBlur(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onBlur

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCanPlay

▸ onCanPlay(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onCanPlay

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCanPlayThrough

▸ onCanPlayThrough(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onCanPlayThrough

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onClick

▸ onClick(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onClick

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCompositionEnd

▸ onCompositionEnd(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onCompositionEnd

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCompositionStart

▸ onCompositionStart(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onCompositionStart

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCompositionUpdate

▸ onCompositionUpdate(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onCompositionUpdate

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onContextMenu

▸ onContextMenu(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onContextMenu

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCopy

▸ onCopy(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onCopy

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onCut

▸ onCut(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onCut

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDoubleClick

▸ onDoubleClick(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDoubleClick

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDrag

▸ onDrag(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDrag

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDragEnd

▸ onDragEnd(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDragEnd

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDragEnter

▸ onDragEnter(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDragEnter

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDragExit

▸ onDragExit(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDragExit

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDragLeave

▸ onDragLeave(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDragLeave

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDragOver

▸ onDragOver(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDragOver

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDragStart

▸ onDragStart(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDragStart

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDrop

▸ onDrop(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDrop

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onDurationChange

▸ onDurationChange(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onDurationChange

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onEmptied

▸ onEmptied(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onEmptied

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onEncrypted

▸ onEncrypted(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onEncrypted

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onEnded

▸ onEnded(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onEnded

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onError

▸ onError(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onError

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onGotPointerCapture

▸ onGotPointerCapture(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onGotPointerCapture

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onInput

▸ onInput(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onInput

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onInvalid

▸ onInvalid(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onInvalid

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onKeyDown

▸ onKeyDown(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onKeyDown

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onKeyPress

▸ onKeyPress(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onKeyPress

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onKeyUp

▸ onKeyUp(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onKeyUp

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onLoad

▸ onLoad(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onLoad

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onLoadStart

▸ onLoadStart(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onLoadStart

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onLoadedData

▸ onLoadedData(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onLoadedData

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onLoadedMetadata

▸ onLoadedMetadata(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onLoadedMetadata

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onLostPointerCapture

▸ onLostPointerCapture(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onLostPointerCapture

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onMouseDown

▸ onMouseDown(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onMouseDown

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onMouseEnter

▸ onMouseEnter(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onMouseEnter

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onMouseLeave

▸ onMouseLeave(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onMouseLeave

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onMouseMove

▸ onMouseMove(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onMouseMove

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onMouseOut

▸ onMouseOut(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onMouseOut

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onMouseOver

▸ onMouseOver(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onMouseOver

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onMouseUp

▸ onMouseUp(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onMouseUp

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPaste

▸ onPaste(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPaste

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPause

▸ onPause(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPause

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPlay

▸ onPlay(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPlay

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPlaying

▸ onPlaying(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPlaying

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerCancel

▸ onPointerCancel(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerCancel

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerDown

▸ onPointerDown(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerDown

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerEnter

▸ onPointerEnter(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerEnter

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerLeave

▸ onPointerLeave(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerLeave

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerMove

▸ onPointerMove(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerMove

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerOut

▸ onPointerOut(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerOut

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerOver

▸ onPointerOver(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerOver

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onPointerUp

▸ onPointerUp(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onPointerUp

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onProgress

▸ onProgress(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onProgress

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onRateChange

▸ onRateChange(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onRateChange

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onReset

▸ onReset(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onReset

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onScroll

▸ onScroll(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onScroll

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onSeeked

▸ onSeeked(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onSeeked

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onSeeking

▸ onSeeking(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onSeeking

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onSelect

▸ onSelect(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onSelect

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onStalled

▸ onStalled(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onStalled

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onSubmit

▸ onSubmit(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onSubmit

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onSuspend

▸ onSuspend(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onSuspend

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onTimeUpdate

▸ onTimeUpdate(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onTimeUpdate

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onToggle

▸ onToggle(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onToggle

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onTouchCancel

▸ onTouchCancel(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onTouchCancel

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onTouchEnd

▸ onTouchEnd(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onTouchEnd

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onTouchMove

▸ onTouchMove(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onTouchMove

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onTouchStart

▸ onTouchStart(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onTouchStart

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onTransitionEnd

▸ onTransitionEnd(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onTransitionEnd

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onVolumeChange

▸ onVolumeChange(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onVolumeChange

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onWaiting

▸ onWaiting(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onWaiting

Defined in

common/temp/node_modules/.pnpm/[email protected]/node_modules/make-event-props/dist/cjs/index.d.ts:22

onWheel

▸ onWheel(event): void

Parameters

| Name | Type | | :------ | :------ | | event | any |

Returns

void

Inherited from

Omit.onWheel

Defined in

common/temp/node_modules/.pnpm/[email protected]/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

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

Methods

• 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

Methods

handleCancel

▸ Optional handleCancel(): void

The cancel button's onClick.

defaultvalue window.history.back()

Returns

void

Defined in

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

envoc-form / Exports / GroupProps

Interface: GroupProps

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: "search" | "color" | "text" | "email" | "tel" | "url"

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

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>

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

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, 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

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: SelectOption<undefined | null | number[]>[] | OptionsUseServiceResult<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: 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 / NormalizationFunction

Interface: NormalizationFunction<TValue>

Type parameters

| Name | | :------ | | TValue |

Callable

NormalizationFunction

▸ NormalizationFunction(value): TValue

Normalization of values

Parameters

| Name | Type | | :------ | :------ | | value | TValue |

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, 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

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>

Type parameters

| Name | | :------ | | TValue |

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