envoc-form
Version:
Envoc form components
3,322 lines (1,813 loc) • 155 kB
Markdown
<a name="readmemd"></a>
envoc-form / [Exports](#modulesmd)
# envoc-form
[![npm package][npm-badge]][npm]
Base form package for envoc projects.
[npm-badge]: https://img.shields.io/npm/v/envoc-form.png?style=flat
[npm]: https://www.npmjs.com/package/envoc-form
Important naming conventions for our sanity while creating envoc-form types:
- TForm = The type of the some form. e.g. LoginDto
- TProp = The key / symbol of a individual property of some form. e.g. TProp would be literally "Username" for the prop of the same name for a LoginDto
- TValue = The value of an individual property of some form. e.g. a "Username" property would probably have a TValue of string
- Field = the abstract thing that deals with some specific TProp. Might represent several composed elements (e.g. label, input, helperText, etc) or may just be a direct component
- TRenderComponent = The type of any 'Component' passed to a Field, e.g. 'StandardTextInputGroup' passed to Component means TRenderComponent is typeof(StandardTextInputGroup)
- TComponentProps = For any 'Component' passed to a Field as a prop, this represents that Component's props
# Interfaces
<a name="interfacesaddressinputpropsmd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / AddressInputProps
## Interface: AddressInputProps
### Table of contents
#### Properties
- [fieldBuilder](#fieldbuilder)
- [name](#name)
### Properties
#### fieldBuilder
• **fieldBuilder**: `Pick`<[`FormBuilderProp`](#formbuilderprop)<`AddressDto`\>, ``"Field"``\>
##### Defined in
packages/envoc-form/src/AddressInput/AddressInput.tsx:14
___
#### name
• **name**: `string`
##### Defined in
packages/envoc-form/src/AddressInput/AddressInput.tsx:15
<a name="interfacesbooleanselectgrouppropsmd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / BooleanSelectGroupProps
## Interface: BooleanSelectGroupProps
### Hierarchy
- `Omit`<[`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`boolean` \| `undefined` \| ``null``\>, ``"options"``\>
↳ **`BooleanSelectGroupProps`**
### 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`` \| `boolean`\>
##### Inherited from
Omit.input
##### Defined in
packages/envoc-form/src/Field/InjectedFieldProps.ts:6
___
#### label
• `Optional` **label**: `string`
Simple text label before the input.
##### Inherited from
Omit.label
##### Defined in
packages/envoc-form/src/Group.tsx:13
___
#### meta
• **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `boolean`\>
##### Inherited from
Omit.meta
##### Defined in
packages/envoc-form/src/Field/InjectedFieldProps.ts:7
___
#### options
• `Optional` **options**: [`SelectOption`](#interfacesselectoptionmd)<`boolean`\>[]
##### Defined in
packages/envoc-form/src/Select/BooleanSelectGroup.tsx:17
___
#### placeholder
• `Optional` **placeholder**: `string`
Text diplayed when no value is selected.
##### Inherited from
Omit.placeholder
##### Defined in
packages/envoc-form/src/Select/SelectGroup.tsx:38
___
#### required
• `Optional` **required**: `boolean`
##### Inherited from
Omit.required
##### Defined in
packages/envoc-form/src/Group.tsx:21
<a name="interfacesconfirmbaseformpropsmd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / ConfirmBaseFormProps
## Interface: ConfirmBaseFormProps
### Table of contents
#### Properties
- [children](#children)
- [confirmButtonClass](#confirmbuttonclass)
- [confirmButtonText](#confirmbuttontext)
- [handleCancel](#handlecancel)
- [request](#request)
- [style](#style)
- [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/ConfirmBaseForm/ConfirmBaseForm.tsx:23
___
#### confirmButtonClass
• `Optional` **confirmButtonClass**: `string`
CSS class for the buttons.
##### Defined in
packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:21
___
#### confirmButtonText
• `Optional` **confirmButtonText**: `string`
Custom confirm button text.
**`defaultvalue`** `Confirm`
##### Defined in
packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:19
___
#### handleCancel
• `Optional` **handleCancel**: `MouseEventHandler`<`HTMLButtonElement`\>
Function to run when cancel button is clicked.
##### Defined in
packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:10
___
#### request
• **request**: `default`
Axios request upon confirmation
##### Defined in
packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:12
___
#### style
• `Optional` **style**: `CSSProperties`
##### Defined in
packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:13
___
#### title
• `Optional` **title**: `string`
`<h3/>` title text on top of the form.
##### Defined in
packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:15
<a name="interfacesconfirmdeleteformpropsmd"></a>
[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
<a name="interfacesdatepickergrouppropsmd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / DatePickerGroupProps
## Interface: DatePickerGroupProps<T\>
### 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
<a name="interfacesdatepickerhelpermd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / DatePickerHelper
## Interface: DatePickerHelper<T\>
### 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
<a name="interfacesdatetimepickergrouppropsmd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / DateTimePickerGroupProps
## Interface: DateTimePickerGroupProps<T\>
### 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
<a name="interfacesfilegrouppropsmd"></a>
[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
<a name="interfacesformactionspropsmd"></a>
[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
<a name="interfacesgrouppropsmd"></a>
[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
<a name="interfacesiconinputgrouppropsmd"></a>
[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
<a name="interfacesinjectedfieldpropsmd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / InjectedFieldProps
## Interface: InjectedFieldProps<TValue\>
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
<a name="interfacesinputgrouppropsmd"></a>
[envoc-form](#readmemd) / [Exports](#modulesmd) / InputGroupProps
## Interface: InputGroupProps<TValue\>
### 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