` title text on top of the form. ##### Defined in packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:15 [envoc-form](#readmemd) / [Exports](#modulesmd) / ConfirmDeleteFormProps ## Interface: ConfirmDeleteFormProps ### Hierarchy - `Pick`<[`ConfirmBaseFormProps`](#interfacesconfirmbaseformpropsmd), ``"style"``\> ↳ **`ConfirmDeleteFormProps`** ### Table of contents #### Properties - [children](#children) - [form](#form) - [handleComplete](#handlecomplete) - [handleError](#handleerror) - [style](#style) - [successUrl](#successurl) - [title](#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](#readmemd) / [Exports](#modulesmd) / DatePickerGroupProps ## Interface: DatePickerGroupProps ### Type parameters | Name | | :------ | | `T` | ### Hierarchy - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T` \| `undefined` \| ``null``\> - `Omit`<`DatePickerProps`, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T`\> \| ``"name"`` \| ``"value"`` \| ``"className"``\> - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T`\> \| ``"children"``\> ↳ **`DatePickerGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) #### Methods - [convert](#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](#interfacesinjectedfieldpropsmd).[input](#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](#interfacesinjectedfieldpropsmd).[meta](#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](#readmemd) / [Exports](#modulesmd) / DatePickerHelper ## Interface: DatePickerHelper ### Type parameters | Name | | :------ | | `T` | ### Hierarchy - `Omit`<[`DatePickerGroupProps`](#interfacesdatepickergrouppropsmd)<`T`\>, ``"convert"``\> ↳ **`DatePickerHelper`** ↳↳ [`StringDatePickerGroupProps`](#interfacesstringdatepickergrouppropsmd) ↳↳ [`StringDateOnlyPickerGroupProps`](#interfacesstringdateonlypickergrouppropsmd) ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#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](#readmemd) / [Exports](#modulesmd) / DateTimePickerGroupProps ## Interface: DateTimePickerGroupProps ### Type parameters | Name | | :------ | | `T` | ### Hierarchy - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T` \| `undefined` \| ``null``\> - `Omit`<`DateTimePickerProps`, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T`\> \| ``"name"`` \| ``"value"`` \| ``"className"``\> - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T`\> \| ``"children"``\> ↳ **`DateTimePickerGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) #### Methods - [convert](#convert) - [onAbort](#onabort) - [onAnimationEnd](#onanimationend) - [onAnimationIteration](#onanimationiteration) - [onAnimationStart](#onanimationstart) - [onBlur](#onblur) - [onCanPlay](#oncanplay) - [onCanPlayThrough](#oncanplaythrough) - [onClick](#onclick) - [onCompositionEnd](#oncompositionend) - [onCompositionStart](#oncompositionstart) - [onCompositionUpdate](#oncompositionupdate) - [onContextMenu](#oncontextmenu) - [onCopy](#oncopy) - [onCut](#oncut) - [onDoubleClick](#ondoubleclick) - [onDrag](#ondrag) - [onDragEnd](#ondragend) - [onDragEnter](#ondragenter) - [onDragExit](#ondragexit) - [onDragLeave](#ondragleave) - [onDragOver](#ondragover) - [onDragStart](#ondragstart) - [onDrop](#ondrop) - [onDurationChange](#ondurationchange) - [onEmptied](#onemptied) - [onEncrypted](#onencrypted) - [onEnded](#onended) - [onError](#onerror) - [onGotPointerCapture](#ongotpointercapture) - [onInput](#oninput) - [onInvalid](#oninvalid) - [onKeyDown](#onkeydown) - [onKeyPress](#onkeypress) - [onKeyUp](#onkeyup) - [onLoad](#onload) - [onLoadStart](#onloadstart) - [onLoadedData](#onloadeddata) - [onLoadedMetadata](#onloadedmetadata) - [onLostPointerCapture](#onlostpointercapture) - [onMouseDown](#onmousedown) - [onMouseEnter](#onmouseenter) - [onMouseLeave](#onmouseleave) - [onMouseMove](#onmousemove) - [onMouseOut](#onmouseout) - [onMouseOver](#onmouseover) - [onMouseUp](#onmouseup) - [onPaste](#onpaste) - [onPause](#onpause) - [onPlay](#onplay) - [onPlaying](#onplaying) - [onPointerCancel](#onpointercancel) - [onPointerDown](#onpointerdown) - [onPointerEnter](#onpointerenter) - [onPointerLeave](#onpointerleave) - [onPointerMove](#onpointermove) - [onPointerOut](#onpointerout) - [onPointerOver](#onpointerover) - [onPointerUp](#onpointerup) - [onProgress](#onprogress) - [onRateChange](#onratechange) - [onReset](#onreset) - [onScroll](#onscroll) - [onSeeked](#onseeked) - [onSeeking](#onseeking) - [onSelect](#onselect) - [onStalled](#onstalled) - [onSubmit](#onsubmit) - [onSuspend](#onsuspend) - [onTimeUpdate](#ontimeupdate) - [onToggle](#ontoggle) - [onTouchCancel](#ontouchcancel) - [onTouchEnd](#ontouchend) - [onTouchMove](#ontouchmove) - [onTouchStart](#ontouchstart) - [onTransitionEnd](#ontransitionend) - [onVolumeChange](#onvolumechange) - [onWaiting](#onwaiting) - [onWheel](#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](#interfacesinjectedfieldpropsmd).[input](#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](#interfacesinjectedfieldpropsmd).[meta](#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/make-event-props@1.6.2/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/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onAnimationIteration ▸ **onAnimationIteration**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onAnimationIteration ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onAnimationStart ▸ **onAnimationStart**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onAnimationStart ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCompositionStart ▸ **onCompositionStart**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onCompositionStart ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCompositionUpdate ▸ **onCompositionUpdate**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onCompositionUpdate ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onContextMenu ▸ **onContextMenu**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onContextMenu ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onGotPointerCapture ▸ **onGotPointerCapture**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onGotPointerCapture ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onInput ▸ **onInput**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onInput ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onLostPointerCapture ▸ **onLostPointerCapture**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onLostPointerCapture ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseDown ▸ **onMouseDown**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from Omit.onMouseDown ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/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/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 [envoc-form](#readmemd) / [Exports](#modulesmd) / FileGroupProps ## Interface: FileGroupProps ### Hierarchy - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any` \| `undefined` \| ``null``\> - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"``\> - `Omit`<`React.HTMLProps`<`HTMLInputElement`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"`` \| ``"className"`` \| ``"label"``\> ↳ **`FileGroupProps`** ### Table of contents #### Properties - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [multiple](#multiple) - [required](#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](#interfacesinjectedfieldpropsmd).[input](#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](#interfacesinjectedfieldpropsmd).[meta](#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](#readmemd) / [Exports](#modulesmd) / FormActionsProps ## Interface: FormActionsProps ### Table of contents #### Properties - [allowPristineSubmit](#allowpristinesubmit) - [disabled](#disabled) #### Methods - [handleCancel](#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](#readmemd) / [Exports](#modulesmd) / GroupProps ## Interface: GroupProps ### Hierarchy - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> ↳ **`GroupProps`** ### Table of contents #### Properties - [children](#children) - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [required](#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](#interfacesinjectedfieldpropsmd).[input](#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](#interfacesinjectedfieldpropsmd).[meta](#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](#readmemd) / [Exports](#modulesmd) / IconInputGroupProps ## Interface: IconInputGroupProps ### Hierarchy - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`string` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\> ↳ **`IconInputGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [icon](#icon) - [input](#input) - [label](#label) - [meta](#meta) - [type](#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](#readmemd) / [Exports](#modulesmd) / InjectedFieldProps ## Interface: InjectedFieldProps Defines what is injected by a Field wrapper of some TRenderComponent ### Type parameters | Name | | :------ | | `TValue` | ### Hierarchy - **`InjectedFieldProps`** ↳ [`DatePickerGroupProps`](#interfacesdatepickergrouppropsmd) ↳ [`DateTimePickerGroupProps`](#interfacesdatetimepickergrouppropsmd) ↳ [`FileGroupProps`](#interfacesfilegrouppropsmd) ↳ [`GroupProps`](#interfacesgrouppropsmd) ↳ [`InputGroupProps`](#interfacesinputgrouppropsmd) ↳ [`SelectGroupProps`](#interfacesselectgrouppropsmd) ↳ [`TextAreaGroupProps`](#interfacestextareagrouppropsmd) ### Table of contents #### Properties - [input](#input) - [meta](#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](#readmemd) / [Exports](#modulesmd) / InputGroupProps ## Interface: InputGroupProps ### Type parameters | Name | | :------ | | `TValue` | ### Hierarchy - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue`\> - `Omit`<`React.HTMLProps`<`HTMLInputElement`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"`` \| ``"className"`` \| ``"label"`` \| ``"value"``\> - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"``\> ↳ **`InputGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [icon](#icon) - [input](#input) - [label](#label) - [meta](#meta) - [onChange](#onchange) - [value](#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](#interfacesinjectedfieldpropsmd).[input](#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](#interfacesinjectedfieldpropsmd).[meta](#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](#readmemd) / [Exports](#modulesmd) / MoneyInputGroupProps ## Interface: MoneyInputGroupProps ### Hierarchy - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`number` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\> ↳ **`MoneyInputGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [icon](#icon) - [input](#input) - [label](#label) - [meta](#meta) - [parseFunc](#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](#readmemd) / [Exports](#modulesmd) / MultiNumberSelectGroupProps ## Interface: MultiNumberSelectGroupProps ### Hierarchy - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`number`[] \| `undefined` \| ``null``\> ↳ **`MultiNumberSelectGroupProps`** ### Table of contents #### Properties - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [options](#options) - [placeholder](#placeholder) - [required](#required) ### Properties #### className • `Optional` **className**: `string` Extra class names to apply. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname) ##### Defined in packages/envoc-form/src/Group.tsx:8 ___ #### disabled • `Optional` **disabled**: `boolean` Whether the field should be disabled. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled) ##### Defined in packages/envoc-form/src/Group.tsx:19 ___ #### helpText • `Optional` **helpText**: `ReactNode` Simple helper text after the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext) ##### Defined in packages/envoc-form/src/Group.tsx:16 ___ #### input • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `number`[]\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:6 ___ #### label • `Optional` **label**: `string` Simple text label before the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label) ##### Defined in packages/envoc-form/src/Group.tsx:13 ___ #### meta • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `number`[]\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 ___ #### options • **options**: [`SelectOption`](#interfacesselectoptionmd)<`undefined` \| ``null`` \| `number`[]\>[] \| `OptionsUseServiceResult`<`undefined` \| ``null`` \| `number`[]\> Options for the dropdown. Includes the label and value. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#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](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder) ##### Defined in packages/envoc-form/src/Select/SelectGroup.tsx:38 ___ #### required • `Optional` **required**: `boolean` ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required) ##### Defined in packages/envoc-form/src/Group.tsx:21 [envoc-form](#readmemd) / [Exports](#modulesmd) / MultiStringSelectGroupProps ## Interface: MultiStringSelectGroupProps ### Hierarchy - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`string`[]\> ↳ **`MultiStringSelectGroupProps`** ### Table of contents #### Properties - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [options](#options) - [placeholder](#placeholder) - [required](#required) ### Properties #### className • `Optional` **className**: `string` Extra class names to apply. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname) ##### Defined in packages/envoc-form/src/Group.tsx:8 ___ #### disabled • `Optional` **disabled**: `boolean` Whether the field should be disabled. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled) ##### Defined in packages/envoc-form/src/Group.tsx:19 ___ #### helpText • `Optional` **helpText**: `ReactNode` Simple helper text after the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext) ##### Defined in packages/envoc-form/src/Group.tsx:16 ___ #### input • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`[]\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:6 ___ #### label • `Optional` **label**: `string` Simple text label before the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label) ##### Defined in packages/envoc-form/src/Group.tsx:13 ___ #### meta • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`[]\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 ___ #### options • **options**: [`SelectOption`](#interfacesselectoptionmd)<`string`[]\>[] \| `OptionsUseServiceResult`<`string`[]\> Options for the dropdown. Includes the label and value. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#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](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder) ##### Defined in packages/envoc-form/src/Select/SelectGroup.tsx:38 ___ #### required • `Optional` **required**: `boolean` ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required) ##### Defined in packages/envoc-form/src/Group.tsx:21 [envoc-form](#readmemd) / [Exports](#modulesmd) / NormalizationFunction ## Interface: NormalizationFunction ### 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](#readmemd) / [Exports](#modulesmd) / NumberInputGroupProps ## Interface: NumberInputGroupProps ### Hierarchy - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`number` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\> ↳ **`NumberInputGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [icon](#icon) - [input](#input) - [label](#label) - [meta](#meta) - [parseFunc](#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](#readmemd) / [Exports](#modulesmd) / ObjectToFormDataCfgProps ## Interface: ObjectToFormDataCfgProps ### Table of contents #### Properties - [allowEmptyArrays](#allowemptyarrays) - [booleansAsIntegers](#booleansasintegers) - [dotNotation](#dotnotation) - [indices](#indices) - [noFileListBrackets](#nofilelistbrackets) - [nullsAsUndefineds](#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](#readmemd) / [Exports](#modulesmd) / PhoneNumberInputGroupProps ## Interface: PhoneNumberInputGroupProps ### Hierarchy - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`string` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\> ↳ **`PhoneNumberInputGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [icon](#icon) - [input](#input) - [label](#label) - [meta](#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](#readmemd) / [Exports](#modulesmd) / SelectGroupProps ## Interface: SelectGroupProps ### Type parameters | Name | | :------ | | `TValue` | ### Hierarchy - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue` \| `undefined` \| ``null``\> - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), ``"input"`` \| ``"meta"`` \| ``"children"``\> ↳ **`SelectGroupProps`** ### Table of contents #### Properties - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [multiple](#multiple) - [options](#options) - [placeholder](#placeholder) - [required](#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](#interfacesinjectedfieldpropsmd).[input](#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](#interfacesinjectedfieldpropsmd).[meta](#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**: [`SelectOption`](#interfacesselectoptionmd)<`TValue`\>[] \| `OptionsUseServiceResult`<`TValue`\> Options for the dropdown. Includes the label and value. ##### Defined in packages/envoc-form/src/Select/SelectGroup.tsx:34 ___ #### placeholder • `Optional` **placeholder**: `string` Text diplayed when no value is selected. ##### Defined in packages/envoc-form/src/Select/SelectGroup.tsx:38 ___ #### required • `Optional` **required**: `boolean` ##### Inherited from Omit.required ##### Defined in packages/envoc-form/src/Group.tsx:21 [envoc-form](#readmemd) / [Exports](#modulesmd) / SelectGroupPropsHelper ## Interface: SelectGroupPropsHelper ### Type parameters | Name | | :------ | | `T` | ### Hierarchy - `Omit`<[`SelectGroupProps`](#interfacesselectgrouppropsmd)<`T`\>, ``"multiple"``\> ↳ **`SelectGroupPropsHelper`** ↳↳ [`MultiNumberSelectGroupProps`](#interfacesmultinumberselectgrouppropsmd) ↳↳ [`SingleNumberSelectGroupProps`](#interfacessinglenumberselectgrouppropsmd) ↳↳ [`MultiStringSelectGroupProps`](#interfacesmultistringselectgrouppropsmd) ↳↳ [`SingleStringSelectGroupProps`](#interfacessinglestringselectgrouppropsmd) ### Table of contents #### Properties - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [options](#options) - [placeholder](#placeholder) - [required](#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**: [`SelectOption`](#interfacesselectoptionmd)<`T`\>[] \| `OptionsUseServiceResult`<`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](#readmemd) / [Exports](#modulesmd) / SelectOption ## Interface: SelectOption ### Type parameters | Name | | :------ | | `TValue` | ### Table of contents #### Properties - [label](#label) - [value](#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](#readmemd) / [Exports](#modulesmd) / ServerErrorContextProps ## Interface: ServerErrorContextProps ### Table of contents #### Properties - [errors](#errors) #### Methods - [getError](#geterror) - [setError](#seterror) ### Properties #### errors • **errors**: [`ServerErrors`](#interfacesservererrorsmd) ##### Defined in packages/envoc-form/src/Form/ServerErrorContext.ts:7 ### Methods #### getError ▸ **getError**(`path`): `undefined` \| `string` ##### Parameters | Name | Type | | :------ | :------ | | `path` | `string` | ##### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Form/ServerErrorContext.ts:8 ___ #### setError ▸ **setError**(`path`, `errorMessage`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `path` | `string` | | `errorMessage` | `undefined` \| `string` | ##### Returns `void` ##### Defined in packages/envoc-form/src/Form/ServerErrorContext.ts:9 [envoc-form](#readmemd) / [Exports](#modulesmd) / ServerErrors ## Interface: ServerErrors ### Indexable ▪ [path: `string`]: `string` [envoc-form](#readmemd) / [Exports](#modulesmd) / SingleNumberSelectGroupProps ## Interface: SingleNumberSelectGroupProps ### Hierarchy - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`number` \| `undefined` \| ``null``\> ↳ **`SingleNumberSelectGroupProps`** ### Table of contents #### Properties - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [options](#options) - [placeholder](#placeholder) - [required](#required) ### Properties #### className • `Optional` **className**: `string` Extra class names to apply. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname) ##### Defined in packages/envoc-form/src/Group.tsx:8 ___ #### disabled • `Optional` **disabled**: `boolean` Whether the field should be disabled. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled) ##### Defined in packages/envoc-form/src/Group.tsx:19 ___ #### helpText • `Optional` **helpText**: `ReactNode` Simple helper text after the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext) ##### Defined in packages/envoc-form/src/Group.tsx:16 ___ #### input • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `number`\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:6 ___ #### label • `Optional` **label**: `string` Simple text label before the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label) ##### Defined in packages/envoc-form/src/Group.tsx:13 ___ #### meta • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `number`\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 ___ #### options • **options**: [`SelectOption`](#interfacesselectoptionmd)<`undefined` \| ``null`` \| `number`\>[] \| `OptionsUseServiceResult`<`undefined` \| ``null`` \| `number`\> Options for the dropdown. Includes the label and value. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#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](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder) ##### Defined in packages/envoc-form/src/Select/SelectGroup.tsx:38 ___ #### required • `Optional` **required**: `boolean` ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required) ##### Defined in packages/envoc-form/src/Group.tsx:21 [envoc-form](#readmemd) / [Exports](#modulesmd) / SingleStringSelectGroupProps ## Interface: SingleStringSelectGroupProps ### Hierarchy - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`string`\> ↳ **`SingleStringSelectGroupProps`** ### Table of contents #### Properties - [className](#classname) - [disabled](#disabled) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) - [options](#options) - [placeholder](#placeholder) - [required](#required) ### Properties #### className • `Optional` **className**: `string` Extra class names to apply. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname) ##### Defined in packages/envoc-form/src/Group.tsx:8 ___ #### disabled • `Optional` **disabled**: `boolean` Whether the field should be disabled. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled) ##### Defined in packages/envoc-form/src/Group.tsx:19 ___ #### helpText • `Optional` **helpText**: `ReactNode` Simple helper text after the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext) ##### Defined in packages/envoc-form/src/Group.tsx:16 ___ #### input • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:6 ___ #### label • `Optional` **label**: `string` Simple text label before the input. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label) ##### Defined in packages/envoc-form/src/Group.tsx:13 ___ #### meta • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 ___ #### options • **options**: [`SelectOption`](#interfacesselectoptionmd)<`string`\>[] \| `OptionsUseServiceResult`<`string`\> Options for the dropdown. Includes the label and value. ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#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](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder) ##### Defined in packages/envoc-form/src/Select/SelectGroup.tsx:38 ___ #### required • `Optional` **required**: `boolean` ##### Inherited from [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required) ##### Defined in packages/envoc-form/src/Group.tsx:21 [envoc-form](#readmemd) / [Exports](#modulesmd) / StandardFormActionsProps ## Interface: StandardFormActionsProps ### Table of contents #### Properties - [allowPristineSubmit](#allowpristinesubmit) - [handleCancel](#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`. **`defaultvalue`** `window.history.back()` ##### Defined in packages/envoc-form/src/StandardFormActions.tsx:13 [envoc-form](#readmemd) / [Exports](#modulesmd) / StringDateOnlyPickerGroupProps ## Interface: StringDateOnlyPickerGroupProps ### Hierarchy - [`DatePickerHelper`](#interfacesdatepickerhelpermd)<`string` \| `undefined` \| ``null``\> ↳ **`StringDateOnlyPickerGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) ### Properties #### className • `Optional` **className**: `string` Extra class names to apply. ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[className](#classname) ##### Defined in packages/envoc-form/src/Group.tsx:8 ___ #### helpText • `Optional` **helpText**: `ReactNode` Simple helper text after the input. ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[helpText](#helptext) ##### Defined in packages/envoc-form/src/Group.tsx:16 ___ #### input • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[input](#input) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:6 ___ #### label • `Optional` **label**: `string` Simple text label before the input. ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[label](#label) ##### Defined in packages/envoc-form/src/Group.tsx:13 ___ #### meta • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[meta](#meta) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 [envoc-form](#readmemd) / [Exports](#modulesmd) / StringDatePickerGroupProps ## Interface: StringDatePickerGroupProps ### Hierarchy - [`DatePickerHelper`](#interfacesdatepickerhelpermd)<`string` \| `undefined` \| ``null``\> ↳ **`StringDatePickerGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) ### Properties #### className • `Optional` **className**: `string` Extra class names to apply. ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[className](#classname) ##### Defined in packages/envoc-form/src/Group.tsx:8 ___ #### helpText • `Optional` **helpText**: `ReactNode` Simple helper text after the input. ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[helpText](#helptext) ##### Defined in packages/envoc-form/src/Group.tsx:16 ___ #### input • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[input](#input) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:6 ___ #### label • `Optional` **label**: `string` Simple text label before the input. ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[label](#label) ##### Defined in packages/envoc-form/src/Group.tsx:13 ___ #### meta • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from [DatePickerHelper](#interfacesdatepickerhelpermd).[meta](#meta) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 [envoc-form](#readmemd) / [Exports](#modulesmd) / StringDateTimePickerGroupProps ## Interface: StringDateTimePickerGroupProps ### Hierarchy - `DateTimePickerHelper`<`string` \| `undefined` \| ``null``\> ↳ **`StringDateTimePickerGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [input](#input) - [label](#label) - [meta](#meta) #### Methods - [onAbort](#onabort) - [onAnimationEnd](#onanimationend) - [onAnimationIteration](#onanimationiteration) - [onAnimationStart](#onanimationstart) - [onBlur](#onblur) - [onCanPlay](#oncanplay) - [onCanPlayThrough](#oncanplaythrough) - [onClick](#onclick) - [onCompositionEnd](#oncompositionend) - [onCompositionStart](#oncompositionstart) - [onCompositionUpdate](#oncompositionupdate) - [onContextMenu](#oncontextmenu) - [onCopy](#oncopy) - [onCut](#oncut) - [onDoubleClick](#ondoubleclick) - [onDrag](#ondrag) - [onDragEnd](#ondragend) - [onDragEnter](#ondragenter) - [onDragExit](#ondragexit) - [onDragLeave](#ondragleave) - [onDragOver](#ondragover) - [onDragStart](#ondragstart) - [onDrop](#ondrop) - [onDurationChange](#ondurationchange) - [onEmptied](#onemptied) - [onEncrypted](#onencrypted) - [onEnded](#onended) - [onError](#onerror) - [onGotPointerCapture](#ongotpointercapture) - [onInput](#oninput) - [onInvalid](#oninvalid) - [onKeyDown](#onkeydown) - [onKeyPress](#onkeypress) - [onKeyUp](#onkeyup) - [onLoad](#onload) - [onLoadStart](#onloadstart) - [onLoadedData](#onloadeddata) - [onLoadedMetadata](#onloadedmetadata) - [onLostPointerCapture](#onlostpointercapture) - [onMouseDown](#onmousedown) - [onMouseEnter](#onmouseenter) - [onMouseLeave](#onmouseleave) - [onMouseMove](#onmousemove) - [onMouseOut](#onmouseout) - [onMouseOver](#onmouseover) - [onMouseUp](#onmouseup) - [onPaste](#onpaste) - [onPause](#onpause) - [onPlay](#onplay) - [onPlaying](#onplaying) - [onPointerCancel](#onpointercancel) - [onPointerDown](#onpointerdown) - [onPointerEnter](#onpointerenter) - [onPointerLeave](#onpointerleave) - [onPointerMove](#onpointermove) - [onPointerOut](#onpointerout) - [onPointerOver](#onpointerover) - [onPointerUp](#onpointerup) - [onProgress](#onprogress) - [onRateChange](#onratechange) - [onReset](#onreset) - [onScroll](#onscroll) - [onSeeked](#onseeked) - [onSeeking](#onseeking) - [onSelect](#onselect) - [onStalled](#onstalled) - [onSubmit](#onsubmit) - [onSuspend](#onsuspend) - [onTimeUpdate](#ontimeupdate) - [onToggle](#ontoggle) - [onTouchCancel](#ontouchcancel) - [onTouchEnd](#ontouchend) - [onTouchMove](#ontouchmove) - [onTouchStart](#ontouchstart) - [onTransitionEnd](#ontransitionend) - [onVolumeChange](#onvolumechange) - [onWaiting](#onwaiting) - [onWheel](#onwheel) ### Properties #### className • `Optional` **className**: `string` Extra class names to apply. ##### Inherited from DateTimePickerHelper.className ##### Defined in packages/envoc-form/src/Group.tsx:8 ___ #### helpText • `Optional` **helpText**: `ReactNode` Simple helper text after the input. ##### Inherited from DateTimePickerHelper.helpText ##### Defined in packages/envoc-form/src/Group.tsx:16 ___ #### input • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from DateTimePickerHelper.input ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:6 ___ #### label • `Optional` **label**: `string` Simple text label before the input. ##### Inherited from DateTimePickerHelper.label ##### Defined in packages/envoc-form/src/Group.tsx:13 ___ #### meta • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\> ##### Inherited from DateTimePickerHelper.meta ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 ### Methods #### onAbort ▸ **onAbort**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onAbort ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onAnimationEnd ▸ **onAnimationEnd**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onAnimationEnd ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onAnimationIteration ▸ **onAnimationIteration**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onAnimationIteration ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onAnimationStart ▸ **onAnimationStart**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onAnimationStart ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onBlur ▸ **onBlur**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onBlur ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCanPlay ▸ **onCanPlay**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onCanPlay ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCanPlayThrough ▸ **onCanPlayThrough**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onCanPlayThrough ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onClick ▸ **onClick**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onClick ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCompositionEnd ▸ **onCompositionEnd**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onCompositionEnd ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCompositionStart ▸ **onCompositionStart**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onCompositionStart ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCompositionUpdate ▸ **onCompositionUpdate**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onCompositionUpdate ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onContextMenu ▸ **onContextMenu**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onContextMenu ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCopy ▸ **onCopy**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onCopy ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onCut ▸ **onCut**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onCut ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDoubleClick ▸ **onDoubleClick**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDoubleClick ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDrag ▸ **onDrag**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDrag ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDragEnd ▸ **onDragEnd**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDragEnd ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDragEnter ▸ **onDragEnter**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDragEnter ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDragExit ▸ **onDragExit**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDragExit ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDragLeave ▸ **onDragLeave**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDragLeave ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDragOver ▸ **onDragOver**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDragOver ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDragStart ▸ **onDragStart**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDragStart ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDrop ▸ **onDrop**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDrop ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onDurationChange ▸ **onDurationChange**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onDurationChange ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onEmptied ▸ **onEmptied**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onEmptied ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onEncrypted ▸ **onEncrypted**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onEncrypted ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onEnded ▸ **onEnded**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onEnded ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onError ▸ **onError**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onError ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onGotPointerCapture ▸ **onGotPointerCapture**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onGotPointerCapture ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onInput ▸ **onInput**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onInput ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onInvalid ▸ **onInvalid**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onInvalid ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onKeyDown ▸ **onKeyDown**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onKeyDown ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onKeyPress ▸ **onKeyPress**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onKeyPress ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onKeyUp ▸ **onKeyUp**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onKeyUp ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onLoad ▸ **onLoad**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onLoad ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onLoadStart ▸ **onLoadStart**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onLoadStart ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onLoadedData ▸ **onLoadedData**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onLoadedData ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onLoadedMetadata ▸ **onLoadedMetadata**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onLoadedMetadata ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onLostPointerCapture ▸ **onLostPointerCapture**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onLostPointerCapture ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseDown ▸ **onMouseDown**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onMouseDown ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseEnter ▸ **onMouseEnter**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onMouseEnter ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseLeave ▸ **onMouseLeave**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onMouseLeave ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseMove ▸ **onMouseMove**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onMouseMove ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseOut ▸ **onMouseOut**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onMouseOut ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseOver ▸ **onMouseOver**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onMouseOver ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onMouseUp ▸ **onMouseUp**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onMouseUp ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPaste ▸ **onPaste**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPaste ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPause ▸ **onPause**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPause ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPlay ▸ **onPlay**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPlay ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPlaying ▸ **onPlaying**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPlaying ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerCancel ▸ **onPointerCancel**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerCancel ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerDown ▸ **onPointerDown**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerDown ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerEnter ▸ **onPointerEnter**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerEnter ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerLeave ▸ **onPointerLeave**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerLeave ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerMove ▸ **onPointerMove**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerMove ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerOut ▸ **onPointerOut**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerOut ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerOver ▸ **onPointerOver**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerOver ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onPointerUp ▸ **onPointerUp**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onPointerUp ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onProgress ▸ **onProgress**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onProgress ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onRateChange ▸ **onRateChange**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onRateChange ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onReset ▸ **onReset**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onReset ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onScroll ▸ **onScroll**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onScroll ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onSeeked ▸ **onSeeked**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onSeeked ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onSeeking ▸ **onSeeking**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onSeeking ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onSelect ▸ **onSelect**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onSelect ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onStalled ▸ **onStalled**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onStalled ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onSubmit ▸ **onSubmit**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onSubmit ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onSuspend ▸ **onSuspend**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onSuspend ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onTimeUpdate ▸ **onTimeUpdate**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onTimeUpdate ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onToggle ▸ **onToggle**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onToggle ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onTouchCancel ▸ **onTouchCancel**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onTouchCancel ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onTouchEnd ▸ **onTouchEnd**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onTouchEnd ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onTouchMove ▸ **onTouchMove**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onTouchMove ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onTouchStart ▸ **onTouchStart**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onTouchStart ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onTransitionEnd ▸ **onTransitionEnd**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onTransitionEnd ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onVolumeChange ▸ **onVolumeChange**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onVolumeChange ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onWaiting ▸ **onWaiting**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onWaiting ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 ___ #### onWheel ▸ **onWheel**(`event`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `event` | `any` | ##### Returns `void` ##### Inherited from DateTimePickerHelper.onWheel ##### Defined in common/temp/node_modules/.pnpm/make-event-props@1.6.2/node_modules/make-event-props/dist/cjs/index.d.ts:22 [envoc-form](#readmemd) / [Exports](#modulesmd) / StringInputGroupProps ## Interface: StringInputGroupProps ### Hierarchy - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`string` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\> ↳ **`StringInputGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [icon](#icon) - [input](#input) - [label](#label) - [meta](#meta) - [type](#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**: ``"search"`` \| ``"color"`` \| ``"textarea"`` \| ``"text"`` \| ``"email"`` \| ``"tel"`` \| ``"url"`` \| ``"password"`` ##### Defined in packages/envoc-form/src/Input/StringInputGroup.tsx:11 [envoc-form](#readmemd) / [Exports](#modulesmd) / SubmitFormButtonProps ## Interface: SubmitFormButtonProps ### Hierarchy - `Omit`<`React.HTMLProps`<`HTMLButtonElement`\>, ``"type"``\> ↳ **`SubmitFormButtonProps`** ### Table of contents #### Properties - [allowPristineSubmit](#allowpristinesubmit) - [children](#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](#readmemd) / [Exports](#modulesmd) / TextAreaGroupProps ## Interface: TextAreaGroupProps ### Hierarchy - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`string` \| `undefined` \| ``null``\> - `Omit`<`React.HTMLProps`<`HTMLTextAreaElement`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"`` \| ``"className"`` \| ``"label"``\> - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"``\> ↳ **`TextAreaGroupProps`** ### Table of contents #### Properties - [className](#classname) - [helpText](#helptext) - [icon](#icon) - [input](#input) - [label](#label) - [meta](#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](#interfacesinjectedfieldpropsmd).[input](#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](#interfacesinjectedfieldpropsmd).[meta](#meta) ##### Defined in packages/envoc-form/src/Field/InjectedFieldProps.ts:7 [envoc-form](#readmemd) / [Exports](#modulesmd) / ValidatedApiResult ## Interface: ValidatedApiResult The root result from a typical envoc API call when forms are returned ### Table of contents #### Properties - [hasErrors](#haserrors) - [validationFailures](#validationfailures) ### Properties #### hasErrors • `Optional` **hasErrors**: `boolean` ##### Defined in packages/envoc-form/src/Validation/ValidatedApiResult.ts:7 ___ #### validationFailures • `Optional` **validationFailures**: [`ValidationError`](#interfacesvalidationerrormd)[] ##### Defined in packages/envoc-form/src/Validation/ValidatedApiResult.ts:6 [envoc-form](#readmemd) / [Exports](#modulesmd) / ValidationError ## Interface: ValidationError Represents a server side validation failure - only 'standard' for envoc ### Table of contents #### Properties - [errorMessage](#errormessage) - [propertyName](#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](#readmemd) / [Exports](#modulesmd) / ValidationFunction ## Interface: ValidationFunction ### Type parameters | Name | | :------ | | `TValue` | ### Callable #### ValidationFunction ▸ **ValidationFunction**(`value`): `undefined` \| `string` Client side validation function ##### Parameters | Name | Type | | :------ | :------ | | `value` | `TValue` | ##### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/ValidationFunction.ts:3 [envoc-form](#readmemd) / [Exports](#modulesmd) / useStandardFieldProps ## Interface: useStandardFieldProps ### Type parameters | Name | | :------ | | `TValue` | ### Table of contents #### Properties - [disabled](#disabled) - [id](#id) - [name](#name) - [normalize](#normalize) - [validate](#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`](#interfacesnormalizationfunctionmd)<`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`](#interfacesvalidationfunctionmd)<`TValue`\> \| [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TValue`\>[] Function to validate the field. ##### Defined in packages/envoc-form/src/Field/useStandardField.ts:18 [envoc-form](#readmemd) / Exports # envoc-form ## Table of contents ### Namespaces - [Form](#modulesformmd) - [normalizers](#modulesnormalizersmd) - [validators](#modulesvalidatorsmd) ### Interfaces - [AddressInputProps](#interfacesaddressinputpropsmd) - [BooleanSelectGroupProps](#interfacesbooleanselectgrouppropsmd) - [ConfirmBaseFormProps](#interfacesconfirmbaseformpropsmd) - [ConfirmDeleteFormProps](#interfacesconfirmdeleteformpropsmd) - [DatePickerGroupProps](#interfacesdatepickergrouppropsmd) - [DatePickerHelper](#interfacesdatepickerhelpermd) - [DateTimePickerGroupProps](#interfacesdatetimepickergrouppropsmd) - [FileGroupProps](#interfacesfilegrouppropsmd) - [FormActionsProps](#interfacesformactionspropsmd) - [GroupProps](#interfacesgrouppropsmd) - [IconInputGroupProps](#interfacesiconinputgrouppropsmd) - [InjectedFieldProps](#interfacesinjectedfieldpropsmd) - [InputGroupProps](#interfacesinputgrouppropsmd) - [MoneyInputGroupProps](#interfacesmoneyinputgrouppropsmd) - [MultiNumberSelectGroupProps](#interfacesmultinumberselectgrouppropsmd) - [MultiStringSelectGroupProps](#interfacesmultistringselectgrouppropsmd) - [NormalizationFunction](#interfacesnormalizationfunctionmd) - [NumberInputGroupProps](#interfacesnumberinputgrouppropsmd) - [ObjectToFormDataCfgProps](#interfacesobjecttoformdatacfgpropsmd) - [PhoneNumberInputGroupProps](#interfacesphonenumberinputgrouppropsmd) - [SelectGroupProps](#interfacesselectgrouppropsmd) - [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd) - [SelectOption](#interfacesselectoptionmd) - [ServerErrorContextProps](#interfacesservererrorcontextpropsmd) - [ServerErrors](#interfacesservererrorsmd) - [SingleNumberSelectGroupProps](#interfacessinglenumberselectgrouppropsmd) - [SingleStringSelectGroupProps](#interfacessinglestringselectgrouppropsmd) - [StandardFormActionsProps](#interfacesstandardformactionspropsmd) - [StringDateOnlyPickerGroupProps](#interfacesstringdateonlypickergrouppropsmd) - [StringDatePickerGroupProps](#interfacesstringdatepickergrouppropsmd) - [StringDateTimePickerGroupProps](#interfacesstringdatetimepickergrouppropsmd) - [StringInputGroupProps](#interfacesstringinputgrouppropsmd) - [SubmitFormButtonProps](#interfacessubmitformbuttonpropsmd) - [TextAreaGroupProps](#interfacestextareagrouppropsmd) - [ValidatedApiResult](#interfacesvalidatedapiresultmd) - [ValidationError](#interfacesvalidationerrormd) - [ValidationFunction](#interfacesvalidationfunctionmd) - [useStandardFieldProps](#interfacesusestandardfieldpropsmd) ### Type aliases - [ArrayFormBuilderProp](#arrayformbuilderprop) - [FieldArrayProps](#fieldarrayprops) - [FieldProps](#fieldprops) - [FormBuilderProp](#formbuilderprop) - [FormProps](#formprops) - [RenderComponent](#rendercomponent) - [RenderComponentProps](#rendercomponentprops) - [StandAloneInputProps](#standaloneinputprops) ### Properties - [Field](#field) - [SubmitFormButton](#submitformbutton) ### Variables - [FieldNameContext](#fieldnamecontext) - [FileGroup](#filegroup) - [FormDefaults](#formdefaults) - [IconInputGroup](#iconinputgroup) - [MoneyInputGroup](#moneyinputgroup) - [NumberInputGroup](#numberinputgroup) - [PhoneNumberInputGroup](#phonenumberinputgroup) - [ServerErrorContext](#servererrorcontext) - [StringInputGroup](#stringinputgroup) - [TextAreaGroup](#textareagroup) ### Functions - [AddressInput](#addressinput) - [BooleanSelectGroup](#booleanselectgroup) - [ConfirmBaseForm](#confirmbaseform) - [ConfirmDeleteForm](#confirmdeleteform) - [DatePickerGroup](#datepickergroup) - [DateTimePickerGroup](#datetimepickergroup) - [FieldArray](#fieldarray) - [FieldErrorScrollTarget](#fielderrorscrolltarget) - [Form](#form) - [FormActions](#formactions) - [Group](#group) - [InputGroup](#inputgroup) - [MultiNumberSelectGroup](#multinumberselectgroup) - [MultiStringSelectGroup](#multistringselectgroup) - [SelectGroup](#selectgroup) - [SingleNumberSelectGroup](#singlenumberselectgroup) - [SingleStringSelectGroup](#singlestringselectgroup) - [StandAloneInput](#standaloneinput) - [StandardFormActions](#standardformactions) - [StringDateOnlyPickerGroup](#stringdateonlypickergroup) - [StringDatePickerGroup](#stringdatepickergroup) - [StringDateTimePickerGroup](#stringdatetimepickergroup) - [convertToTimeZoneInsensitiveISOString](#converttotimezoneinsensitiveisostring) - [isArray](#isarray) - [isBlob](#isblob) - [isBoolean](#isboolean) - [isDate](#isdate) - [isFile](#isfile) - [isNull](#isnull) - [isObject](#isobject) - [isUndefined](#isundefined) - [objectContainsNonSerializableProperty](#objectcontainsnonserializableproperty) - [serialize](#serialize) - [useStandardField](#usestandardfield) ## Type aliases ### ArrayFormBuilderProp Ƭ **ArrayFormBuilderProp**<`TValue`\>: `TValue` extends infer TForm[] \| `undefined` \| ``null`` ? `TForm` extends `object` ? { `Field`: (`props`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>) => `Element` ; `FieldArray`: (`props`: [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\>) => `Element` } : `never` : `never` #### Type parameters | Name | Type | | :------ | :------ | | `TValue` | extends `any`[] \| `undefined` \| ``null`` | #### Defined in packages/envoc-form/src/FieldArray/FieldArray.tsx:30 ___ ### FieldArrayProps Ƭ **FieldArrayProps**<`TForm`, `TProp`\>: `TForm`[`TProp`] extends `any`[] \| `undefined` \| ``null`` ? { `disabled?`: `boolean` ; `label?`: `string` ; `name`: `TProp` ; `validate?`: [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\> \| [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\>[] ; `children`: (`formBuilder`: [`ArrayFormBuilderProp`](#arrayformbuilderprop)<`any`[`any`]\>) => `Element` } : `never` #### Type parameters | Name | Type | | :------ | :------ | | `TForm` | extends `object` | | `TProp` | extends keyof `TForm` | #### Defined in packages/envoc-form/src/FieldArray/FieldArray.tsx:9 ___ ### FieldProps Ƭ **FieldProps**<`TForm`, `TProp`, `TRenderComponent`\>: { `Component`: [`RenderComponent`](#rendercomponent)<`TForm`[`TProp`], `TRenderComponent`\> ; `disabled?`: `boolean` ; `id?`: `string` ; `name`: `TProp` ; `normalize?`: [`NormalizationFunction`](#interfacesnormalizationfunctionmd)<`TForm`[`TProp`]\> ; `validate?`: [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\> \| [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\>[] } & `Omit`<[`RenderComponentProps`](#rendercomponentprops)<`TForm`[`TProp`], `TRenderComponent`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TForm`[`TProp`]\>\> A specific Field instance to be rendered by the given TRenderComponent or by whatever default is reasonable #### Type parameters | Name | Type | | :------ | :------ | | `TForm` | extends `object` | | `TProp` | extends keyof `TForm` | | `TRenderComponent` | extends `ElementType` | #### Defined in packages/envoc-form/src/Field/Field.tsx:32 ___ ### FormBuilderProp Ƭ **FormBuilderProp**<`TForm`\>: `Object` #### Type parameters | Name | Type | | :------ | :------ | | `TForm` | extends `object` | #### Type declaration | Name | Type | | :------ | :------ | | `Field` | (`props`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>) => `Element` | | `FieldArray` | (`props`: [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\>) => `Element` | #### Defined in packages/envoc-form/src/Form/Form.tsx:32 ___ ### FormProps Ƭ **FormProps**<`TForm`\>: `RequireAtLeastOne`<`FullFormProps`<`TForm`\>, ``"onSubmit"`` \| ``"onFormDataSubmit"``\> #### Type parameters | Name | Type | | :------ | :------ | | `TForm` | extends `object` | #### Defined in packages/envoc-form/src/Form/Form.tsx:72 ___ ### RenderComponent Ƭ **RenderComponent**<`TValue`, `TRenderComponent`\>: `Partial`<`ComponentProps`<`TRenderComponent`\>\> extends `Partial`<[`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue` \| `undefined` \| ``null``\>\> ? `TRenderComponent` : `never` #### Type parameters | Name | Type | | :------ | :------ | | `TValue` | `TValue` | | `TRenderComponent` | extends `ElementType` | #### Defined in packages/envoc-form/src/Field/Field.tsx:13 ___ ### RenderComponentProps Ƭ **RenderComponentProps**<`TValue`, `TRenderComponent`\>: `Partial`<`ComponentProps`<`TRenderComponent`\>\> extends `Partial`<[`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue` \| `undefined` \| ``null``\>\> ? `ComponentProps`<`TRenderComponent`\> : `never` #### Type parameters | Name | Type | | :------ | :------ | | `TValue` | `TValue` | | `TRenderComponent` | extends `ElementType` | #### Defined in packages/envoc-form/src/Field/Field.tsx:22 ___ ### StandAloneInputProps Ƭ **StandAloneInputProps**<`TValue`, `TRenderComponent`\>: { `Component`: [`RenderComponent`](#rendercomponent)<`TValue`, `TRenderComponent`\> ; `value`: `TValue` ; `onChange`: (`arg`: `TValue`) => `void` } & `Omit`<[`RenderComponentProps`](#rendercomponentprops)<`TValue`, `TRenderComponent`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue`\> \| ``"value"`` \| ``"onChange"`` \| ``"normalize"`` \| ``"validate"``\> #### Type parameters | Name | Type | | :------ | :------ | | `TValue` | `TValue` | | `TRenderComponent` | extends `ElementType` | #### Defined in packages/envoc-form/src/Field/StandAloneInput.tsx:8 ## Properties ### Field • **Field**: (`__namedParameters`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>, `ref`: `LegacyRef`<`any`\>) => `Element` #### Type declaration ▸ <`TForm`, `TProp`, `TRenderComponent`\>(`__namedParameters`, `ref`): `Element` Renders whatever Component is passed - injecting the formik values needed to finish wiring up that individual field. Should no Component be used then the default will be provided by the default lookup based on typeof(TForm[TProp]) ##### Type parameters | Name | Type | | :------ | :------ | | `TForm` | extends `object` | | `TProp` | extends `string` \| `number` \| `symbol` | | `TRenderComponent` | extends `ElementType`<`any`\> | ##### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\> | | `ref` | `LegacyRef`<`any`\> | ##### Returns `Element` ___ ### SubmitFormButton • **SubmitFormButton**: `FunctionComponent`<[`SubmitFormButtonProps`](#interfacessubmitformbuttonpropsmd)\> ## Variables ### FieldNameContext • `Const` **FieldNameContext**: `Context`<`undefined` \| `string`\> provides the full, qualified name of the current field name - including nested fields, path/dot delimited #### Defined in packages/envoc-form/src/Field/FieldNameContext.ts:4 ___ ### FileGroup • `Const` **FileGroup**: `ComponentType`<[`FileGroupProps`](#interfacesfilegrouppropsmd)\> File upload input group. #### Defined in packages/envoc-form/src/File/FileGroup.tsx:81 ___ ### FormDefaults • `Const` **FormDefaults**: `Object` `envoc-form-` CSS class prefix #### Type declaration | Name | Type | | :------ | :------ | | `cssClassPrefix` | `string` | #### Defined in packages/envoc-form/src/FormDefaults.ts:2 ___ ### IconInputGroup • `Const` **IconInputGroup**: `ComponentType`<[`IconInputGroupProps`](#interfacesiconinputgrouppropsmd)\> Input group with an icon. #### Defined in packages/envoc-form/src/Input/IconInputGroup.tsx:50 ___ ### MoneyInputGroup • `Const` **MoneyInputGroup**: `FunctionComponent`<[`MoneyInputGroupProps`](#interfacesmoneyinputgrouppropsmd)\> Input group for inputting money. #### Defined in packages/envoc-form/src/Input/MoneyInputGroup.tsx:46 ___ ### NumberInputGroup • `Const` **NumberInputGroup**: `ComponentType`<[`NumberInputGroupProps`](#interfacesnumberinputgrouppropsmd)\> Standard number input group. By default allows for float values. #### Defined in packages/envoc-form/src/Input/NumberInputGroup.tsx:44 ___ ### PhoneNumberInputGroup • `Const` **PhoneNumberInputGroup**: `ComponentType`<[`PhoneNumberInputGroupProps`](#interfacesphonenumberinputgrouppropsmd)\> A standard phone number input. Will display to the user in `+XXX XXX-XXX-XXXX` format as the number is being inputted. The data will get sent in the same format as displayed. Uses `normalizers.phoneNumber`. **`default`** autoComplete="tel-national" #### Defined in packages/envoc-form/src/Input/PhoneNumberInputGroup.tsx:45 ___ ### ServerErrorContext • `Const` **ServerErrorContext**: `Context`<[`ServerErrorContextProps`](#interfacesservererrorcontextpropsmd)\> Context to store the API errors from the server for the form. #### Defined in packages/envoc-form/src/Form/ServerErrorContext.ts:12 ___ ### StringInputGroup • `Const` **StringInputGroup**: `ComponentType`<[`StringInputGroupProps`](#interfacesstringinputgrouppropsmd)\> Standard string input group. #### Defined in packages/envoc-form/src/Input/StringInputGroup.tsx:49 ___ ### TextAreaGroup • `Const` **TextAreaGroup**: `ComponentType`<[`TextAreaGroupProps`](#interfacestextareagrouppropsmd)\> Generic controlled `` wrapped by a `<Group/>` #### Defined in packages/envoc-form/src/TextArea/TextAreaGroup.tsx:60 ## Functions ### AddressInput ▸ **AddressInput**(`__namedParameters`): `Element` Collection of `<Field/>`s for inputting an address. Includes: ```txt Address 1 Address 2 City State Zip ``` #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`AddressInputProps`](#interfacesaddressinputpropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/AddressInput/AddressInput.tsx:36 ___ ### BooleanSelectGroup ▸ **BooleanSelectGroup**(`props`): `Element` A `<SelectGroup/>` dropdown with two options. Default options are 'Yes' and 'No' with values of `true` and `false`. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`BooleanSelectGroupProps`](#interfacesbooleanselectgrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/Select/BooleanSelectGroup.tsx:20 ___ ### ConfirmBaseForm ▸ **ConfirmBaseForm**(`__namedParameters`): `Element` Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action. Commonly used for confirming delete and archive. See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion. #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`ConfirmBaseFormProps`](#interfacesconfirmbaseformpropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:33 ___ ### ConfirmDeleteForm ▸ **ConfirmDeleteForm**(`__namedParameters`): `Element` Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action. Wraps `<ConfirmBaseForm/>`. #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`ConfirmDeleteFormProps`](#interfacesconfirmdeleteformpropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:33 ___ ### DatePickerGroup ▸ **DatePickerGroup**<`T`\>(`__namedParameters`): `Element` Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`. Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker) #### Type parameters | Name | | :------ | | `T` | #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`DatePickerGroupProps`](#interfacesdatepickergrouppropsmd)<`T`\> | #### Returns `Element` #### Defined in packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:26 ___ ### DateTimePickerGroup ▸ **DateTimePickerGroup**<`T`\>(`__namedParameters`): `Element` Field for inputting date and time. Uses `<Group/>` and `<DateTimePicker/>`. Uses [react-datetime-picker](https://www.npmjs.com/package/react-datetime-picker) #### Type parameters | Name | | :------ | | `T` | #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`DateTimePickerGroupProps`](#interfacesdatetimepickergrouppropsmd)<`T`\> | #### Returns `Element` #### Defined in packages/envoc-form/src/DateTimePicker/DateTimePickerGroup.tsx:31 ___ ### FieldArray ▸ **FieldArray**<`TForm`, `TProp`\>(`__namedParameters`): `Element` An array of fields that allows the user to add multiple instances of the same field. Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields. #### Type parameters | Name | Type | | :------ | :------ | | `TForm` | extends `object` | | `TProp` | extends `string` \| `number` \| `symbol` | #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\> | #### Returns `Element` #### Defined in packages/envoc-form/src/FieldArray/FieldArray.tsx:53 ___ ### FieldErrorScrollTarget ▸ **FieldErrorScrollTarget**(): ``null`` \| `Element` Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. #### Returns ``null`` \| `Element` #### Defined in packages/envoc-form/src/Field/FieldErrorScrollTarget.tsx:5 ___ ### Form ▸ **Form**<`TForm`\>(`__namedParameters`): `Element` Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. #### Type parameters | Name | Type | | :------ | :------ | | `TForm` | extends `object` | #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`FormProps`](#formprops)<`TForm`\> | #### Returns `Element` #### Defined in packages/envoc-form/src/Form/Form.tsx:78 ___ ### FormActions ▸ **FormActions**(`__namedParameters`): `Element` Standard cancel and submit buttons. #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`FormActionsProps`](#interfacesformactionspropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/FormActions.tsx:17 ___ ### Group ▸ **Group**(`__namedParameters`): `Element` Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`GroupProps`](#interfacesgrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/Group.tsx:25 ___ ### InputGroup ▸ `Const` **InputGroup**<`TValue`\>(`__namedParameters`, `ref`): `Element` Generic controlled `<input/>` wrapped by a `<Group/>` #### Type parameters | Name | | :------ | | `TValue` | #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`InputGroupProps`](#interfacesinputgrouppropsmd)<`TValue`\> | | `ref` | `LegacyRef`<`HTMLInputElement`\> | #### Returns `Element` #### Defined in packages/envoc-form/src/Input/InputGroup.tsx:70 ___ ### MultiNumberSelectGroup ▸ **MultiNumberSelectGroup**(`props`): `Element` A `<SelectGroup/>` dropdown with values as numbers. Many options can be selected at a time. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`MultiNumberSelectGroupProps`](#interfacesmultinumberselectgrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/Select/NumberSelectGroup.tsx:7 ___ ### MultiStringSelectGroup ▸ **MultiStringSelectGroup**(`props`): `Element` A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`MultiStringSelectGroupProps`](#interfacesmultistringselectgrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/Select/StringSelectGroup.tsx:7 ___ ### SelectGroup ▸ **SelectGroup**<`TValue`\>(`__namedParameters`): `Element` Generic select dropdown. Uses [react-select](https://react-select.com/home). #### Type parameters | Name | | :------ | | `TValue` | #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`SelectGroupProps`](#interfacesselectgrouppropsmd)<`TValue`\> | #### Returns `Element` #### Defined in packages/envoc-form/src/Select/SelectGroup.tsx:43 ___ ### SingleNumberSelectGroup ▸ **SingleNumberSelectGroup**(`props`): `Element` A `<SelectGroup/>` dropdown with values as numbers. Only one option can be selected at a time. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`SingleNumberSelectGroupProps`](#interfacessinglenumberselectgrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/Select/NumberSelectGroup.tsx:14 ___ ### SingleStringSelectGroup ▸ **SingleStringSelectGroup**(`props`): `Element` A `<SelectGroup/>` dropdown with the value as a string. Only one option can be selected at a time. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`SingleStringSelectGroupProps`](#interfacessinglestringselectgrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/Select/StringSelectGroup.tsx:14 ___ ### StandAloneInput ▸ **StandAloneInput**<`TValue`, `TComponent`\>(`props`): `Element` The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. #### Type parameters | Name | Type | | :------ | :------ | | `TValue` | `TValue` | | `TComponent` | extends `ElementType`<`any`\> | #### Parameters | Name | Type | | :------ | :------ | | `props` | [`StandAloneInputProps`](#standaloneinputprops)<`TValue`, `TComponent`\> | #### Returns `Element` #### Defined in packages/envoc-form/src/Field/StandAloneInput.tsx:28 ___ ### StandardFormActions ▸ **StandardFormActions**(`__namedParameters`): `Element` Standard submit and cancel buttons. #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`StandardFormActionsProps`](#interfacesstandardformactionspropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/StandardFormActions.tsx:17 ___ ### StringDateOnlyPickerGroup ▸ **StringDateOnlyPickerGroup**(`props`): `Element` Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DD`. Default display to the user is in `MM/DD/YYYY` format. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`StringDateOnlyPickerGroupProps`](#interfacesstringdateonlypickergrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/DatePicker/StringDateOnlyPickerGroup.tsx:12 ___ ### StringDatePickerGroup ▸ **StringDatePickerGroup**(`props`): `Element` Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ` If you need `YYYY-MM-DD` format use `<StringDateOnlyPickerGroup/>`. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`StringDatePickerGroupProps`](#interfacesstringdatepickergrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/DatePicker/StringDatePickerGroup.tsx:12 ___ ### StringDateTimePickerGroup ▸ **StringDateTimePickerGroup**(`props`): `Element` Date Time picker input that consumes JS Date object and outputs as a date time offset string in ISO format `YYYY-MM-DDTHH:mm:ss.sss±hh:mm`. Default display to the user is in `MM/DD/YYYY HH:mm:ss AM/PM` format. #### Parameters | Name | Type | | :------ | :------ | | `props` | [`StringDateTimePickerGroupProps`](#interfacesstringdatetimepickergrouppropsmd) | #### Returns `Element` #### Defined in packages/envoc-form/src/DateTimePicker/StringDateTimePickerGroup.tsx:12 ___ ### convertToTimeZoneInsensitiveISOString ▸ **convertToTimeZoneInsensitiveISOString**(`date`): `string` #### Parameters | Name | Type | | :------ | :------ | | `date` | `Date` | #### Returns `string` #### Defined in packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:118 ___ ### isArray ▸ `Const` **isArray**(`value`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `boolean` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:5 ___ ### isBlob ▸ `Const` **isBlob**(`value`): `any` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `any` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:8 ___ ### isBoolean ▸ `Const` **isBoolean**(`value`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `boolean` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:3 ___ ### isDate ▸ `Const` **isDate**(`value`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `boolean` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:6 ___ ### isFile ▸ `Const` **isFile**(`value`): `any` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `any` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:14 ___ ### isNull ▸ `Const` **isNull**(`value`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `boolean` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:2 ___ ### isObject ▸ `Const` **isObject**(`value`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `boolean` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:4 ___ ### isUndefined ▸ `Const` **isUndefined**(`value`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `boolean` #### Defined in packages/envoc-form/src/utils/typeChecks.ts:1 ___ ### objectContainsNonSerializableProperty ▸ **objectContainsNonSerializableProperty**(`object`): `boolean` #### Parameters | Name | Type | | :------ | :------ | | `object` | `any` | #### Returns `boolean` #### Defined in packages/envoc-form/src/utils/objectContainsNonSerializableProperty.ts:3 ___ ### serialize ▸ `Const` **serialize**(`obj`, `cfg`, `fd?`, `pre?`): `FormData` #### Parameters | Name | Type | | :------ | :------ | | `obj` | `any` | | `cfg` | [`ObjectToFormDataCfgProps`](#interfacesobjecttoformdatacfgpropsmd) | | `fd?` | `FormData` | | `pre?` | `string` | #### Returns `FormData` #### Defined in packages/envoc-form/src/utils/objectToFormData.ts:25 ___ ### useStandardField ▸ **useStandardField**<`TValue`\>(`__namedParameters`): [`CustomFieldInputProps`<`TValue`\>, `CustomFieldMetaProps`<`TValue`\>] Provides a consistent way to deal with all form fields (non array). #### Type parameters | Name | | :------ | | `TValue` | #### Parameters | Name | Type | | :------ | :------ | | `__namedParameters` | [`useStandardFieldProps`](#interfacesusestandardfieldpropsmd)<`TValue`\> | #### Returns [`CustomFieldInputProps`<`TValue`\>, `CustomFieldMetaProps`<`TValue`\>] #### Defined in packages/envoc-form/src/Field/useStandardField.ts:24 # Modules <a name="modulesformmd"></a> [envoc-form](#readmemd) / [Exports](#modulesmd) / Form ## Namespace: Form ### Table of contents #### Variables - [DisplayFormState](#displayformstate) ### Variables #### DisplayFormState • **DisplayFormState**: () => `Element` ##### Type declaration ▸ (): `Element` ###### Returns `Element` <a name="modulesnormalizersmd"></a> [envoc-form](#readmemd) / [Exports](#modulesmd) / normalizers ## Namespace: normalizers ### Table of contents #### Functions - [phoneNumber](#phonenumber) - [zipCode](#zipcode) ### Functions #### phoneNumber ▸ `Const` **phoneNumber**(`value`): `undefined` \| `string` Normalizer for converting a string into a valid phone number. ##### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| `string` | ##### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Normalization/normalizers.ts:2 ___ #### zipCode ▸ `Const` **zipCode**(`value`): `undefined` \| `string` Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format. ##### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| `string` | ##### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Normalization/normalizers.ts:35 <a name="modulesvalidatorsmd"></a> [envoc-form](#readmemd) / [Exports](#modulesmd) / validators ## Namespace: validators ### Table of contents #### Functions - [any](#any) - [integer](#integer) - [length](#length) - [maxCount](#maxcount) - [maxLength](#maxlength) - [maxValue](#maxvalue) - [minCount](#mincount) - [minValue](#minvalue) - [required](#required) - [zipCode](#zipcode) ### Functions #### any ▸ `Const` **any**<`TValue`\>(`validatorList`): (`value`: `TValue`) => `undefined` \| `string` One of the validators provided must be true. ##### Type parameters | Name | | :------ | | `TValue` | ##### Parameters | Name | Type | | :------ | :------ | | `validatorList` | [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TValue`\>[] | ##### Returns `fn` ▸ (`value`): `undefined` \| `string` ###### Parameters | Name | Type | | :------ | :------ | | `value` | `TValue` | ###### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/validators.ts:65 ___ #### integer ▸ `Const` **integer**(`val`): `undefined` \| ``"Must be a whole number"`` ##### Parameters | Name | Type | | :------ | :------ | | `val` | `undefined` \| ``null`` \| `string` \| `number` | ##### Returns `undefined` \| ``"Must be a whole number"`` ##### Defined in packages/envoc-form/src/Validation/validators.ts:19 ___ #### length ▸ `Const` **length**(`len`): (`value`: `undefined` \| ``null`` \| `string` \| `number`) => `undefined` \| `string` Asserts that the value is a certain number of characters. numbers are coerced to a string ##### Parameters | Name | Type | | :------ | :------ | | `len` | `number` | ##### Returns `fn` ▸ (`value`): `undefined` \| `string` ###### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| `string` \| `number` | ###### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/validators.ts:13 ___ #### maxCount ▸ `Const` **maxCount**(`count`): (`value`: `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[]) => `undefined` \| `string` ##### Parameters | Name | Type | | :------ | :------ | | `count` | `number` | ##### Returns `fn` ▸ (`value`): `undefined` \| `string` ###### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[] | ###### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/validators.ts:34 ___ #### maxLength ▸ `Const` **maxLength**(`len`): (`value`: `undefined` \| ``null`` \| `string` \| `number`) => `undefined` \| `string` ##### Parameters | Name | Type | | :------ | :------ | | `len` | `number` | ##### Returns `fn` ▸ (`value`): `undefined` \| `string` ###### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| `string` \| `number` | ###### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/validators.ts:28 ___ #### maxValue ▸ `Const` **maxValue**(`max`): (`value`: `undefined` \| ``null`` \| `number`) => `undefined` \| `string` ##### Parameters | Name | Type | | :------ | :------ | | `max` | `number` | ##### Returns `fn` ▸ (`value`): `undefined` \| `string` ###### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| `number` | ###### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/validators.ts:47 ___ #### minCount ▸ `Const` **minCount**(`count`): (`value`: `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[]) => `undefined` \| `string` ##### Parameters | Name | Type | | :------ | :------ | | `count` | `number` | ##### Returns `fn` ▸ (`value`): `undefined` \| `string` ###### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[] | ###### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/validators.ts:41 ___ #### minValue ▸ `Const` **minValue**(`min`): (`value`: `undefined` \| ``null`` \| `number`) => `undefined` \| `string` ##### Parameters | Name | Type | | :------ | :------ | | `min` | `number` | ##### Returns `fn` ▸ (`value`): `undefined` \| `string` ###### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| `number` | ###### Returns `undefined` \| `string` ##### Defined in packages/envoc-form/src/Validation/validators.ts:52 ___ #### required ▸ `Const` **required**(`value`): `undefined` \| ``"Required"`` ##### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | ##### Returns `undefined` \| ``"Required"`` ##### Defined in packages/envoc-form/src/Validation/validators.ts:3 ___ #### zipCode ▸ `Const` **zipCode**(`value`): `undefined` \| ``"Invalid ZIP Code"`` Validate for a ZIP Code. Accepts formats: ##### and #####-#### ##### Parameters | Name | Type | | :------ | :------ | | `value` | `undefined` \| ``null`` \| `string` | ##### Returns `undefined` \| ``"Invalid ZIP Code"`` ##### Defined in packages/envoc-form/src/Validation/validators.ts:58