Merge pull request #59 from oneblink/ON-34235

ON-34235 # added `formElementsService.fixElementName()`
oneblink · Aug 23, 2023 · a6d6829 · a6d6829
2 parents 84e93d1 + 0afcde6
commit a6d6829
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- `formElementsService.fixElementName()`
+
 ## [4.0.0] - 2023-07-26
 
 ### Added

diff --git a/src/formElementsService.ts b/src/formElementsService.ts
@@ -299,6 +299,21 @@ function determineIsInfoPage(form: FormTypes.Form): boolean {
   return !foundInputElement
 }
 
+/**
+ * Remove invalid characters from a form element name.
+ *
+ * @param elementName
+ * @returns
+ */
+const fixElementName = (elementName: string) => {
+  // removes characters that aren't letters, numbers, underscores or dashes
+  // replaces empty spaces with _
+  return elementName
+    .replace(/[^-\w\s]/g, '')
+    .replace(/\s/g, '_')
+    .trim()
+}
+
 export {
   forEachFormElement,
   forEachFormElementWithOptions,
@@ -308,4 +323,5 @@ export {
   ElementWYSIWYGRegex,
   matchElementsTagRegex,
   determineIsInfoPage,
+  fixElementName
 }