add note about tooltips (#3164)

* add note about tooltips * adding tooltip as a valid word
FusionAuth · Aug 6, 2024 · 449ff48 · 449ff48
1 parent d844cf5
commit 449ff48
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/astro/src/content/docs/_shared/_admin-user-form.mdx b/astro/src/content/docs/_shared/_admin-user-form.mdx
@@ -16,6 +16,12 @@ user.data.favoriteColor=Favorite Color
 
 This field is not localizable, so you'll only need to modify the default messages file. [Learn more about modifying the messages file in your theme](/docs/customize/look-and-feel/localization#messages).
 
+You can also add a tooltip by adding a related key to the messages file:
+
+```
+{tooltip}user.data.favoriteColor=A user's favorite color. This is used to generate a custom logo with the correct color scheme.
+```
+
 Configure the FusionAuth admin UI to use these forms by navigating to <Breadcrumb>Tenants -> Your Tenant -> General</Breadcrumb> and then to the <Breadcrumb>Form settings</Breadcrumb> section. Set the <InlineField>Admin user form</InlineField> field to your new form.
 
 Learn more in the [Tenant documentation](/docs/get-started/core-concepts/tenants#general).
diff --git a/astro/src/content/docs/_shared/_admin-user-registration-form.mdx b/astro/src/content/docs/_shared/_admin-user-registration-form.mdx
@@ -14,6 +14,13 @@ You should modify your theme to add labels for these custom fields for proper di
 registration.data.backgroundColor=Desired Background Color
 ```
 
+You can also add a tooltip by adding a related key to the messages file:
+
+```
+{tooltip}registration.data.backgroundColor=The desired background color. This will be used in the application and should be a hex code.
+```
+
+
 This field is not localizable, so you'll only need to modify the default messages file. [Learn more about modifying the messages file in your theme](/docs/customize/look-and-feel/localization#messages).
 
 Then, configure the FusionAuth admin UI to use these forms by navigating to <Breadcrumb>Applications -> Your Application -> Registration</Breadcrumb> and then to the <Breadcrumb>Form settings</Breadcrumb> section. Set the <InlineField>Admin Registration</InlineField> field to your new form.

diff --git a/config/vale/styles/config/vocabularies/FusionAuth/accept.txt b/config/vale/styles/config/vocabularies/FusionAuth/accept.txt
@@ -114,6 +114,7 @@ Stytch
 Supabase
 Tangany
 themeable
+tooltip
 Twilio
 URI
 virtualized
-Original file line number
+Diff line change
@@ Expand Up / @@ -114,6 +114,7 @@ Stytch @@
     Supabase
     Tangany
     themeable
+    tooltip
     Twilio
     URI
     virtualized
@@ Expand Down @@