Get Required Status | Webflow Developer Documentation

`formInput.getRequired()`

Retrieves the required status of a form input.

This method is applicable to the following form input types:

FormCheckboxInput
FormFileUploadWrapper
FormRadioInput
FormSelect
FormTextarea
FormTextInput

Syntax

1 formInput.getRequired(): Promise<boolean>

Returns

Promise<boolean>: Boolean - A promise that resolves to the required status of the form input.

Example

1 const selectedElement = await webflow.getSelectedElement()
2 
3 const formInputTypes = [
4   'FormCheckboxInput',
5   'FormFileUploadWrapper',
6   'FormRadioInput',
7   'FormSelect',
8   'FormTextarea',
9   'FormTextInput'
10 ];
11 
12 if (selectedElement?.type && formInputTypes.includes(selectedElement.type)) {
13 
14   const required = await selectedElement.getRequired()
15   console.log(required)
16 
17 } else {
18   console.log("Selected Element is not a Form Input Element")
19 }

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canAccessCanvas	Any	Any	Any	Any

1	const selectedElement = await webflow.getSelectedElement()
2
3	const formInputTypes = [
4	'FormCheckboxInput',
5	'FormFileUploadWrapper',
6	'FormRadioInput',
7	'FormSelect',
8	'FormTextarea',
9	'FormTextInput'
10	];
11
12	if (selectedElement?.type && formInputTypes.includes(selectedElement.type)) {
13
14	const required = await selectedElement.getRequired()
15	console.log(required)
16
17	} else {
18	console.log("Selected Element is not a Form Input Element")
19	}