6.0.1-3 • Published 8 months ago

envoc-form v6.0.1-3

Weekly downloads
89
License
MIT
Repository
-
Last release
8 months ago

envoc-form / Exports

envoc-form

npm package

Base form package for envoc projects.

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

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

Interfaces

envoc-form / Exports / AddressInputProps

Interface: AddressInputProps

Table of contents

Properties

Properties

fieldBuilder

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

Defined in

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


name

name: string

Defined in

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

envoc-form / Exports / BooleanSelectGroupProps

Interface: BooleanSelectGroupProps

Hierarchy

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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


disabled

Optional disabled: boolean

Whether the field should be disabled.

Inherited from

Omit.disabled

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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


input

input: CustomFieldInputProps\<undefined | null | boolean>

Inherited from

Omit.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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


meta

meta: CustomFieldMetaProps\<undefined | null | boolean>

Inherited from

Omit.meta

Defined in

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


options

Optional options: SelectOption\<boolean>[]

Defined in

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


placeholder

Optional placeholder: string

Text diplayed when no value is selected.

Inherited from

Omit.placeholder

Defined in

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


required

Optional required: boolean

Inherited from

Omit.required

Defined in

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

envoc-form / Exports / CheckboxInputGroupProps

Interface: CheckboxInputGroupProps

Hierarchy

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

    CheckboxInputGroupProps

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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


icon

Optional icon: ReactNode

Inherited from

Omit.icon

Defined in

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


input

input: CustomFieldInputProps\<undefined | null | boolean>

Inherited from

Omit.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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


labelOnLeft

Optional labelOnLeft: boolean

Defined in

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


meta

meta: CustomFieldMetaProps\<undefined | null | boolean>

Inherited from

Omit.meta

Defined in

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

envoc-form / Exports / ConfirmBaseFormProps

Interface: ConfirmBaseFormProps

Table of contents

Properties

Properties

children

Optional children: ReactNode

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

Defined in

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


confirmButtonClass

Optional confirmButtonClass: string

CSS class for the buttons.

Defined in

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


confirmButtonText

Optional confirmButtonText: string

Custom confirm button text.

Default Value

Confirm

Defined in

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


handleCancel

Optional handleCancel: MouseEventHandler\<HTMLButtonElement>

Function to run when cancel button is clicked.

Defined in

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


request

request: useAxiosRequestProps

Axios request upon confirmation

Defined in

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


style

Optional style: CSSProperties

Defined in

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


title

Optional title: string

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

Defined in

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

envoc-form / Exports / ConfirmDeleteFormProps

Interface: ConfirmDeleteFormProps

Hierarchy

Table of contents

Properties

Properties

children

Optional children: ReactNode

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

Defined in

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


form

form: string

Form name (key) to apply the confirmation on.

Defined in

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


handleComplete

Optional handleComplete: Function

Custom function when the axios request succeeds.

Defined in

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


handleError

Optional handleError: Function

Custom function when the axios request fails.

Defined in

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


style

Optional style: CSSProperties

Inherited from

Pick.style

Defined in

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


successUrl

Optional successUrl: string

Url to navigate to on success.

Defined in

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


title

Optional title: string

Custom message to display.

Default Value

Are you sure you want to delete this?

Defined in

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

envoc-form / Exports / DatePickerGroupProps

Interface: DatePickerGroupProps\<T>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Name
T

Hierarchy

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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


convert

convert: (arg: Date) => T

Type declaration

▸ (arg): T

Parameters
NameType
argDate
Returns

T

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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


input

input: CustomFieldInputProps\<undefined | null | T>

Inherited from

InjectedFieldProps.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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


meta

meta: CustomFieldMetaProps\<undefined | null | T>

Inherited from

InjectedFieldProps.meta

Defined in

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


onAbort

onAbort: undefined | (event: any) => void

Inherited from

Omit.onAbort


onAnimationEnd

onAnimationEnd: undefined | (event: any) => void

Inherited from

Omit.onAnimationEnd


onAnimationIteration

onAnimationIteration: undefined | (event: any) => void

Inherited from

Omit.onAnimationIteration


onAnimationStart

onAnimationStart: undefined | (event: any) => void

Inherited from

Omit.onAnimationStart


onBlur

onBlur: undefined | (event: any) => void

Inherited from

Omit.onBlur


onCanPlay

onCanPlay: undefined | (event: any) => void

Inherited from

Omit.onCanPlay


onCanPlayThrough

onCanPlayThrough: undefined | (event: any) => void

Inherited from

Omit.onCanPlayThrough


onClick

onClick: undefined | (event: any) => void

Inherited from

Omit.onClick


onCompositionEnd

onCompositionEnd: undefined | (event: any) => void

Inherited from

Omit.onCompositionEnd


onCompositionStart

onCompositionStart: undefined | (event: any) => void

Inherited from

Omit.onCompositionStart


onCompositionUpdate

onCompositionUpdate: undefined | (event: any) => void

Inherited from

Omit.onCompositionUpdate


onContextMenu

onContextMenu: undefined | (event: any) => void

Inherited from

Omit.onContextMenu


onCopy

onCopy: undefined | (event: any) => void

Inherited from

Omit.onCopy


onCut

onCut: undefined | (event: any) => void

Inherited from

Omit.onCut


onDoubleClick

onDoubleClick: undefined | (event: any) => void

Inherited from

Omit.onDoubleClick


onDrag

onDrag: undefined | (event: any) => void

Inherited from

Omit.onDrag


onDragEnd

onDragEnd: undefined | (event: any) => void

Inherited from

Omit.onDragEnd


onDragEnter

onDragEnter: undefined | (event: any) => void

Inherited from

Omit.onDragEnter


onDragExit

onDragExit: undefined | (event: any) => void

Inherited from

Omit.onDragExit


onDragLeave

onDragLeave: undefined | (event: any) => void

Inherited from

Omit.onDragLeave


onDragOver

onDragOver: undefined | (event: any) => void

Inherited from

Omit.onDragOver


onDragStart

onDragStart: undefined | (event: any) => void

Inherited from

Omit.onDragStart


onDrop

onDrop: undefined | (event: any) => void

Inherited from

Omit.onDrop


onDurationChange

onDurationChange: undefined | (event: any) => void

Inherited from

Omit.onDurationChange


onEmptied

onEmptied: undefined | (event: any) => void

Inherited from

Omit.onEmptied


onEncrypted

onEncrypted: undefined | (event: any) => void

Inherited from

Omit.onEncrypted


onEnded

onEnded: undefined | (event: any) => void

Inherited from

Omit.onEnded


onError

onError: undefined | (event: any) => void

Inherited from

Omit.onError


onGotPointerCapture

onGotPointerCapture: undefined | (event: any) => void

Inherited from

Omit.onGotPointerCapture


onInput

onInput: undefined | (event: any) => void

Inherited from

Omit.onInput


onInvalid

onInvalid: undefined | (event: any) => void

Inherited from

Omit.onInvalid


onKeyDown

onKeyDown: undefined | (event: any) => void

Inherited from

Omit.onKeyDown


onKeyPress

onKeyPress: undefined | (event: any) => void

Inherited from

Omit.onKeyPress


onKeyUp

onKeyUp: undefined | (event: any) => void

Inherited from

Omit.onKeyUp


onLoad

onLoad: undefined | (event: any) => void

Inherited from

Omit.onLoad


onLoadStart

onLoadStart: undefined | (event: any) => void

Inherited from

Omit.onLoadStart


onLoadedData

onLoadedData: undefined | (event: any) => void

Inherited from

Omit.onLoadedData


onLoadedMetadata

onLoadedMetadata: undefined | (event: any) => void

Inherited from

Omit.onLoadedMetadata


onLostPointerCapture

onLostPointerCapture: undefined | (event: any) => void

Inherited from

Omit.onLostPointerCapture


onMouseDown

onMouseDown: undefined | (event: any) => void

Inherited from

Omit.onMouseDown


onMouseEnter

onMouseEnter: undefined | (event: any) => void

Inherited from

Omit.onMouseEnter


onMouseLeave

onMouseLeave: undefined | (event: any) => void

Inherited from

Omit.onMouseLeave


onMouseMove

onMouseMove: undefined | (event: any) => void

Inherited from

Omit.onMouseMove


onMouseOut

onMouseOut: undefined | (event: any) => void

Inherited from

Omit.onMouseOut


onMouseOver

onMouseOver: undefined | (event: any) => void

Inherited from

Omit.onMouseOver


onMouseUp

onMouseUp: undefined | (event: any) => void

Inherited from

Omit.onMouseUp


onPaste

onPaste: undefined | (event: any) => void

Inherited from

Omit.onPaste


onPause

onPause: undefined | (event: any) => void

Inherited from

Omit.onPause


onPlay

onPlay: undefined | (event: any) => void

Inherited from

Omit.onPlay


onPlaying

onPlaying: undefined | (event: any) => void

Inherited from

Omit.onPlaying


onPointerCancel

onPointerCancel: undefined | (event: any) => void

Inherited from

Omit.onPointerCancel


onPointerDown

onPointerDown: undefined | (event: any) => void

Inherited from

Omit.onPointerDown


onPointerEnter

onPointerEnter: undefined | (event: any) => void

Inherited from

Omit.onPointerEnter


onPointerLeave

onPointerLeave: undefined | (event: any) => void

Inherited from

Omit.onPointerLeave


onPointerMove

onPointerMove: undefined | (event: any) => void

Inherited from

Omit.onPointerMove


onPointerOut

onPointerOut: undefined | (event: any) => void

Inherited from

Omit.onPointerOut


onPointerOver

onPointerOver: undefined | (event: any) => void

Inherited from

Omit.onPointerOver


onPointerUp

onPointerUp: undefined | (event: any) => void

Inherited from

Omit.onPointerUp


onProgress

onProgress: undefined | (event: any) => void

Inherited from

Omit.onProgress


onRateChange

onRateChange: undefined | (event: any) => void

Inherited from

Omit.onRateChange


onReset

onReset: undefined | (event: any) => void

Inherited from

Omit.onReset


onScroll

onScroll: undefined | (event: any) => void

Inherited from

Omit.onScroll


onSeeked

onSeeked: undefined | (event: any) => void

Inherited from

Omit.onSeeked


onSeeking

onSeeking: undefined | (event: any) => void

Inherited from

Omit.onSeeking


onSelect

onSelect: undefined | (event: any) => void

Inherited from

Omit.onSelect


onStalled

onStalled: undefined | (event: any) => void

Inherited from

Omit.onStalled


onSubmit

onSubmit: undefined | (event: any) => void

Inherited from

Omit.onSubmit


onSuspend

onSuspend: undefined | (event: any) => void

Inherited from

Omit.onSuspend


onTimeUpdate

onTimeUpdate: undefined | (event: any) => void

Inherited from

Omit.onTimeUpdate


onToggle

onToggle: undefined | (event: any) => void

Inherited from

Omit.onToggle


onTouchCancel

onTouchCancel: undefined | (event: any) => void

Inherited from

Omit.onTouchCancel


onTouchEnd

onTouchEnd: undefined | (event: any) => void

Inherited from

Omit.onTouchEnd


onTouchMove

onTouchMove: undefined | (event: any) => void

Inherited from

Omit.onTouchMove


onTouchStart

onTouchStart: undefined | (event: any) => void

Inherited from

Omit.onTouchStart


onTransitionEnd

onTransitionEnd: undefined | (event: any) => void

Inherited from

Omit.onTransitionEnd


onVolumeChange

onVolumeChange: undefined | (event: any) => void

Inherited from

Omit.onVolumeChange


onWaiting

onWaiting: undefined | (event: any) => void

Inherited from

Omit.onWaiting


onWheel

onWheel: undefined | (event: any) => void

Inherited from

Omit.onWheel

envoc-form / Exports / DatePickerHelper

Interface: DatePickerHelper\<T>

Type parameters

Name
T

Hierarchy

Table of contents

Properties

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


onAbort

onAbort: undefined | (event: any) => void

Inherited from

Omit.onAbort


onAnimationEnd

onAnimationEnd: undefined | (event: any) => void

Inherited from

Omit.onAnimationEnd


onAnimationIteration

onAnimationIteration: undefined | (event: any) => void

Inherited from

Omit.onAnimationIteration


onAnimationStart

onAnimationStart: undefined | (event: any) => void

Inherited from

Omit.onAnimationStart


onBlur

onBlur: undefined | (event: any) => void

Inherited from

Omit.onBlur


onCanPlay

onCanPlay: undefined | (event: any) => void

Inherited from

Omit.onCanPlay


onCanPlayThrough

onCanPlayThrough: undefined | (event: any) => void

Inherited from

Omit.onCanPlayThrough


onClick

onClick: undefined | (event: any) => void

Inherited from

Omit.onClick


onCompositionEnd

onCompositionEnd: undefined | (event: any) => void

Inherited from

Omit.onCompositionEnd


onCompositionStart

onCompositionStart: undefined | (event: any) => void

Inherited from

Omit.onCompositionStart


onCompositionUpdate

onCompositionUpdate: undefined | (event: any) => void

Inherited from

Omit.onCompositionUpdate


onContextMenu

onContextMenu: undefined | (event: any) => void

Inherited from

Omit.onContextMenu


onCopy

onCopy: undefined | (event: any) => void

Inherited from

Omit.onCopy


onCut

onCut: undefined | (event: any) => void

Inherited from

Omit.onCut


onDoubleClick

onDoubleClick: undefined | (event: any) => void

Inherited from

Omit.onDoubleClick


onDrag

onDrag: undefined | (event: any) => void

Inherited from

Omit.onDrag


onDragEnd

onDragEnd: undefined | (event: any) => void

Inherited from

Omit.onDragEnd


onDragEnter

onDragEnter: undefined | (event: any) => void

Inherited from

Omit.onDragEnter


onDragExit

onDragExit: undefined | (event: any) => void

Inherited from

Omit.onDragExit


onDragLeave

onDragLeave: undefined | (event: any) => void

Inherited from

Omit.onDragLeave


onDragOver

onDragOver: undefined | (event: any) => void

Inherited from

Omit.onDragOver


onDragStart

onDragStart: undefined | (event: any) => void

Inherited from

Omit.onDragStart


onDrop

onDrop: undefined | (event: any) => void

Inherited from

Omit.onDrop


onDurationChange

onDurationChange: undefined | (event: any) => void

Inherited from

Omit.onDurationChange


onEmptied

onEmptied: undefined | (event: any) => void

Inherited from

Omit.onEmptied


onEncrypted

onEncrypted: undefined | (event: any) => void

Inherited from

Omit.onEncrypted


onEnded

onEnded: undefined | (event: any) => void

Inherited from

Omit.onEnded


onError

onError: undefined | (event: any) => void

Inherited from

Omit.onError


onGotPointerCapture

onGotPointerCapture: undefined | (event: any) => void

Inherited from

Omit.onGotPointerCapture


onInput

onInput: undefined | (event: any) => void

Inherited from

Omit.onInput


onInvalid

onInvalid: undefined | (event: any) => void

Inherited from

Omit.onInvalid


onKeyDown

onKeyDown: undefined | (event: any) => void

Inherited from

Omit.onKeyDown


onKeyPress

onKeyPress: undefined | (event: any) => void

Inherited from

Omit.onKeyPress


onKeyUp

onKeyUp: undefined | (event: any) => void

Inherited from

Omit.onKeyUp


onLoad

onLoad: undefined | (event: any) => void

Inherited from

Omit.onLoad


onLoadStart

onLoadStart: undefined | (event: any) => void

Inherited from

Omit.onLoadStart


onLoadedData

onLoadedData: undefined | (event: any) => void

Inherited from

Omit.onLoadedData


onLoadedMetadata

onLoadedMetadata: undefined | (event: any) => void

Inherited from

Omit.onLoadedMetadata


onLostPointerCapture

onLostPointerCapture: undefined | (event: any) => void

Inherited from

Omit.onLostPointerCapture


onMouseDown

onMouseDown: undefined | (event: any) => void

Inherited from

Omit.onMouseDown


onMouseEnter

onMouseEnter: undefined | (event: any) => void

Inherited from

Omit.onMouseEnter


onMouseLeave

onMouseLeave: undefined | (event: any) => void

Inherited from

Omit.onMouseLeave


onMouseMove

onMouseMove: undefined | (event: any) => void

Inherited from

Omit.onMouseMove


onMouseOut

onMouseOut: undefined | (event: any) => void

Inherited from

Omit.onMouseOut


onMouseOver

onMouseOver: undefined | (event: any) => void

Inherited from

Omit.onMouseOver


onMouseUp

onMouseUp: undefined | (event: any) => void

Inherited from

Omit.onMouseUp


onPaste

onPaste: undefined | (event: any) => void

Inherited from

Omit.onPaste


onPause

onPause: undefined | (event: any) => void

Inherited from

Omit.onPause


onPlay

onPlay: undefined | (event: any) => void

Inherited from

Omit.onPlay


onPlaying

onPlaying: undefined | (event: any) => void

Inherited from

Omit.onPlaying


onPointerCancel

onPointerCancel: undefined | (event: any) => void

Inherited from

Omit.onPointerCancel


onPointerDown

onPointerDown: undefined | (event: any) => void

Inherited from

Omit.onPointerDown


onPointerEnter

onPointerEnter: undefined | (event: any) => void

Inherited from

Omit.onPointerEnter


onPointerLeave

onPointerLeave: undefined | (event: any) => void

Inherited from

Omit.onPointerLeave


onPointerMove

onPointerMove: undefined | (event: any) => void

Inherited from

Omit.onPointerMove


onPointerOut

onPointerOut: undefined | (event: any) => void

Inherited from

Omit.onPointerOut


onPointerOver

onPointerOver: undefined | (event: any) => void

Inherited from

Omit.onPointerOver


onPointerUp

onPointerUp: undefined | (event: any) => void

Inherited from

Omit.onPointerUp


onProgress

onProgress: undefined | (event: any) => void

Inherited from

Omit.onProgress


onRateChange

onRateChange: undefined | (event: any) => void

Inherited from

Omit.onRateChange


onReset

onReset: undefined | (event: any) => void

Inherited from

Omit.onReset


onScroll

onScroll: undefined | (event: any) => void

Inherited from

Omit.onScroll


onSeeked

onSeeked: undefined | (event: any) => void

Inherited from

Omit.onSeeked


onSeeking

onSeeking: undefined | (event: any) => void

Inherited from

Omit.onSeeking


onSelect

onSelect: undefined | (event: any) => void

Inherited from

Omit.onSelect


onStalled

onStalled: undefined | (event: any) => void

Inherited from

Omit.onStalled


onSubmit

onSubmit: undefined | (event: any) => void

Inherited from

Omit.onSubmit


onSuspend

onSuspend: undefined | (event: any) => void

Inherited from

Omit.onSuspend


onTimeUpdate

onTimeUpdate: undefined | (event: any) => void

Inherited from

Omit.onTimeUpdate


onToggle

onToggle: undefined | (event: any) => void

Inherited from

Omit.onToggle


onTouchCancel

onTouchCancel: undefined | (event: any) => void

Inherited from

Omit.onTouchCancel


onTouchEnd

onTouchEnd: undefined | (event: any) => void

Inherited from

Omit.onTouchEnd


onTouchMove

onTouchMove: undefined | (event: any) => void

Inherited from

Omit.onTouchMove


onTouchStart

onTouchStart: undefined | (event: any) => void

Inherited from

Omit.onTouchStart


onTransitionEnd

onTransitionEnd: undefined | (event: any) => void

Inherited from

Omit.onTransitionEnd


onVolumeChange

onVolumeChange: undefined | (event: any) => void

Inherited from

Omit.onVolumeChange


onWaiting

onWaiting: undefined | (event: any) => void

Inherited from

Omit.onWaiting


onWheel

onWheel: undefined | (event: any) => void

Inherited from

Omit.onWheel

envoc-form / Exports / DateTimePickerGroupProps

Interface: DateTimePickerGroupProps\<T>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Name
T

Hierarchy

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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


convert

convert: (date: Date) => T

Type declaration

▸ (date): T

Parameters
NameType
dateDate
Returns

T

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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


input

input: CustomFieldInputProps\<undefined | null | T>

Inherited from

InjectedFieldProps.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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


meta

meta: CustomFieldMetaProps\<undefined | null | T>

Inherited from

InjectedFieldProps.meta

Defined in

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


onAbort

onAbort: undefined | (event: any) => void

Inherited from

Omit.onAbort


onAnimationEnd

onAnimationEnd: undefined | (event: any) => void

Inherited from

Omit.onAnimationEnd


onAnimationIteration

onAnimationIteration: undefined | (event: any) => void

Inherited from

Omit.onAnimationIteration


onAnimationStart

onAnimationStart: undefined | (event: any) => void

Inherited from

Omit.onAnimationStart


onBlur

onBlur: undefined | (event: any) => void

Inherited from

Omit.onBlur


onCanPlay

onCanPlay: undefined | (event: any) => void

Inherited from

Omit.onCanPlay


onCanPlayThrough

onCanPlayThrough: undefined | (event: any) => void

Inherited from

Omit.onCanPlayThrough


onClick

onClick: undefined | (event: any) => void

Inherited from

Omit.onClick


onCompositionEnd

onCompositionEnd: undefined | (event: any) => void

Inherited from

Omit.onCompositionEnd


onCompositionStart

onCompositionStart: undefined | (event: any) => void

Inherited from

Omit.onCompositionStart


onCompositionUpdate

onCompositionUpdate: undefined | (event: any) => void

Inherited from

Omit.onCompositionUpdate


onContextMenu

onContextMenu: undefined | (event: any) => void

Inherited from

Omit.onContextMenu


onCopy

onCopy: undefined | (event: any) => void

Inherited from

Omit.onCopy


onCut

onCut: undefined | (event: any) => void

Inherited from

Omit.onCut


onDoubleClick

onDoubleClick: undefined | (event: any) => void

Inherited from

Omit.onDoubleClick


onDrag

onDrag: undefined | (event: any) => void

Inherited from

Omit.onDrag


onDragEnd

onDragEnd: undefined | (event: any) => void

Inherited from

Omit.onDragEnd


onDragEnter

onDragEnter: undefined | (event: any) => void

Inherited from

Omit.onDragEnter


onDragExit

onDragExit: undefined | (event: any) => void

Inherited from

Omit.onDragExit


onDragLeave

onDragLeave: undefined | (event: any) => void

Inherited from

Omit.onDragLeave


onDragOver

onDragOver: undefined | (event: any) => void

Inherited from

Omit.onDragOver


onDragStart

onDragStart: undefined | (event: any) => void

Inherited from

Omit.onDragStart


onDrop

onDrop: undefined | (event: any) => void

Inherited from

Omit.onDrop


onDurationChange

onDurationChange: undefined | (event: any) => void

Inherited from

Omit.onDurationChange


onEmptied

onEmptied: undefined | (event: any) => void

Inherited from

Omit.onEmptied


onEncrypted

onEncrypted: undefined | (event: any) => void

Inherited from

Omit.onEncrypted


onEnded

onEnded: undefined | (event: any) => void

Inherited from

Omit.onEnded


onError

onError: undefined | (event: any) => void

Inherited from

Omit.onError


onGotPointerCapture

onGotPointerCapture: undefined | (event: any) => void

Inherited from

Omit.onGotPointerCapture


onInput

onInput: undefined | (event: any) => void

Inherited from

Omit.onInput


onInvalid

onInvalid: undefined | (event: any) => void

Inherited from

Omit.onInvalid


onKeyDown

onKeyDown: undefined | (event: any) => void

Inherited from

Omit.onKeyDown


onKeyPress

onKeyPress: undefined | (event: any) => void

Inherited from

Omit.onKeyPress


onKeyUp

onKeyUp: undefined | (event: any) => void

Inherited from

Omit.onKeyUp


onLoad

onLoad: undefined | (event: any) => void

Inherited from

Omit.onLoad


onLoadStart

onLoadStart: undefined | (event: any) => void

Inherited from

Omit.onLoadStart


onLoadedData

onLoadedData: undefined | (event: any) => void

Inherited from

Omit.onLoadedData


onLoadedMetadata

onLoadedMetadata: undefined | (event: any) => void

Inherited from

Omit.onLoadedMetadata


onLostPointerCapture

onLostPointerCapture: undefined | (event: any) => void

Inherited from

Omit.onLostPointerCapture


onMouseDown

onMouseDown: undefined | (event: any) => void

Inherited from

Omit.onMouseDown


onMouseEnter

onMouseEnter: undefined | (event: any) => void

Inherited from

Omit.onMouseEnter


onMouseLeave

onMouseLeave: undefined | (event: any) => void

Inherited from

Omit.onMouseLeave


onMouseMove

onMouseMove: undefined | (event: any) => void

Inherited from

Omit.onMouseMove


onMouseOut

onMouseOut: undefined | (event: any) => void

Inherited from

Omit.onMouseOut


onMouseOver

onMouseOver: undefined | (event: any) => void

Inherited from

Omit.onMouseOver


onMouseUp

onMouseUp: undefined | (event: any) => void

Inherited from

Omit.onMouseUp


onPaste

onPaste: undefined | (event: any) => void

Inherited from

Omit.onPaste


onPause

onPause: undefined | (event: any) => void

Inherited from

Omit.onPause


onPlay

onPlay: undefined | (event: any) => void

Inherited from

Omit.onPlay


onPlaying

onPlaying: undefined | (event: any) => void

Inherited from

Omit.onPlaying


onPointerCancel

onPointerCancel: undefined | (event: any) => void

Inherited from

Omit.onPointerCancel


onPointerDown

onPointerDown: undefined | (event: any) => void

Inherited from

Omit.onPointerDown


onPointerEnter

onPointerEnter: undefined | (event: any) => void

Inherited from

Omit.onPointerEnter


onPointerLeave

onPointerLeave: undefined | (event: any) => void

Inherited from

Omit.onPointerLeave


onPointerMove

onPointerMove: undefined | (event: any) => void

Inherited from

Omit.onPointerMove


onPointerOut

onPointerOut: undefined | (event: any) => void

Inherited from

Omit.onPointerOut


onPointerOver

onPointerOver: undefined | (event: any) => void

Inherited from

Omit.onPointerOver


onPointerUp

onPointerUp: undefined | (event: any) => void

Inherited from

Omit.onPointerUp


onProgress

onProgress: undefined | (event: any) => void

Inherited from

Omit.onProgress


onRateChange

onRateChange: undefined | (event: any) => void

Inherited from

Omit.onRateChange


onReset

onReset: undefined | (event: any) => void

Inherited from

Omit.onReset


onScroll

onScroll: undefined | (event: any) => void

Inherited from

Omit.onScroll


onSeeked

onSeeked: undefined | (event: any) => void

Inherited from

Omit.onSeeked


onSeeking

onSeeking: undefined | (event: any) => void

Inherited from

Omit.onSeeking


onSelect

onSelect: undefined | (event: any) => void

Inherited from

Omit.onSelect


onStalled

onStalled: undefined | (event: any) => void

Inherited from

Omit.onStalled


onSubmit

onSubmit: undefined | (event: any) => void

Inherited from

Omit.onSubmit


onSuspend

onSuspend: undefined | (event: any) => void

Inherited from

Omit.onSuspend


onTimeUpdate

onTimeUpdate: undefined | (event: any) => void

Inherited from

Omit.onTimeUpdate


onToggle

onToggle: undefined | (event: any) => void

Inherited from

Omit.onToggle


onTouchCancel

onTouchCancel: undefined | (event: any) => void

Inherited from

Omit.onTouchCancel


onTouchEnd

onTouchEnd: undefined | (event: any) => void

Inherited from

Omit.onTouchEnd


onTouchMove

onTouchMove: undefined | (event: any) => void

Inherited from

Omit.onTouchMove


onTouchStart

onTouchStart: undefined | (event: any) => void

Inherited from

Omit.onTouchStart


onTransitionEnd

onTransitionEnd: undefined | (event: any) => void

Inherited from

Omit.onTransitionEnd


onVolumeChange

onVolumeChange: undefined | (event: any) => void

Inherited from

Omit.onVolumeChange


onWaiting

onWaiting: undefined | (event: any) => void

Inherited from

Omit.onWaiting


onWheel

onWheel: undefined | (event: any) => void

Inherited from

Omit.onWheel

envoc-form / Exports / FileGroupProps

Interface: FileGroupProps

Defines what is injected by a Field wrapper of some TRenderComponent

Hierarchy

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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


disabled

Optional disabled: boolean

Whether the field should be disabled.

Inherited from

Omit.disabled

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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


input

input: CustomFieldInputProps\<any>

Inherited from

InjectedFieldProps.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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


meta

meta: CustomFieldMetaProps\<any>

Inherited from

InjectedFieldProps.meta

Defined in

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


multiple

Optional multiple: boolean

Allow multiple files to be uploaded.

Overrides

Omit.multiple

Defined in

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


required

Optional required: boolean

Inherited from

Omit.required

Defined in

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

envoc-form / Exports / FormActionsProps

Interface: FormActionsProps

Table of contents

Properties

Properties

allowPristineSubmit

Optional allowPristineSubmit: boolean

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

Defined in

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


disabled

Optional disabled: boolean

Whether both buttons should be disabled.

Defined in

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


handleCancel

Optional handleCancel: () => void

The cancel button's onClick.

Default Value

window.history.back()

Type declaration

▸ (): void

Returns

void

Defined in

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

envoc-form / Exports / GroupProps

Interface: GroupProps

Defines what is injected by a Field wrapper of some TRenderComponent

Hierarchy

Table of contents

Properties

Properties

children

children: ReactNode

Defined in

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


className

Optional className: string

Extra class names to apply.

Defined in

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


disabled

Optional disabled: boolean

Whether the field should be disabled.

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Defined in

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


input

input: CustomFieldInputProps\<any>

Inherited from

InjectedFieldProps.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Defined in

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


meta

meta: CustomFieldMetaProps\<any>

Inherited from

InjectedFieldProps.meta

Defined in

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


required

Optional required: boolean

Defined in

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

envoc-form / Exports / IconInputGroupProps

Interface: IconInputGroupProps

Hierarchy

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

    IconInputGroupProps

Table of contents

Properties

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

Defined in

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

envoc-form / Exports / InjectedFieldProps

Interface: InjectedFieldProps\<TValue>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Name
TValue

Hierarchy

Table of contents

Properties

Properties

input

input: CustomFieldInputProps\<TValue>

Defined in

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


meta

meta: CustomFieldMetaProps\<TValue>

Defined in

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

envoc-form / Exports / InputGroupProps

Interface: InputGroupProps\<TValue>

Defines what is injected by a Field wrapper of some TRenderComponent

Type parameters

Name
TValue

Hierarchy

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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


icon

Optional icon: ReactNode

Defined in

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


input

input: CustomFieldInputProps\<TValue>

Inherited from

InjectedFieldProps.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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


meta

meta: CustomFieldMetaProps\<TValue>

Inherited from

InjectedFieldProps.meta

Defined in

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


onChange

onChange: ChangeEventHandler\<HTMLInputElement>

Overrides

Omit.onChange

Defined in

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


value

value: undefined | null | string | number

Defined in

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

envoc-form / Exports / MoneyInputGroupProps

Interface: MoneyInputGroupProps

Hierarchy

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

    MoneyInputGroupProps

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

Omit.className

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

Omit.helpText

Defined in

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


icon

Optional icon: ReactNode

Inherited from

Omit.icon

Defined in

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


input

input: CustomFieldInputProps\<undefined | null | number>

Inherited from

Omit.input

Defined in

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


label

Optional label: string

Simple text label before the input.

Inherited from

Omit.label

Defined in

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


meta

meta: CustomFieldMetaProps\<undefined | null | number>

Inherited from

Omit.meta

Defined in

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


parseFunc

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

Custom parsing function when the value changes.

Defined in

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

envoc-form / Exports / MultiNumberSelectGroupProps

Interface: MultiNumberSelectGroupProps

Hierarchy

Table of contents

Properties

Properties

className

Optional className: string

Extra class names to apply.

Inherited from

SelectGroupPropsHelper.className

Defined in

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


disabled

Optional disabled: boolean

Whether the field should be disabled.

Inherited from

SelectGroupPropsHelper.disabled

Defined in

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


helpText

Optional helpText: ReactNode

Simple helper text after the input.

Inherited from

SelectGroupPropsHelper.helpText

Defined in

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


input

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

Inherited from

[Select

6.0.1-3

8 months ago

5.2.0

8 months ago

5.1.0

8 months ago

6.0.1-2

8 months ago

4.3.0

8 months ago

4.2.0

11 months ago

6.0.1-1

12 months ago

5.0.9

12 months ago

5.0.8

1 year ago

6.0.1-0

1 year ago

5.0.7

1 year ago

5.0.4-0

1 year ago

5.0.6

1 year ago

5.0.5

1 year ago

5.0.3

1 year ago

5.0.2

2 years ago

5.0.1

2 years ago

5.0.0

2 years ago

4.0.1-12

2 years ago

4.1.0

2 years ago

4.0.1-11

2 years ago

4.0.1-10

2 years ago

4.0.1-9

2 years ago

4.0.1-8

2 years ago

4.0.1-6

3 years ago

4.0.1-7

3 years ago

4.0.1-5

3 years ago

2.0.2

3 years ago

4.0.1-2

3 years ago

4.0.1-3

3 years ago

2.0.1

3 years ago

4.0.1-1

3 years ago

3.3.1

3 years ago

4.0.1-4

3 years ago

3.3.3

3 years ago

3.3.2

3 years ago

4.0.1-0

3 years ago

3.3.0

3 years ago

3.2.0

3 years ago

3.1.0

3 years ago

2.0.1-13

3 years ago

2.0.1-14

3 years ago

3.0.0

3 years ago

3.0.0-3

3 years ago

3.0.0-2

3 years ago

2.0.1-12

4 years ago

2.0.1-11

4 years ago

2.0.1-10

4 years ago

2.0.1-9

4 years ago

2.0.1-8

4 years ago

2.0.1-7

4 years ago

2.0.1-6

4 years ago

2.0.1-5

4 years ago

2.0.1-4

4 years ago

2.0.1-3

5 years ago

2.0.1-2

5 years ago

2.0.1-1

5 years ago

2.0.1-0

5 years ago

1.3.1

5 years ago

1.3.0

5 years ago

1.2.0

5 years ago

1.1.27-4

5 years ago

1.1.27-2

5 years ago

1.1.27-3

5 years ago

1.1.27-1

5 years ago

1.1.27-0

5 years ago

1.1.26

5 years ago

1.1.25

5 years ago

1.1.24

5 years ago

1.1.23

5 years ago