Skip to content

Commit 16ed6f3

Browse files
feat(NOJIRA-123): update form.settings type to have all options (#119)
* feat(type): update form.settings type to have all options I got the list of defaults by creating a new form using the API and inspecting the response as some of the options were not listed on the docs / had different names vs what was specified on the docs. I also reordered the options to match the API response order. Added: - are_uploads_public - autosave_progress (docs have this as `autocomplete_progress`) - free_form_navigation - hide_navigation - pro_subdomain_enabled - show_cookie_consent - show_key_hint_on_choices - show_number_of_submissions - show_question_number - show_time_to_complete - use_lead_qualification Reordered: - language - is_public - progress_bar - show_progress_bar - show_typeform_branding * fix: update defaults to match conventions
1 parent 2a92dc5 commit 16ed6f3

File tree

1 file changed

+87
-17
lines changed

1 file changed

+87
-17
lines changed

src/typeform-types.ts

+87-17
Original file line numberDiff line numberDiff line change
@@ -1067,37 +1067,46 @@ export namespace Typeform {
10671067
*/
10681068
export interface Settings {
10691069
/**
1070-
* Language of form.
1070+
* Default `""`
10711071
*/
1072-
language?: Language
1072+
are_uploads_public?: boolean
1073+
10731074
/**
1074-
* Default: `""`
1075-
* true if your form is public. Otherwise, false (your form is private).
1075+
* Default `""`
1076+
* true to enable saving partial form responses on the client side. Otherwise, false.
10761077
*/
1077-
is_public?: boolean
1078+
autosave_progress?: boolean
1079+
10781080
/**
1079-
* Default: `"proportion"`
1080-
* Basis for the progress bar displayed on the screen. Choose "proportion" to show the number of questions answered so far.
1081-
* Choose "percentage" to show the percentage of questions answered so far.
1081+
* Default `""`
1082+
* Allow people to navigate freely between the questions of your Typeform. They will still have to answer the required ones before submitting.
10821083
*/
1083-
progress_bar?: 'percentage' | 'proportion'
1084+
free_form_navigation?: boolean
1085+
10841086
/**
1085-
* Default: `""`
1086-
* true to display progress bar on the typeform. Otherwise, false.
1087+
* Default `""`
1088+
* false to display the navigation arrows in the bottom-right corner of the form, true to hide them
10871089
*/
1088-
show_progress_bar?: boolean
1090+
hide_navigation?: boolean
1091+
10891092
/**
1090-
* Default: `""`
1091-
* true to display Typeform brand on the typeform. false to hide Typeform branding on the typeform.
1092-
* Hiding Typeform branding is available for PRO+ accounts.
1093+
* Default `""`
1094+
* true if your form is public. Otherwise, false (your form is private).
10931095
*/
1094-
show_typeform_branding?: boolean
1096+
is_public?: boolean
1097+
1098+
/**
1099+
* Language of form.
1100+
*/
1101+
language?: Language
1102+
10951103
meta?: {
10961104
/**
1097-
* Default: `""`
1105+
* Default `""`
10981106
* true to allow search engines to index your typeform. Otherwise, false.
10991107
*/
11001108
allow_indexing?: boolean
1109+
11011110
/**
11021111
* Description for search engines to display for your typeform.
11031112
*/
@@ -1109,6 +1118,67 @@ export namespace Typeform {
11091118
href?: string
11101119
}
11111120
}
1121+
1122+
/**
1123+
* Default `""`
1124+
*/
1125+
pro_subdomain_enabled?: boolean
1126+
1127+
/**
1128+
* Default `""`
1129+
* Basis for the progress bar displayed on the screen. Choose "proportion" to show the number of questions answered so far.
1130+
* Choose "percentage" to show the percentage of questions answered so far.
1131+
*/
1132+
progress_bar?: 'percentage' | 'proportion'
1133+
1134+
/**
1135+
* Default `""`
1136+
* true to request cookie consent to respondents through a banner, false to do not request it.
1137+
*/
1138+
show_cookie_consent?: boolean
1139+
1140+
/**
1141+
* Default `""`
1142+
* true to display the key hint letters on Multiple Choice, Picture Choice, Legal and Yes/No blocks, false to hide them.
1143+
*/
1144+
show_key_hint_on_choices?: boolean
1145+
1146+
/**
1147+
* Default `""`
1148+
* true to display number of submissions on Welcome screens, false to hide it. Mutually exclusive with show_time_to_complete
1149+
*/
1150+
show_number_of_submissions?: boolean
1151+
1152+
/**
1153+
* Default `""`
1154+
* true to display progress bar on the typeform. Otherwise, false.
1155+
*/
1156+
show_progress_bar?: boolean
1157+
1158+
/**
1159+
* Default `""`
1160+
* true to display the question number on each block, false to hide it.
1161+
*/
1162+
show_question_number?: boolean
1163+
1164+
/**
1165+
* Default `""`
1166+
* true to display estimated time to complete a typeform on Welcome screens, false to hide it. Mutually exclusive with show_number_of_submissions
1167+
*/
1168+
show_time_to_complete?: boolean
1169+
1170+
/**
1171+
* Default `""`
1172+
* true to display Typeform brand on the typeform. false to hide Typeform branding on the typeform.
1173+
* Hiding Typeform branding is available for PRO+ accounts.
1174+
*/
1175+
show_typeform_branding?: boolean
1176+
1177+
/**
1178+
* Default `""`
1179+
*/
1180+
use_lead_qualification?: boolean
1181+
11121182
/**
11131183
* URL where the typeform should redirect upon submission.
11141184
*/

0 commit comments

Comments
 (0)