formHelpers

Name	Type	Description
`PHONE`	`RegExp`	regex pattern for validating phone numbers
`EMAIL`	`RegExp`	regex pattern for validating email addresses
`ZIP`	`RegExp`	regex pattern for validating zip codes

# async static attemptFormSubmit(formData, isEdit, options) → {Promise.<void>}

Method to reduce the amount of boilerplate code needed to submit a form

Parameters:

Name	Type	Description
`formData`	`object`	data to submit
`isEdit`	`boolean`	true if editing, false if creating
`options`	`SubmitOptions`	options object

View Source helpers/formHelpers.js, line 536

Returns:

- promise that resolves when the submit is complete

Type: Promise.<void>

# static createFieldValidation(type, label, validationMap, field) → {YupSchema}

Create a yup schema for a given field type

Parameters:

Name	Type	Description
`type`	`number`
`label`	`string`
`validationMap`	`Map`
`field`	`object`

View Source helpers/formHelpers.js, line 387

Returns:

- yup schema for a field

Type: YupSchema

# static getSelectValue(multiple, inData) → {string}

Extract the id of the selected item from the data

Parameters:

Name	Type	Description
`multiple`	`boolean`	is the field a multiselect
`inData`	`object`	data to be extracted and formatted

View Source helpers/formHelpers.js, line 315

Returns:

- string of the id of the selected item or array of ids of selected items

Type: string

# static multiToPayload(selectionsopt) → {Array.<{id: number}>}

Covert multiselect form input into an api ready array

Parameters:

Name	Type	Attributes	Description
`selections`	`Array.<object>`	<optional>	array of selected items

View Source helpers/formHelpers.js, line 72

Returns:

- array of selected items with id

Type: Array.<{id: number}>

# static useFormSubmit() → {FormSubmitOptions}

Helper to create hook bits for form submit

View Source helpers/formHelpers.js, line 617

Returns:

Type: FormSubmitOptions

Example

const { modifying, setModifying, nav, enqueueSnackbar } = useFormSubmit();

# static validCurrencyFormat(value) → {boolean}

Return whether or not the value is a valid currency format

Parameters:

Name	Type	Description
`value`	`string`

View Source helpers/formHelpers.js, line 354

Returns:

- true if the value is a valid currency format

Type: boolean

# static validDateFormat(value) → {boolean}

Test the value to see if it is a valid date

Parameters:

Name	Type	Description
`value`	`string`

View Source helpers/formHelpers.js, line 63

Returns:

- true if the value is a valid date

Type: boolean

# static validDoubleFormat(value, i, f) → {boolean}

Format validation for a double value if i and f are not passed in, the default is 4 digits before and 4 digits after the decimal if i or f are passed in and are not numbers, the default is 999999999 digits before and after the decimal

Parameters:

Name	Type	Description
`value`	`number`
`i`	`number`	number of digits before decimal
`f`	`number`	number of digits after decimal

View Source helpers/formHelpers.js, line 367

Returns:

- true if the value is a valid double format

Type: boolean

# static yupCurrency(label, isRequiredopt, maxLengthopt, msgopt, reqMessageopt, minLengthopt) → {YupSchema}

Create a yup schema for a currency field that checks max/min length

Parameters:

Name	Type	Attributes	Description
`label`	`string`		label for the field
`isRequired`	`boolean`	<optional>	is the field required
`maxLength`	`number`	<optional>	max length of the field
`msg`	`string`	<optional>	message to display if the field is not formatted correctly
`reqMessage`	`string`	<optional>	message to display if the field is required
`minLength`	`number`	<optional>	min length of the field

View Source helpers/formHelpers.js, line 226

Returns:

- yup schema for a currency field

Type: YupSchema

# static yupDate(label, isRequiredopt, msgopt, reqMessageopt) → {YupSchema}

Create a yup schema for a date field

Parameters:

Name	Type	Attributes	Description
`label`	`string`		label for the field
`isRequired`	`boolean`	<optional>	is the field required
`msg`	`string`	<optional>	message to display if the field is not a valid date
`reqMessage`	`string`	<optional>	message to display if the field is required

View Source helpers/formHelpers.js, line 44

Returns:

- yup schema for a date field

Type: YupSchema

# static yupFloat(label, isRequiredopt, intopt, fracopt, maxLengthopt, msgopt, maxValueopt, reqMessageopt, minLengthopt, minValueopt) → {YupSchema}

Create a yup schema for a float field that checks max/min length

Parameters:

Name	Type	Attributes	Description
`label`	`string`		label for the field
`isRequired`	`boolean`	<optional>	is the field required
`int`	`number`	<optional>	max number of integers
`frac`	`number`	<optional>	max number of decimals
`maxLength`	`number`	<optional>	max length of the field
`msg`	`string`	<optional>	message to display if the field is not in the correct format
`maxValue`	`string`	<optional>	max value of the field
`reqMessage`	`string`	<optional>	message to display if the field is required
`minLength`	`number`	<optional>	min length of the field
`minValue`	`number`	<optional>	min value of the field

View Source helpers/formHelpers.js, line 138

Returns:

Type: YupSchema

# static yupInt(label, isRequiredopt, maxLengthopt, msgopt, reqMessageopt, minLengthopt) → {YupSchema}

Create a yup schema for an integer field that checks max/min length

Parameters:

Name	Type	Attributes	Description
`label`	`string`		label for the field
`isRequired`	`boolean`	<optional>	is the field required
`maxLength`	`number`	<optional>	max length of the field
`msg`	`string`	<optional>	message to display if the field is not an integer
`reqMessage`	`string`	<optional>	message to display if the field is required
`minLength`	`number`	<optional>	min length of the field

View Source helpers/formHelpers.js, line 109

Returns:

Type: YupSchema

# static yupMultiselect(label, isRequired, reqMessage) → {YupSchema}

Create a yup schema for a multiselect field

Parameters:

Name	Type	Description
`label`	`string`	label for the field
`isRequired`	`boolean`	is the field required
`reqMessage`	`string`	message to display if the field is required

View Source helpers/formHelpers.js, line 303

Returns:

- yup schema for a string field

Type: YupSchema

# static yupObject(label, isRequired, reqMessage) → {YupSchema}

Create a yup schema for a generic or custom object field

Parameters:

Name	Type	Description
`label`	`string`	label for the field
`isRequired`	`boolean`	is the field required
`reqMessage`	`string`	message to display if the field is required

View Source helpers/formHelpers.js, line 343

Returns:

- yup schema for an object field

Type: YupSchema

# static yupString(label, isRequiredopt, reqMessageopt) → {YupSchema}

Create a yup schema for a string field

Parameters:

Name	Type	Attributes
`label`	`string`
`isRequired`	`boolean`	<optional>
`reqMessage`	`string`	<optional>

View Source helpers/formHelpers.js, line 32

Returns:

- yup schema for the field

Type: YupSchema

# static yupTrimString(label, isRequiredopt, trimMsgopt, reqMessageopt) → {YupSchema}

Create a yup schema for a string field that ensures the value is trimmed

Parameters:

Name	Type	Attributes	Description
`label`	`string`		label for the field
`isRequired`	`boolean`	<optional>	is the field required
`trimMsg`	`string`	<optional>	message to display if the field is not trimmed
`reqMessage`	`string`	<optional>	message to display if the field is required

View Source helpers/formHelpers.js, line 95

Returns:

- yup schema for the field

Type: YupSchema

# static yupTrimStringMax(label, isRequired, maxLength, msg, reqMessage, minLength) → {YupSchema}

Trim a string and check max/min and remove any leading or trailing spaces

Parameters:

Name	Type	Description
`label`	`string`	label for the field
`isRequired`	`boolean`	is the field required
`maxLength`	`number`	max length of the field
`msg`	`string`	message to display if the field is not formatted correctly
`reqMessage`	`string`	message to display if the field is required
`minLength`	`number`	min length of the field

View Source helpers/formHelpers.js, line 288

Returns:

- yup schema for a string field

Type: YupSchema

# static yupTypeAhead(label, isRequiredopt, reqMessageopt) → {YupSchema}

Create a yup schema for a typeahead field

Parameters:

Name	Type	Attributes	Description
`label`	`string`		label for the field
`isRequired`	`boolean`	<optional>	is the field required
`reqMessage`	`string`	<optional>	message to display if the field is required

View Source helpers/formHelpers.js, line 83

Returns:

- yup schema for the field

Type: YupSchema

# inner addMaxLength(schema, label, maxLength) → {YupSchema}

Add a max length test to a yup schema

Parameters:

Name	Type	Description
`schema`	`YupSchema`
`label`	`string`
`maxLength`	`number`

View Source helpers/formHelpers.js, line 268

Returns:

- yup schema with a max length test

Type: YupSchema

# inner addMaxValue(schema, label, maxValue, isIntopt) → {YupSchema}

Add a test to a yup schema to check the max value of a field

Parameters:

Name	Type	Attributes	Description
`schema`	`YupSchema`		the schema to add the test to
`label`	`string`		label for the field
`maxValue`	`string` \| `number`		the max value the field can be
`isInt`	`boolean`	<optional>	should the test be for an integer or a float

View Source helpers/formHelpers.js, line 165

Returns:

Type: YupSchema

# inner addMinLength(schema, label, minLength) → {YupSchema}

Add a min length test to a yup schema

Parameters:

Name	Type	Description
`schema`	`YupSchema`
`label`	`string`
`minLength`	`number`

View Source helpers/formHelpers.js, line 251

Returns:

- yup schema with a min length test

Type: YupSchema

# inner addMinValue(schema, label, minValue, isIntopt) → {YupSchema}

Add a test to a yup schema to check the min value of a field

Parameters:

Name	Type	Attributes	Description
`schema`	`YupSchema`		the schema to add the test to
`label`	`string`		label for the field
`minValue`	`string` \| `number`		the max value the field can be
`isInt`	`boolean`	<optional>	should the test be for an integer or a float

View Source helpers/formHelpers.js, line 195

Returns:

Type: YupSchema

Members

# static constant createRowFields

# inner constant VALID_PATTERNS

Properties:

Methods

# async static attemptFormSubmit(formData, isEdit, options) → {Promise.<void>}

Parameters:

# static createFieldValidation(type, label, validationMap, field) → {YupSchema}

Parameters:

# static getSelectValue(multiple, inData) → {string}

Parameters:

# static multiToPayload(selectionsopt) → {Array.<{id: number}>}

Parameters:

# static useFormSubmit() → {FormSubmitOptions}

Example

# static validCurrencyFormat(value) → {boolean}

Parameters:

# static validDateFormat(value) → {boolean}

Parameters:

# static validDoubleFormat(value, i, f) → {boolean}

Parameters:

# static yupCurrency(label, isRequiredopt, maxLengthopt, msgopt, reqMessageopt, minLengthopt) → {YupSchema}

Parameters:

# static yupDate(label, isRequiredopt, msgopt, reqMessageopt) → {YupSchema}

Parameters:

# static yupFloat(label, isRequiredopt, intopt, fracopt, maxLengthopt, msgopt, maxValueopt, reqMessageopt, minLengthopt, minValueopt) → {YupSchema}

Parameters:

# static yupInt(label, isRequiredopt, maxLengthopt, msgopt, reqMessageopt, minLengthopt) → {YupSchema}

Parameters:

# static yupMultiselect(label, isRequired, reqMessage) → {YupSchema}

Parameters:

# static yupObject(label, isRequired, reqMessage) → {YupSchema}

Parameters:

# static yupString(label, isRequiredopt, reqMessageopt) → {YupSchema}

Parameters:

# static yupTrimString(label, isRequiredopt, trimMsgopt, reqMessageopt) → {YupSchema}

Parameters:

# static yupTrimStringMax(label, isRequired, maxLength, msg, reqMessage, minLength) → {YupSchema}

Parameters:

# static yupTypeAhead(label, isRequiredopt, reqMessageopt) → {YupSchema}

Parameters:

# inner addMaxLength(schema, label, maxLength) → {YupSchema}

Parameters:

# inner addMaxValue(schema, label, maxValue, isIntopt) → {YupSchema}

Parameters:

# inner addMinLength(schema, label, minLength) → {YupSchema}

Parameters:

# inner addMinValue(schema, label, minValue, isIntopt) → {YupSchema}

Parameters: