document transform method

oxidecomputer · Nov 30, 2023 · 41d47a9 · 41d47a9
1 parent d1d7c39
commit 41d47a9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/app/components/form/fields/TextField.tsx b/app/components/form/fields/TextField.tsx
@@ -57,6 +57,10 @@ export interface TextFieldProps<
   units?: string
   validate?: Validate<FieldPathValue<TFieldValues, TName>, TFieldValues>
   control: Control<TFieldValues>
+  /**
+   * This function can be provided to alter the value of the input
+   * as the input is changed
+   */
   transform?: (value: Type) => Type | undefined
 }